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(EventInterface $event, $viewFile)
- beforeRender is called before the view file is rendered. -
afterRender(EventInterface $event, $viewFile)
- afterRender is called after the view file is rendered but before the layout has been rendered. - beforeLayout(EventInterface $event, $layoutFile)` - beforeLayout is called before the layout is rendered.
-
afterLayout(EventInterface $event, $layoutFile)
- afterLayout is called after the layout has rendered. -
beforeRenderFile(EventInterface $event, $viewFile)
- Called before any view fragment is rendered. -
afterRenderFile(EventInterface $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.
Properties summary
- $_View protected
\Cake\View\View
The View instance this helper is attached to
- $_config protected
array
Runtime config
- $_configInitialized protected
bool
Whether the config property has already been configured with defaults
- $_defaultConfig protected
array
Default config for this helper.
- $_helperMap protected
array
A helper lookup table used to lazy load helper objects.
- $helpers protected
array
List of helpers used by this helper
Method Summary
- __debugInfo() public
Returns an array that can be used to describe the internal state of this object.
- configShallow() public
Merge provided config with existing config. Unlike
config()
which does a recursive merge for nested keys, this method does a simple merge.
Method Detail
__call() public
__call(string $method, array $params)
Provide 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()
Returns an array that can be used to describe the internal state of this object.
Returns
array
__get() public
__get(string $name)
Lazy loads helpers.
Parameters
-
string
$name Name of the property being accessed.
Returns
\Cake\View\Helper|null|void
Helper instance if helper with provided name exists
_configDelete() protected
_configDelete(string $key)
Deletes a single config key.
Parameters
-
string
$key Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead() protected
_configRead(?string $key)
Reads a config key.
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() protected
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes 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.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_confirm() protected
_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
Parameters
-
string
$okCode Code to be executed after user chose 'OK'
-
string
$cancelCode Code to be executed after user chose 'Cancel'
Returns
string
"onclick" JS code
addClass() public
addClass(array $options, string $class, string $key)
Adds the given class to the element options
Parameters
-
array
$options Array options/attributes to add a class to
-
string
$class The class name being added.
-
string
$key optional the key to use for class. Defaults to
'class'
.
Returns
array
Array of options with $key set.
configShallow() public
configShallow(mixed $key, mixed $value)
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
-
string|array
$key The key to set, or a complete array of configs.
-
mixed|null
$value optional The value to set.
Returns
$this
getConfig() public
getConfig(?string $key, mixed $default)
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
Configuration data at the named key or null if the key does not exist.
getConfigOrFail() public
getConfigOrFail(string $key)
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
Configuration data at the named key
Throws
InvalidArgumentException
getView() public
getView()
Get the view instance this helper is bound to.
Returns
\Cake\View\View
The bound view instance.
implementedEvents() public
implementedEvents()
Get 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
array
initialize() public
initialize(array $config)
Constructor 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.
setConfig() public
setConfig(mixed $key, mixed $value, mixed $merge)
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
-
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
$this
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
Property Detail
$_View protected
The View instance this helper is attached to
Type
\Cake\View\View
$_config protected
Runtime config
Type
array
$_configInitialized protected
Whether the config property has already been configured with defaults
Type
bool
$_defaultConfig protected
Default config for this helper.
Type
array
$_helperMap protected
A helper lookup table used to lazy load helper objects.
Type
array
$helpers protected
List of helpers used by this helper
Type
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.0/class-Cake.View.Helper.html