Класс TextHelper

Библиотека для работы с текстом.

Обработка текста: выделение, извлечение фрагмента, обрезка, удаление ссылок, преобразование адресов электронной почты в ссылки mailto: ...

Пространство имён: Cake\View\Helper
См.: \Cake\Utility\Text
Ссылка: https://book.cakephp.org/4/ru/views/helpers/text.html

Краткое описание свойств

$Html public @property

Cake\View\Helper\HtmlHelper
$_View protected

Cake\View\View

Экземпляр объекта View, к которому привязан данный помощник.
$_config protected

array<string, mixed>

Конфигурация выполнения.
$_configInitialized protected

bool

Установлено ли свойство конфигурации со значениями по умолчанию?
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию для данного класса.
$_engine protected

Cake\Utility\Text

Экземпляр класса Cake Utility Text.
$_helperMap protected

array<string, array>

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
$_placeholders protected

array<string, array>

Массив хешей и их содержимого. Используется при вставке ссылок в текст.
$helpers protected

array

Помощники.

Краткое описание методов

__call() public

Вызов методов из класса утилиты String.
__construct() public

Конструктор.
__debugInfo() public

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
__get() public

Лениво загружает помощников.
_configDelete() protected

Удаляет единственный ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_confirm() protected

Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.
_insertPlaceHolder() protected

Сохраняет заполнитель для строки, для последующего использования. Это обходит двойное экранирование содержимого в URL.
_linkEmails() protected

Создаёт ссылки на адреса электронной почты.
_linkUrls() protected

Заменяет плейсхолдеры ссылками.
addClass() public

Добавляет заданный класс к параметрам элемента.
autoLink() public

Преобразует все ссылки и адреса электронной почты в HTML-ссылки.
autoLinkEmails() public

Добавляет ссылки на электронную почту (<a href="mailto:....") к заданному тексту.
autoLinkUrls() public

Добавляет ссылки (<a href=....) к заданному тексту, найдя текст, начинающийся с строк типа http:// и ftp://.
autoParagraph() public

Форматирует абзацы вокруг данного текста для всех переносов строки
добавленных для одинарной возвращаемой строки

добавленных для двойного возврата строки
configShallow() public

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
excerpt() public

Извлекает фрагмент из текста, окружающий фразу с количеством символов по обеим сторонам, определённым радиусом.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
getView() public

Получить экземпляр представления, к которому привязан данный помощник.
highlight() public

Выделяет заданную фразу в тексте. Вы можете указать любое выражение в highligter, которое может включать выражение \1 для включения найденной фразы $phrase.
implementedEvents() public

Обработчики событий.
initialize() public

Метод обратного вызова инициализации.
setConfig() public

Устанавливает конфигурацию.
slug() public

Возвращает строку со всеми пробелами, преобразованными в дефисы (по умолчанию), символами транслитерирования в ASCII-символы и удалением несловообразующих символов.
tail() public

Обрезает текст, начиная с конца.
toList() public

Создаёт список, разделённый запятыми, где последние два элемента объединяются с 'и', образуя естественный язык.
truncate() public

Обрезает текст.

END_OF_DOCUMENT_MARKER

Подробное описание методов

__call() public

__call(string $method, array $params): mixed

Вызов методов из класса утилиты String

Параметры

string $method: Метод для вызова
array $params: Массив параметров для метода.

Возвращает

mixed

__construct() public

__construct(Cake\View\View $view, array<string, mixed> $config = [])

Конструктор

Настройки:

engine Имя класса, используемого для замены функциональности String. Класс должен быть размещён в каталоге Utility.

Параметры

Cake\View\View $view: объект представления, к которому прикреплён помощник.
array<string, mixed> $config необязательно: Массив настроек

Исключение

Cake\Core\Exception\CakeException
при невозможности найти класс движка.

__debugInfo() public

__debugInfo(): array<string, mixed>

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array<string, mixed>

__get() public

__get(string $name): Cake\View\Helper|null|void

Ленично загружает помощников.

Параметры

string $name: Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null|void

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Исключение

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge необязательно: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключение

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.

Параметры

string $okCode: Код, который будет выполнен после выбора 'OK'
string $cancelCode: Код, который будет выполнен после выбора 'Отмена'

