$options An array of HTML attributes and options.
* @return string The highlighted text
* @see \Cake\Utility\Text::highlight()
* @link https://book.cakephp.org/4/en/views/helpers/text.html#highlighting-substrings
*/
public function highlight(string $text, string $phrase, array $options = []): string
{
return $this->_engine->highlight($text, $phrase, $options);
}
/**
* Formats paragraphs around given text for all line breaks
*
added for single line return
* added for double line return
*
* @param string|null $text Text
* @return string The text with proper
and
tags
* @link https://book.cakephp.org/4/en/views/helpers/text.html#converting-text-into-paragraphs
*/
public function autoParagraph(?string $text): string
{
$text = $text ?? '';
if (trim($text) !== '') {
$text = preg_replace('|]*>\s*]*>|i', "\n\n", $text . "\n");
$text = preg_replace("/\n\n+/", "\n\n", str_replace(["\r\n", "\r"], "\n", $text));
$texts = preg_split('/\n\s*\n/', $text, -1, PREG_SPLIT_NO_EMPTY);
$text = '';
foreach ($texts as $txt) {
$text .= '' . nl2br(trim($txt, "\n")) . "
\n";
}
$text = preg_replace('|\s*
|', '', $text);
}
return $text;
}
/**
* 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.
*
* ### Options:
*
* - `ellipsis` Will be used as Ending and appended to the trimmed string
* - `exact` If false, $text will not be cut mid-word
* - `html` If true, HTML tags would be handled correctly
*
* @param string $text String to truncate.
* @param int $length Length of returned string, including ellipsis.
* @param array $options An array of HTML attributes and options.
* @return string Trimmed string.
* @see \Cake\Utility\Text::truncate()
* @link https://book.cakephp.org/4/en/views/helpers/text.html#truncating-text
*/
public function truncate(string $text, int $length = 100, array $options = []): string
{
return $this->_engine->truncate($text, $length, $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.
*
* ### Options:
*
* - `ellipsis` Will be used as Beginning and prepended to the trimmed string
* - `exact` If false, $text will not be cut mid-word
*
* @param string $text String to truncate.
* @param int $length Length of returned string, including ellipsis.
* @param array $options An array of HTML attributes and options.
* @return string Trimmed string.
* @see \Cake\Utility\Text::tail()
* @link https://book.cakephp.org/4/en/views/helpers/text.html#truncating-the-tail-of-a-string
*/
public function tail(string $text, int $length = 100, array $options = []): string
{
return $this->_engine->tail($text, $length, $options);
}
/**
* Extracts an excerpt from the text surrounding the phrase with a number of characters on each side
* determined by radius.
*
* @param string $text String to search the phrase in
* @param string $phrase Phrase that will be searched for
* @param int $radius The amount of characters that will be returned on each side of the founded phrase
* @param string $ending Ending that will be appended
* @return string Modified string
* @see \Cake\Utility\Text::excerpt()
* @link https://book.cakephp.org/4/en/views/helpers/text.html#extracting-an-excerpt
*/
public function excerpt(string $text, string $phrase, int $radius = 100, string $ending = '...'): string
{
return $this->_engine->excerpt($text, $phrase, $radius, $ending);
}
/**
* Creates a comma separated list where the last two items are joined with 'and', forming natural language.
*
* @param array $list The list to be joined.
* @param string|null $and The word used to join the last and second last items together with. Defaults to 'and'.
* @param string $separator The separator used to join all the other items together. Defaults to ', '.
* @return string The glued together string.
* @see \Cake\Utility\Text::toList()
* @link https://book.cakephp.org/4/en/views/helpers/text.html#converting-an-array-to-sentence-form
*/
public function toList(array $list, ?string $and = null, string $separator = ', '): string
{
return $this->_engine->toList($list, $and, $separator);
}
/**
* Returns a string with all spaces converted to dashes (by default),
* characters transliterated to ASCII characters, and non word characters removed.
*
* ### Options:
*
* - `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.
*
* @param string $string the string you want to slug
* @param array|string $options If string it will be used as replacement character
* or an array of options.
* @return string
* @see \Cake\Utility\Text::setTransliterator()
* @see \Cake\Utility\Text::setTransliteratorId()
*/
public function slug(string $string, $options = []): string
{
return $this->_engine->slug($string, $options);
}
/**
* Event listeners.
*
* @return array
*/
public function implementedEvents(): array
{
return [];
}
}