Класс TextHelper

__callsource public

__call( string $method , array $params )

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

Параметры

строка $method

Метод для вызова

массив $params

Массив параметров для метода.

Возвращает

mixed
То, что возвращает вызываемый метод, или false при ошибке

Переопределяет

Cake\View\Helper::__call()

__constructsource public

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

Конструктор

Настройки:

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

Параметры

Cake\View\View $View

объект представления, к которому прикреплён помощник.

массив $config необязательно []

Массив настроек

Выбрасывает

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

Переопределяет

Cake\View\Helper::__construct()

_insertPlaceHoldersource protected

_insertPlaceHolder( array $matches )

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

Параметры

массив $matches

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

Возвращает

string
Заменённые значения.

_linkEmailssource protected

_linkEmails( string $text , array $options )

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

Параметры

строка $text

Текст, над которым необходимо выполнить операцию

массив $options

Массив параметров для использования в HTML.

Возвращает

string
строка

См.

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

_linkUrlssource protected

_linkUrls( string $text , array $htmlOptions )

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

Параметры

строка $text

Текст для обработки.

массив $htmlOptions

Параметры для сгенерированных ссылок.

Возвращает

string
Текст со вставленными ссылками.

autoLinksource public

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

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

Параметры

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

Параметры

строка $text

Текст

массив $options необязательно []

Массив HTML-параметров и параметров, указанных выше.

Возвращает

string
Текст со ссылками

Ссылка

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

autoLinkEmailssource public

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

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

Параметры

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

Параметры

строка $text

Текст

массив $options необязательно []

Массив HTML-параметров и параметров, указанных выше.

Возвращает

string
Текст со ссылками

Ссылка

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

autoLinkUrlssource public

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

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

Параметры

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

Параметры

строка $text

Текст

массив $options необязательно []

Массив HTML-параметров и параметров, указанных выше.

Возвращает

string
Текст со ссылками

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/text.html#linking-urls

autoParagraphsource public

autoParagraph( string $text )

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

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

Параметры

строка $text

Текст

Возвращает

string
Текст с правильными тегами

и
тегами

Ссылка

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

excerptsource public

excerpt( string $text , string $phrase , integer $radius 100 , string $ending '...' )

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

Параметры

строка $text

Строка для поиска фразы

строка $phrase

Фраза, для которой будет производиться поиск

целое число $radius необязательно 100

Количество символов, которые будут возвращены с каждой стороны найденной фразы

строка $ending необязательно '...'

Последовательность, которая будет добавлена в конец

Возвращает

string
Изменённая строка

См.

Cake\Utility\Text::excerpt()

Ссылка

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

highlightsource public

highlight( string $text , string $phrase , array $options [] )

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

Параметры

строка $text

Текст для поиска фразы

строка $phrase

Фраза, для которой будет осуществлен поиск

массив $options необязательно []

Массив HTML-атрибутов и параметров.

Возвращает

string
Выделенный текст

См.

Cake\Utility\Text::highlight()

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/text.html#highlighting-substrings

implementedEventssource public

implementedEvents( )

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

Возвращает

array
массив

Переопределяет

Cake\View\Helper::implementedEvents()

stripLinkssource public

stripLinks( string $text )

Удаляет из заданного текста все ссылки (<a href=....)

Параметры

строка $text

Текст

Возвращает

string
Текст без ссылок

См. также

Cake\Utility\Text::stripLinks()

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/text.html#removing-links

tailsource public

tail( string $text , integer $length 100 , array $options [] )

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

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

Параметры:

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

Параметры

строка $text

Строка для усечения.

целое число $length необязательно 100

Длина возвращаемой строки, включая многоточие.

массив $options необязательно []

Массив HTML-атрибутов и параметров.

Возвращает

string
Обрезанная строка.

См. также

Cake\Utility\Text::tail()

Ссылка

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

toListsource public

toList( array $list , string $and null , string $separator ', ' )

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

Параметры

массив $list

Список для объединения.

строка $and необязательно null

Слово, используемое для объединения последнего и предпоследнего элементов. По умолчанию 'и'.

строка $separator необязательно ', '

Разделитель, используемый для объединения всех остальных элементов. По умолчанию ', '.

Возвращает

string
Объединённая строка.

См. также

Cake\Utility\Text::toList()

Ссылка

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

truncatesource public

truncate( string $text , integer $length 100 , array $options [] )

Усекает текст.

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

Параметры:

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

Параметры

строка $text

Строка для усечения.

целое число $length необязательно 100

Длина возвращаемой строки, включая многоточие.

массив $options необязательно []

Массив HTML-атрибутов и параметров.

Возвращает

string
Обрезанная строка.

См. также

Cake\Utility\Text::truncate()

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/text.html#truncating-text

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с заданным именем существует

_confirmsource protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )

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

Параметры

строка $message

Сообщение, которое будет отображено

строка $okCode

Код, который будет выполнен после выбора пользователем 'OK'

строка $cancelCode необязательно ''

Код, который будет выполнен после выбора пользователем 'Отмена'

массив $options необязательно []

Массив параметров

Возвращает

string
JS-код onclick

addClasssource public

addClass( array $options [] , string $class null , string $key 'class' )

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

Параметры

массив $options необязательно []

Массив параметров/атрибутов, к которому нужно добавить класс

строка $class необязательно null

Название добавляемого класса.

строка $key необязательно 'class'

ключ для использования для класса.

Возвращает

array
Массив параметров с установленным $key.

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $value

Значение для записи.

булево|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

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

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

$this->config();

Чтение конкретного значения:

$this->config('key');

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

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

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

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

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

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

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

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

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

булево $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Исключения

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

configShallowsource public

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

Значение для установки.

Возвращаемое значение

mixed
$this Сам объект.

[
    'engine' => 'Cake\Utility\Text'
]

[]

['Html']

[]

[]

null

null

[]

null

[]

false