Class TextHelper
Text helper library.
Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...
See: \Cake\Utility\Text
Link: https://book.cakephp.org/5/en/views/helpers/text.html
Property Summary
-
$Html public @property
Cake\View\Helper\HtmlHelper -
$_View protected
Cake\View\ViewThe View instance this helper is attached to
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default config for this helper.
-
$_placeholders protected
array<string, array>An array of hashes and their contents. Used when inserting links into text.
-
$helperInstances protected
array<string,Cake\View\Helper>Loaded helper instances.
-
$helpers protected
arrayhelpers
Method Summary
-
__call() public
Call methods from String utility class
-
__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.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs.
-
_insertPlaceHolder() protected
Saves the placeholder for a string, for later use. This gets around double escaping content in URL's.
-
_linkEmails() protected
Links email addresses
-
_linkUrls() protected
Replace placeholders with links.
-
addClass() public
Adds the given class to the element options
-
autoLink() public
Convert all links and email addresses to HTML links.
-
autoLinkEmails() public
Adds email links (<a href="mailto:....") to a given text.
-
autoLinkUrls() public
Adds links (<a href=....) to a given text, by finding text that begins with strings like http:// and ftp://.
-
autoParagraph() public
Formats paragraphs around given text for all line breaks
added for single line returnadded for double line return
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
excerpt() public @method
See Text::excerpt()
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getView() public
Get the view instance this helper is bound to.
-
highlight() public @method
See Text::highlight()
-
implementedEvents() public
Event listeners.
-
initialize() public
Constructor hook method.
-
setConfig() public
Sets the config.
-
slug() public @method
See Text::slug()
-
tail() public @method
See Text::tail()
-
toList() public @method
See Text::toList()
-
truncate() public @method
See Text::truncate()
Method Detail
__call() ¶ public
__call(string $method, array $params): mixedCall methods from String utility class
Parameters
-
string$method Method to invoke
-
array$params Array of params for the method.
Returns
mixed__construct() ¶ public
__construct(Cake\View\View $view, array<string, mixed> $config = [])Default Constructor
Parameters
-
Cake\View\View$view The View this helper is being attached to.
-
array<string, mixed>$config optional Configuration settings for the helper.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Returns an array that can be used to describe the internal state of this object.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): Cake\View\Helper|nullLazy loads helpers.
Parameters
-
string$name Name of the property being accessed.
Returns
Cake\View\Helper|null_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
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.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_confirm() ¶ protected
_confirm(string $okCode, string $cancelCode): stringReturns 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_insertPlaceHolder() ¶ protected
_insertPlaceHolder(array $matches): stringSaves the placeholder for a string, for later use. This gets around double escaping content in URL's.
Parameters
-
array$matches An array of regexp matches.
Returns
string_linkEmails() ¶ protected
_linkEmails(string $text, array<string, mixed> $options): stringLinks email addresses
Parameters
-
string$text The text to operate on
-
array<string, mixed>$options An array of options to use for the HTML.
Returns
stringSee Also
_linkUrls() ¶ protected
_linkUrls(string $text, array<string, mixed> $htmlOptions): stringReplace placeholders with links.
Parameters
-
string$text The text to operate on.
-
array<string, mixed>$htmlOptions The options for the generated links.
Returns
stringaddClass() ¶ public
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>Adds the given class to the element options
Parameters
-
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'.
Returns
array<string, mixed>autoLink() ¶ public
autoLink(string $text, array<string, mixed> $options = []): stringConvert all links and email addresses to HTML links.
Options
escapeControl HTML escaping of input. Defaults to true.
Parameters
-
string$text Text
-
array<string, mixed>$options optional Array of HTML options, and options listed above.
Returns
stringLinks
autoLinkEmails() ¶ public
autoLinkEmails(string $text, array<string, mixed> $options = []): stringAdds email links (<a href="mailto:....") to a given text.
Options
escapeControl HTML escaping of input. Defaults to true.
Parameters
-
string$text Text
-
array<string, mixed>$options optional Array of HTML options, and options listed above.
Returns
stringLinks
autoLinkUrls() ¶ public
autoLinkUrls(string $text, array<string, mixed> $options = []): stringAdds links (<a href=....) to a given text, by finding text that begins with strings like http:// and ftp://.
Options
escapeControl HTML escaping of input. Defaults to true.
Parameters
-
string$text Text
-
array<string, mixed>$options optional Array of HTML options, and options listed above.
Returns
stringLinks
autoParagraph() ¶ public
autoParagraph(string|null $text): stringFormats paragraphs around given text for all line breaks
added for single line return
added for double line return
Parameters
-
string|null$text Text
Returns
stringLinks
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge 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
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisexcerpt() ¶ public @method
excerpt(string $text, string $phrase, int $radius = 100, string $ending = '...'): stringSee Text::excerpt()
Parameters
-
string$text -
string$phrase -
int$radius optional -
string$ending optional
Returns
stringgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns 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
mixedThrows
InvalidArgumentExceptiongetView() ¶ public
getView(): Cake\View\ViewGet the view instance this helper is bound to.
Returns
Cake\View\Viewhighlight() ¶ public @method
highlight(string $text, array|string $phrase, array $options = []): stringSee Text::highlight()
Parameters
-
string$text -
array|string$phrase -
array$options optional
Returns
stringimplementedEvents() ¶ public
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.
Returns
array<string, mixed>initialize() ¶ public
initialize(array<string, mixed> $config): voidConstructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
-
array<string, mixed>$config The configuration settings provided to this helper.
Returns
voidsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets 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
-
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.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
slug() ¶ public @method
slug(string $string, array|string $options = []): stringSee Text::slug()
Parameters
-
string$string -
array|string$options optional
Returns
stringtail() ¶ public @method
tail(string $text, int $length = 100, array $options = []): stringSee Text::tail()
Parameters
-
string$text -
int$length optional -
array$options optional
Returns
stringtoList() ¶ public @method
toList(array $list, ?string $and = null, string $separator = ', '): stringSee Text::toList()
Parameters
-
array$list -
?string$and optional -
string$separator optional
Returns
stringtruncate() ¶ public @method
truncate(string $text, int $length = 100, array $options = []): stringSee Text::truncate()
Parameters
-
string$text -
int$length optional -
array$options optional
Returns
string