Class Helper
Abstract base class for all other Helpers in CakePHP. Provides common methods and features.
Callback methods
Helpers support a number of callback methods. These callbacks allow you to hook into the various view lifecycle events and either modify existing view content or perform other application specific logic. The events are not implemented by this base class, as implementing a callback method subscribes a helper to the related event. The callback methods are as follows:
beforeRender(Event $event, $viewFile)- beforeRender is called before the view file is rendered.afterRender(Event $event, $viewFile)- afterRender is called after the view file is rendered but before the layout has been rendered.- beforeLayout(Event $event, $layoutFile)` - beforeLayout is called before the layout is rendered.
afterLayout(Event $event, $layoutFile)- afterLayout is called after the layout has rendered.beforeRenderFile(Event $event, $viewFile)- Called before any view fragment is rendered.afterRenderFile(Event $event, $viewFile, $content)- Called after any view fragment is rendered. If a listener returns a non-null value, the output of the rendered file will be set to that.
Property Summary
-
$_View protected
Cake\View\ViewThe View instance this helper is attached to
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this helper.
-
$_helperMap protected
arrayA helper lookup table used to lazy load helper objects.
-
$fieldset public deprecated
arrayUnused.
-
$helpers protected
arrayList of helpers used by this helper
-
$tags public deprecated
arrayUnused.
Method Summary
-
__call() public
Provide non fatal errors on missing method calls.
-
__construct() public
Default Constructor
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__get() public
Lazy loads helpers.
-
__set() public
Magic setter for removed properties.
-
_cleanConfirmMessage() protected
Returns a string read to be used in confirm()
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs.
-
addClass() public
Adds the given class to the element options
-
config() public deprecated
Gets/Sets the config.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getView() public
Get the view instance this helper is bound to.
-
implementedEvents() public
Get the View callbacks this helper is interested in.
-
initialize() public
Constructor hook method.
-
setConfig() public
Sets the config.
Method Detail
__call() ¶ public
__call(string $method, array $params): mixed|voidProvide non fatal errors on missing method calls.
Parameters
-
string$method Method to invoke
-
array$params Array of params for the method.
Returns
mixed|void__construct() ¶ public
__construct(Cake\View\View $View, array $config = [])Default Constructor
Parameters
-
Cake\View\View$View The View this helper is being attached to.
-
array$config optional Configuration settings for the helper.
__debugInfo() ¶ public
__debugInfo(): arrayReturns an array that can be used to describe the internal state of this object.
Returns
array__get() ¶ public
__get(string $name): Cake\View\Helper|nullLazy loads helpers.
Parameters
-
string$name Name of the property being accessed.
Returns
Cake\View\Helper|null__set() ¶ public
__set(string $name, mixed $value): voidMagic setter for removed properties.
Parameters
-
string$name Property name.
-
mixed$value Value to set.
Returns
void_cleanConfirmMessage() ¶ protected
_cleanConfirmMessage(string $message): mixedReturns a string read to be used in confirm()
Parameters
-
string$message The message to clean
Returns
mixed_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites a config key.
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_confirm() ¶ protected
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): stringReturns a string to be used as onclick handler for confirm dialogs.
Parameters
-
string$message Message to be displayed
-
string$okCode Code to be executed after user chose 'OK'
-
string$cancelCode optional Code to be executed after user chose 'Cancel'
-
array$options optional Array of options
Returns
stringaddClass() ¶ public
addClass(array $options = [], string|null $class = null, string $key = 'class'): arrayAdds the given class to the element options
Parameters
-
array$options optional Array options/attributes to add a class to
-
string|null$class optional The class name being added.
-
string$key optional the key to use for class. Defaults to
'class'.
Returns
arrayconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/Sets the config.
Usage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/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
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed|null $default = null): mixed|nullReturns 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|null$default optional The return value when the key does not exist.
Returns
mixed|nullgetConfigOrFail() ¶ public
getConfigOrFail(string|null $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string|null$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptiongetView() ¶ public
getView(): Cake\View\ViewGet the view instance this helper is bound to.
Returns
Cake\View\ViewimplementedEvents() ¶ public
implementedEvents(): arrayGet the View callbacks this helper is interested in.
By defining one of the callback methods a helper is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.
Returns
arrayinitialize() ¶ public
initialize(array $config): voidConstructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
-
array$config The configuration settings provided to this helper.
Returns
voidsetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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
-
string|array$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
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool