Text helper library.
Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...
\Cake\View\Helper\HtmlHelper
\Cake\View\View
The View instance this helper is attached to
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this class
\Cake\Utility\Text
Cake Utility Text instance
array
A helper lookup table used to lazy load helper objects.
array
An array of hashes and their contents.
array
helpers
Returns an array that can be used to describe the internal state of this object.
Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.
Adds links (<a href=....) to a given text, by finding text that begins with strings like http:// and ftp://.
Formats paragraphs around given text for all line breaks
added for single line return
added for double line return
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
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.
Returns a string with all spaces converted to dashes (by default), characters transliterated to ASCII characters, and non word characters removed.
Creates a comma separated list where the last two items are joined with 'and', forming natural language.
__call(string $method, array $params)
Call methods from String utility class
string
$method Method to invoke
array
$params Array of params for the method.
mixed
Whatever is returned by called method, or false on failure
__construct(\Cake\View\View $view, array $config)
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 optional Settings array Settings array
Cake\Core\Exception\Exception
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Lazy loads helpers.
string
$name Name of the property being accessed.
\Cake\View\Helper|null|void
Helper instance if helper with provided name exists
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception
_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string
$okCode Code to be executed after user chose 'OK'
string
$cancelCode Code to be executed after user chose 'Cancel'
string
"onclick" JS code
_insertPlaceHolder(array $matches)
Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.
array
$matches An array of regexp matches.
string
Replaced values.
_linkEmails(string $text, array $options)
Links email addresses
string
$text The text to operate on
array
$options An array of options to use for the HTML.
string
_linkUrls(string $text, array $htmlOptions)
Replace placeholders with links.
string
$text The text to operate on.
array
$htmlOptions The options for the generated links.
string
The text with links inserted.
addClass(array $options, string $class, string $key)
Adds the given class to the element options
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'
.
array
Array of options with $key set.
autoLink(string $text, array $options)
Convert all links and email addresses to HTML links.
escape
Control HTML escaping of input. Defaults to true.string
$text Text
array
$options optional Array of HTML options, and options listed above.
string
The text with links
autoLinkEmails(string $text, array $options)
Adds email links (<a href="mailto:....) to a given text.
escape
Control HTML escaping of input. Defaults to true.string
$text Text
array
$options optional Array of HTML options, and options listed above.
string
The text with links
autoLinkUrls(string $text, array $options)
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 optional Array of HTML options, and options listed above.
string
The text with links
autoParagraph(?string $text)
Formats paragraphs around given text for all line breaks
added for single line return
added for double line return
string|null
$text Text
string
The text with proper
and
tags
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
excerpt(string $text, string $phrase, int $radius, string $ending)
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
int
$radius optional The amount of characters that will be returned on each side of the founded phrase
string
$ending optional Ending that will be appended
string
Modified string
getConfig(?string $key, mixed $default)
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 optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getView()
Get the view instance this helper is bound to.
\Cake\View\View
The bound view instance.
highlight(string $text, string $phrase, array $options)
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 optional An array of HTML attributes and options.
string
The highlighted text
implementedEvents()
Event listeners.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this helper.
setConfig(mixed $key, mixed $value, mixed $merge)
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 optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
slug(string $string, mixed $options)
Returns a string with all spaces converted to dashes (by default), characters transliterated to ASCII characters, and non word characters removed.
replacement
: Replacement string. Default '-'.transliteratorId
: A valid transliterator id string. If null
(default) the transliterator (identifier) set via Text::setTransliteratorId()
or Text::setTransliterator()
will be used. If false
no transliteration will be done, only non words will be removed.preserve
: Specific non-word character to preserve. Default null
. For e.g. this option can be set to '.' to generate clean file names.string
$string the string you want to slug
array|string
$options optional If string it will be use as replacement character or an array of options.
string
tail(string $text, int $length, array $options)
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-wordstring
$text String to truncate.
int
$length optional Length of returned string, including ellipsis.
array
$options optional An array of HTML attributes and options.
string
Trimmed string.
toList(array $list, ?string $and, string $separator)
Creates a comma separated list where the last two items are joined with 'and', forming natural language.
string[]
$list The list to be joined.
string|null
$and optional The word used to join the last and second last items together with. Defaults to 'and'.
string
$separator optional The separator used to join all the other items together. Defaults to ', '.
string
The glued together string.
truncate(string $text, int $length, array $options)
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 correctlystring
$text String to truncate.
int
$length optional Length of returned string, including ellipsis.
array
$options optional An array of HTML attributes and options.
string
Trimmed string.
\Cake\View\Helper\HtmlHelper
The View instance this helper is attached to
\Cake\View\View
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this class
array
Cake Utility Text instance
\Cake\Utility\Text
A helper lookup table used to lazy load helper objects.
array
An array of hashes and their contents.
Used when inserting links into text.
array
helpers
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.1/class-Cake.View.Helper.TextHelper.html