Возвращает

string

_insertPlaceHolder() protected

_insertPlaceHolder(array $matches): string

Сохраняет заполнитель для строки, для последующего использования. Это позволяет избежать двойного экранирования содержимого в URL.

Параметры

array $matches: Массив совпадений по регулярному выражению.

Возвращает

string

_linkEmails() protected

_linkEmails(string $text, array<string, mixed> $options): string

Создаёт ссылки на электронные адреса

Параметры

string $text: Текст, над которым производятся операции
array<string, mixed> $options: Массив опций для использования в HTML.

Возвращает

string

См. также

\Cake\View\Helper\TextHelper::autoLinkEmails()

_linkUrls() protected

_linkUrls(string $text, array<string, mixed> $htmlOptions): string

Заменяет плейсхолдеры ссылками.

Параметры

string $text: Текст, над которым производятся операции.
array<string, mixed> $htmlOptions: Опции для сгенерированных ссылок.

Возвращает

string

addClass() public

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

Добавляет заданный класс к опциям элемента.

Параметры

array<string, mixed> $options: Массив опций/атрибутов для добавления класса
string $class: Имя добавляемого класса.
string $key необязательно: ключ для использования класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

autoLink() public

autoLink(string $text, array<string, mixed> $options = []): string

Преобразует все ссылки и электронные адреса в HTML-ссылки.

Опции

escape Управление HTML-экранированием входных данных. По умолчанию true.

Параметры

string $text: Текст
array<string, mixed> $options необязательно: Массив HTML-опций и опций, перечисленных выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#linking-both-urls-and-email-addresses

autoLinkEmails() public

autoLinkEmails(string $text, array<string, mixed> $options = []): string

Добавляет ссылки на электронные адреса (<a href="mailto:....") к заданному тексту.

Опции

escape Управление HTML-экранированием входных данных. По умолчанию true.

Параметры

string $text: Текст
array<string, mixed> $options необязательно: Массив HTML-опций и опций, перечисленных выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#linking-email-addresses

autoLinkUrls() public

autoLinkUrls(string $text, array<string, mixed> $options = []): string

Добавляет ссылки (<a href=....) к заданному тексту, найдя текст, начинающийся со строк, таких как http:// и ftp://.

Опции

escape Управление HTML-экранированием входных данных. По умолчанию true.

Параметры

string $text: Текст
array<string, mixed> $options необязательно: Массив HTML-опций и опций, перечисленных выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#linking-urls

autoParagraph() public

autoParagraph(string|null $text): string

Форматирует абзацы вокруг заданного текста для всех символов новой строки
добавленных для однострочного возврата

добавленных для двустрочного возврата

Параметры

string|null $text: Текст

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#converting-text-into-paragraphs

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которое выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определённого значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно: Значение для установки.

Возвращает

$this

excerpt() public

excerpt(string $text, string $phrase, int $radius = 100, string $ending = '...'): string

Извлекает фрагмент текста, окружающий фразу, с заданным числом символов с каждой стороны, определяемым радиусом.

Параметры

string $text: Строка для поиска фразы.
string $phrase: Фраза, которая будет искаться.
int $radius optional: Количество символов, которое будет возвращено с каждой стороны найденной фразы.
string $ending optional: Окончание, которое будет добавлено.

Возвращает

string

См. также

\Cake\Utility\Text::excerpt()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#extracting-an-excerpt

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения, или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, если ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для данного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getView() public

getView(): Cake\View\View

Получить экземпляр представления, к которому привязан этот помощник.

Возвращает

Cake\View\View

highlight() public

highlight(string $text, string $phrase, array<string, mixed> $options = []): string

Выделяет заданную фразу в тексте. Вы можете указать любое выражение в выделении, которое может включать выражение \1 для включения найденной фразы $phrase.

Параметры

string $text: Текст для поиска фразы.
string $phrase: Искомая фраза.
array<string, mixed> $options optional: Массив HTML-атрибутов и опций.

Возвращает

string

См. также

\Cake\Utility\Text::highlight()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#highlighting-substrings

implementedEvents() public

implementedEvents(): array<string, mixed>

Обработчики событий.

