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.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
Direct Subclasses
- Cake\View\Helper\BreadcrumbsHelper
- Cake\View\Helper\FlashHelper
- Cake\View\Helper\UrlHelper
- Cake\View\Helper\FormHelper
- Cake\View\Helper\HtmlHelper
- Cake\View\Helper\NumberHelper
- Cake\View\Helper\PaginatorHelper
- Cake\View\Helper\RssHelper
- Cake\View\Helper\SessionHelper
- Cake\View\Helper\TextHelper
- Cake\View\Helper\TimeHelper
Properties summary
-
$_ViewprotectedThe View instance this helper is attached to -
$_defaultConfigprotectedarrayDefault config for this helper. -
$_helperMapprotectedarrayA helper lookup table used to lazy load helper objects. -
$fieldsetpublicarrayUnused. -
$helpersprotectedarrayList of helpers used by this helper -
$tagspublicarrayUnused.
Inherited Properties
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() -
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs. -
addClass() public
Adds the given class to the element options -
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.
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
__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
__get() public ¶
__get( string $name )
Lazy loads helpers.
Parameters
- string $name
- Name of the property being accessed.
Returns
__set() public ¶
__set( string $name , mixed $value )
Magic setter for removed properties.
Parameters
- string $name
- Property name.
- mixed $value
- Value to set.
_cleanConfirmMessage() protected ¶
_cleanConfirmMessage( string $message )
Returns a string read to be used in confirm()
Parameters
- string $message
- The message to clean
Returns
_confirm() protected ¶
_confirm( string $message , string $okCode , string $cancelCode = '' , array $options = [] )
Returns 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
onclick JS code
addClass() public ¶
addClass( array $options = [] , string|null $class = null , string $key = 'class' )
Adds the given class to the element options
Parameters
- array $options optional []
- Array options/attributes to add a class to
- string|null $class optional null
- The class name being added.
- string $key optional 'class'
- the key to use for class. Defaults to
'class'.
Returns
Array of options with $key set.
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
Implementation of
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.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public deprecated ¶
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Gets/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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value = null )
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 null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key = null , mixed $default = null )
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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Configuration data at the named key or null if the key does not exist.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this