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<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this class
Cake\Utility\Text
Cake Utility Text instance
array<string, array>
A helper lookup table used to lazy load helper objects.
array<string, array>
An array of hashes and their contents. Used when inserting links into text.
array
helpers
Call methods from String utility class
Constructor
Returns an array that can be used to describe the internal state of this object.
Lazy loads helpers.
Deletes a single config key.
Reads a config key.
Writes a config key.
Returns a string to be used as onclick handler for confirm dialogs.
Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.
Links email addresses
Replace placeholders with links.
Adds the given class to the element options
Convert all links and email addresses to HTML links.
Adds email links (<a href="mailto:....") to a given text.
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.
Returns the config.
Returns the config for this specific key.
Get the view instance this helper is bound to.
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.
Event listeners.
Constructor hook method.
Sets the config.
Returns a string with all spaces converted to dashes (by default), characters transliterated to ASCII characters, and non word characters removed.
Truncates text starting from the end.
Creates a comma separated list where the last two items are joined with 'and', forming natural language.
Truncates text.
__call(string $method, array $params): mixed
Call methods from String utility class
string
$method Method to invoke
array
$params Array of params for the method.
mixed
__construct(Cake\View\View $view, array<string, mixed> $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<string, mixed>
$config optional Settings array Settings array
Cake\Core\Exception\CakeException
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
array<string, mixed>
__get(string $name): Cake\View\Helper|null|void
Lazy loads helpers.
string
$name Name of the property being accessed.
Cake\View\Helper|null|void
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
_confirm(string $okCode, string $cancelCode): string
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
_insertPlaceHolder(array $matches): string
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
_linkEmails(string $text, array<string, mixed> $options): string
Links email addresses
string
$text The text to operate on
array<string, mixed>
$options An array of options to use for the HTML.
string
_linkUrls(string $text, array<string, mixed> $htmlOptions): string
Replace placeholders with links.
string
$text The text to operate on.
array<string, mixed>
$htmlOptions The options for the generated links.
string
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>
Adds the given class to the element options
array<string, mixed>
$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<string, mixed>
autoLink(string $text, array<string, mixed> $options = []): string
Convert all links and email addresses to HTML links.
escape
Control HTML escaping of input. Defaults to true.string
$text Text
array<string, mixed>
$options optional Array of HTML options, and options listed above.
string
autoLinkEmails(string $text, array<string, mixed> $options = []): string
Adds email links (<a href="mailto:....") to a given text.
escape
Control HTML escaping of input. Defaults to true.string
$text Text
array<string, mixed>
$options optional Array of HTML options, and options listed above.
string
autoLinkUrls(string $text, array<string, mixed> $options = []): 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<string, mixed>
$options optional Array of HTML options, and options listed above.
string
autoParagraph(string|null $text): string
Formats paragraphs around given text for all line breaks
added for single line return
added for double line return
string|null
$text Text
string
configShallow(array<string, mixed>|string $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']);
array<string, mixed>|string
$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 = 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
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
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 optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
getConfigOrFail(string $key): mixed
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
InvalidArgumentException
getView(): Cake\View\View
Get the view instance this helper is bound to.
Cake\View\View
highlight(string $text, string $phrase, array<string, mixed> $options = []): 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<string, mixed>
$options optional An array of HTML attributes and options.
string
implementedEvents(): array<string, mixed>
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.
array<string, mixed>
initialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed>
$config The configuration settings provided to this helper.
void
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $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']);
array<string, mixed>|string
$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\CakeException
slug(string $string, array<string, mixed>|string $options = []): string
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, mixed>|string
$options optional If string it will be used as replacement character or an array of options.
string
tail(string $text, int $length = 100, array<string, mixed> $options = []): 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-wordstring
$text String to truncate.
int
$length optional Length of returned string, including ellipsis.
array<string, mixed>
$options optional An array of HTML attributes and options.
string
toList(array<string> $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<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
truncate(string $text, int $length = 100, array<string, mixed> $options = []): 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 correctlystring
$text String to truncate.
int
$length optional Length of returned string, including ellipsis.
array<string, mixed>
$options optional An array of HTML attributes and options.
string
Cake\View\Helper\HtmlHelper
The View instance this helper is attached to
Cake\View\View
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this class
array<string, mixed>
Cake Utility Text instance
Cake\Utility\Text
A helper lookup table used to lazy load helper objects.
array<string, array>
An array of hashes and their contents. Used when inserting links into text.
array<string, 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.4/class-Cake.View.Helper.TextHelper.html