Класс 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

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

bool

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

array

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

Cake\Utility\Text

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

array

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

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

Выделяет заданную фразу в тексте. Можно указать любое выражение в highlighter, которое может включать выражение \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

Parameters

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

Returns

mixed

__construct() public

__construct(Cake\View\View $view, array $config = [])

Конструктор

Settings:

engine Имя класса для замены функциональности String. Класс должен находиться в директории Utility.

Parameters

Cake\View\View $view: Объект представления, к которому прикреплен помощник.
array $config optional: Массив настроек Массив настроек

Throws

Cake\Core\Exception\CakeException
если класс движка не найден.

__debugInfo() public

__debugInfo(): array

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

Returns

array

__get() public

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

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

Parameters

string $name: Имя доступного свойства.

Returns

Cake\View\Helper|null|void

_configDelete() protected

_configDelete(string $key): void

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

Parameters

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

Returns

void

Throws

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

_configRead() protected

_configRead(string|null $key): mixed

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

Parameters

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

Returns

mixed

_configWrite() protected

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

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

Parameters

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

Returns

void

Throws

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

_confirm() protected

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

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

Parameters

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

Returns

string

_insertPlaceHolder() protected

_insertPlaceHolder(array $matches): string

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

Parameters

array $matches: Массив совпадений regexp.

Returns

string

_linkEmails() protected

_linkEmails(string $text, array $options): string

Ссылки на адреса электронной почты

Parameters

string $text: Текст для обработки
array $options: Массив параметров для HTML.

Returns

string

_linkUrls() protected

_linkUrls(string $text, array $htmlOptions): string

Замена заполнителей на ссылки.

Parameters

string $text: Текст для обработки.
array $htmlOptions: Параметры для сгенерированных ссылок.

Returns

string

addClass() public

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

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

Parameters

array $options: Массив параметров/атрибутов, к которым нужно добавить класс
string $class: Добавляемое имя класса.
string $key optional: ключ для использования класса. По умолчанию 'class'.

Returns

array

autoLink() public

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

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

Options

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

Parameters

string $text: Текст
array $options optional: Массив параметров HTML и параметров, указанных выше.

Returns

string

Links

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

autoLinkEmails() public

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

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

Options

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

Parameters

string $text: Текст
array $options optional: Массив параметров HTML и параметров, указанных выше.

Returns

string

Links

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

autoLinkUrls() public

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

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

Options

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

Parameters

string $text: Текст
array $options optional: Массив параметров HTML и параметров, указанных выше.

Returns

string

Links

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

autoParagraph() public

autoParagraph(string|null $text): string

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

добавлен для двойного возврата строки

Parameters

string|null $text: Текст

Returns

string

Links

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

configShallow() public

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

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

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

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

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

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

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

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

Parameters

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

Returns

$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#извлечение-фрагмента

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 $options = []): string

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

Параметры

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

Возвращает

string

См. также

\Cake\Utility\Text::highlight()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#выделение-подстрок

implementedEvents() public

implementedEvents(): array

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

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

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

Возвращает

array

initialize() public

initialize(array $config): void

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

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

Параметры

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

Возвращает

void

setConfig() public

setConfig(string|array $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']);

Параметры

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

Возвращает

$this

Исключения

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

slug() public

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

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

Параметры:

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

Параметры

string $string: Строка, которую нужно преобразовать в slug.
array|string $options optional: Если строка, она будет использована в качестве символа замены, или массив параметров.

Возвращает

string

См. также

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

tail() public

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

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

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

Параметры:

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

Параметры

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

Возвращает

string

См. также

\Cake\Utility\Text::tail()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#обрезание-хвоста-строки

toList() public

toList(string[] $list, string|null $and = null, string $separator = ', '): string

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

Параметры

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

Возвращает

string

См. также

\Cake\Utility\Text::toList()

Ссылки

https://book.cakephp.org/4/ru/views/helpers/text.html#преобразование-массива-в-предложение

truncate() public

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

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

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

Параметры:

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

Параметры

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

Тип

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

Класс TextHelper

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

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

__call() public

__construct() public

__debugInfo() public

__get() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_confirm() protected

_insertPlaceHolder() protected

_linkEmails() protected

_linkUrls() protected

addClass() public

autoLink() public

autoLinkEmails() public

autoLinkUrls() public

autoParagraph() public

configShallow() public

excerpt() public

getConfig() public

getConfigOrFail() public

getView() public

highlight() public

implementedEvents() public

initialize() public

setConfig() public

slug() public

tail() public

toList() public

truncate() public

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

__call() public

Parameters

Returns

__construct() public

Settings:

Parameters

Throws

__debugInfo() public

Returns

__get() public

Parameters

Returns

_configDelete() protected

Parameters

Returns

Throws

_configRead() protected

Parameters

Returns

_configWrite() protected

Parameters

Returns

Throws

_confirm() protected

Parameters

Returns

_insertPlaceHolder() protected

Parameters

Returns

_linkEmails() protected

Parameters

Returns

See Also

_linkUrls() protected

Parameters

Returns

addClass() public

Parameters

Returns

autoLink() public

Options

Parameters

Returns

Links

autoLinkEmails() public

Options

Parameters

`$Html` public @property

`$_View` protected