Класс TextHelper

__call()source public

__call( string $method , array $params )

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

Параметры

string $method

Вызываемый метод

array $params

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

Возвращает

mixed
Результат вызова метода или false при неудаче

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

Cake\View\Helper::__call()

__construct()source public

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

Конструктор

Настройки:

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

Параметры

Cake\View\View $View

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

array $config необязательно []

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

Возбуждает

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

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

Cake\View\Helper::__construct()

_insertPlaceHolder()source protected

_insertPlaceHolder( array $matches )

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

Параметры

array $matches

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

Возвращает

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

_linkEmails()source protected

_linkEmails( string $text , array $options )

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

Параметры

string $text

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

array $options

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

Возвращает

string

См.

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

_linkUrls()source protected

_linkUrls( string $text , array $htmlOptions )

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

Параметры

string $text

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

array $htmlOptions

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

Возвращает

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

autoLink()source public

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

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

Параметры

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

Параметры

string $text

Текст

array $options необязательно []

Массив опций HTML и перечисленных выше параметров.

Возвращает

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

Ссылка

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

autoLinkEmails()source public

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

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

Параметры

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

Параметры

string $text

Текст

array $options необязательно []

Массив опций HTML и перечисленных выше параметров.

Возвращает

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

Ссылка

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

autoLinkUrls()source public

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

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

Параметры

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

Параметры

строка $text

Текст

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

Массив HTML параметров и параметров, перечисленных выше.

Возвращает

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

Ссылка

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

autoParagraph()source public

autoParagraph( string $text )

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

<

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

Параметры

строка $text

Текст

Возвращает

строка

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

<

p> и
тегами

Ссылка

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

excerpt()source public

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

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

Параметры

строка $text

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

строка $phrase

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

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

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

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

Окончание, которое будет добавлено

Возвращает

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

См. также

\Cake\Utility\Text::excerpt()

Ссылка

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

highlight()source public

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

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

Параметры

строка $text

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

строка $phrase

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

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

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

Возвращает

строка
Выделенный текст

См. также

\Cake\Utility\Text::highlight()

Ссылка

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

stripLinks()source public

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

строка
Текст без ссылок

См. также

\Cake\Utility\Text::stripLinks()

Ссылка

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

tail()source public

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

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

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

Параметры:

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

Параметры

строка $text

Строка для обрезки.

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

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

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

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

Возвращает

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

См. также

\Cake\Utility\Text::tail()

Ссылка

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

toList()source public

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

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

Параметры

массив $list

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

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

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

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

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

Возвращает

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

См. также

\Cake\Utility\Text::toList()

Ссылка

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

truncate()source public

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

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

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

Параметры:

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

Параметры

строка $text

Строка для обрезки.

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

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

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

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

Возвращает

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

См. также

\Cake\Utility\Text::truncate()

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

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

Возвращает

строка
JS код onclick

addClass()source public

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

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

Параметры

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

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

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

Имя добавляемого класса.

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

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

Возвращает

массив
Массив опций со значением $key.

initialize()source public

initialize( array $config )

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

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

Параметры

массив $config

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

смешанное

_configWrite()source protected

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

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

Параметры

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

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

смешанное $value

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

boolean|строка $merge необязательный false

Истина для рекурсивного слияния, «мелкое» для простого слияния, ложь для перезаписи, по умолчанию ложь.

Выбрасывает

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

config()source 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

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

boolean $merge необязательный true

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

Возвращает

смешанное
Считываемое значение конфигурации или сам объект при операциях записи.

Выбрасывает

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

configShallow()source 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']);

Параметры

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

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

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

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

Возвращает

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

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

[]

['Html']