Определяя один из методов обратного вызова, предполагается, что помощник заинтересован в соответствующем событии.

Переопределите этот метод, если вам необходимо добавить нестандартные обработчики событий. Или если вы хотите, чтобы помощники слушали нестандартные события.

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

Метод обработки конструктора.

Реализуйте этот метод, чтобы избежать необходимости перезаписи конструктора и вызова родительского класса.

Параметры

array<string, mixed> $config: Настройки конфигурации, предоставленные этому помощнику.

Возвращает

void

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки, или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Выполнить рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

slug() public

slug(string $string, array<string, mixed>|string $options = []): string

Возвращает строку, в которой все пробелы заменены на дефисы (по умолчанию), символы транслитерированы в ASCII-символы, а непечатные символы удалены.

Опции:

replacement: Строка замены. По умолчанию '-'.
transliteratorId: Валидный идентификатор транслитератора. Если null (по умолчанию), используется транслитератор (идентификатор), установленный через Text::setTransliteratorId() или Text::setTransliterator(). Если false, транслитерация не выполняется, удаляются только непечатные символы.
preserve: Конкретный непечатный символ, который нужно сохранить. По умолчанию null. Например, эту опцию можно установить на '.' для создания чистых имён файлов.

Параметры

string $string: строка, которую нужно slug-ировать
array<string, mixed>|string $options optional: Если строка, она будет использоваться как символ замены, или массив опций.

Возвращает

string

См. также

\Cake\Utility\Text::setTransliterator()
\Cake\Utility\Text::setTransliteratorId()

tail() public

tail(string $text, int $length = 100, array<string, mixed> $options = []): string

Обрезает текст, начиная с конца.

Укорачивает строку до длины $length и заменяет начальные символы многоточием, если текст длиннее length.

Опции:

ellipsis Будет использоваться как начало и предварять обрезанную строку
exact Если false, $text не будет обрезан по середине слова

Параметры

string $text: Строка для обрезки.
int $length optional: Длина возвращаемой строки, включая многоточие.
array<string, mixed> $options optional: Массив HTML-атрибутов и опций.

Возвращает

string

См. также

\Cake\Utility\Text::tail()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#truncating-the-tail-of-a-string

toList() public

toList(array<string> $list, string|null $and = null, string $separator = ', '): string

Создаёт список, разделённый запятыми, где последние два элемента объединяются с помощью «и», формируя естественный язык.

Параметры

array<string> $list: Список для объединения.
string|null $and optional: Слово, используемое для объединения последних двух элементов. По умолчанию «и».
string $separator optional: Разделитель, используемый для объединения всех остальных элементов. По умолчанию «, ».

Возвращает

string

См. также

\Cake\Utility\Text::toList()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#converting-an-array-to-sentence-form

truncate() public

truncate(string $text, int $length = 100, array<string, mixed> $options = []): string

Обрезает текст.

Укорачивает строку до длины $length и заменяет последние символы многоточием, если текст длиннее length.

Опции:

ellipsis Будет использоваться как окончание и добавляться к обрезанной строке
exact Если false, $text не будет обрезан по середине слова
html Если true, HTML-теги будут обработаны корректно

Параметры

string $text: Строка для обрезки.
int $length optional: Длина возвращаемой строки, включая многоточие.
array<string, mixed> $options optional: Массив HTML-атрибутов и опций.

Возвращает

string

См. также

\Cake\Utility\Text::truncate()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#truncating-text

Подробное описание свойств

`$Html` public @property

Тип

Cake\View\Helper\HtmlHelper

`$_View` protected

Экземпляр представления, к которому прикреплен этот помощник

Тип

Cake\View\View

`$_config` protected

Конфигурация во время выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Указывает, была ли конфигурация свойства уже настроена по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

Тип

array<string, mixed>

`$_engine` protected

Экземпляр Cake Utility Text

Тип

Cake\Utility\Text

`$_helperMap` protected

Таблица поиска помощников, используемая для отложенной загрузки объектов помощников.

Тип

array<string, array>

`$_placeholders` protected

Массив хэшей и их содержимого. Используется при вставке ссылок в текст.

Тип

array<string, array>

`$helpers` protected

помощники

Тип

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.3/class-Cake.View.Helper.TextHelper.html