$helpers
$helpers : array
helpers
Text helper library.
Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...
$_View : \Cake\View\View
The View instance this helper is attached to
$_engine : \Cake\Utility\Text
Cake Utility Text instance
__construct(\Cake\View\View $View, array $config = array())
Constructor
engine Class name to use to replace String functionality.
The class needs to be placed in the Utility directory.| \Cake\View\View | $View | the view object the helper is attached to. |
| array | $config | Settings array Settings array |
when the engine class could not be found.
__get(string $name) : \Cake\View\Helper|null
Lazy loads helpers.
| string | $name | Name of the property being accessed. |
Helper instance if helper with provided name exists
getView() : \Cake\View\View
Get the view instance this helper is bound to.
The bound view instance.
addClass(array $options = array(), string|null $class = null, string $key = 'class') : array
Adds the given class to the element options
| array | $options | Array options/attributes to add a class to |
| string|null | $class | The class name being added. |
| string | $key | the key to use for class. |
Array of options with $key set.
implementedEvents() : array
Event listeners.
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.
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
Sets the config.
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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
Returns the config.
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');| string|null | $key | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
autoLinkUrls(string $text, array $options = array()) : string
Adds links (<a href=.
...) to a given text, by finding text that begins with strings like http:// and ftp://.
escape Control HTML escaping of input. Defaults to true.| string | $text | Text |
| array | $options | Array of HTML options, and options listed above. |
The text with links
autoLinkEmails(string $text, array $options = array()) : string
Adds email links (<a href="mailto:.
...) to a given text.
escape Control HTML escaping of input. Defaults to true.| string | $text | Text |
| array | $options | Array of HTML options, and options listed above. |
The text with links
autoLink(string $text, array $options = array()) : string
Convert all links and email addresses to HTML links.
escape Control HTML escaping of input. Defaults to true.| string | $text | Text |
| array | $options | Array of HTML options, and options listed above. |
The text with links
highlight(string $text, string $phrase, array $options = array()) : string
Highlights a given phrase in a text. You can specify any expression in highlighter that may include the \1 expression to include the $phrase found.
| string | $text | Text to search the phrase in |
| string | $phrase | The phrase that will be searched |
| array | $options | An array of HTML attributes and options. |
The highlighted text
truncate(string $text, integer $length = 100, array $options = array()) : string
Truncates text.
Cuts a string to the length of $length and replaces the last characters with the ellipsis if the text is longer than length.
ellipsis Will be used as Ending and appended to the trimmed stringexact If false, $text will not be cut mid-wordhtml If true, HTML tags would be handled correctly| string | $text | String to truncate. |
| integer | $length | Length of returned string, including ellipsis. |
| array | $options | An array of HTML attributes and options. |
Trimmed string.
tail(string $text, integer $length = 100, array $options = array()) : string
Truncates text starting from the end.
Cuts a string to the length of $length and replaces the first characters with the ellipsis if the text is longer than length.
ellipsis Will be used as Beginning and prepended to the trimmed stringexact If false, $text will not be cut mid-word| string | $text | String to truncate. |
| integer | $length | Length of returned string, including ellipsis. |
| array | $options | An array of HTML attributes and options. |
Trimmed string.
excerpt(string $text, string $phrase, integer $radius = 100, string $ending = '...') : string
Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
| string | $text | String to search the phrase in |
| string | $phrase | Phrase that will be searched for |
| integer | $radius | The amount of characters that will be returned on each side of the founded phrase |
| string | $ending | Ending that will be appended |
Modified string
toList(array $list, string|null $and = null, string $separator = ', ') : string
Creates a comma separated list where the last two items are joined with 'and', forming natural language.
| array | $list | The list to be joined. |
| string|null | $and | The word used to join the last and second last items together with. Defaults to 'and'. |
| string | $separator | The separator used to join all the other items together. Defaults to ', '. |
The glued together string.
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = array()) : string
Returns a string to be used as onclick handler for confirm dialogs.
| string | $message | Message to be displayed |
| string | $okCode | Code to be executed after user chose 'OK' |
| string | $cancelCode | Code to be executed after user chose 'Cancel' |
| array | $options | Array of options |
onclick JS code
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config