Класс TextHelper

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

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

mixed
Результат вызова метода или false при ошибке

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

Cake\View\Helper::__call()

__construct()source public

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

Конструктор

Настройки:

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

Параметры

Cake\View\View $View

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

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

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

Исключения

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

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

Cake\View\Helper::__construct()

_insertPlaceHolder()source protected

_insertPlaceHolder( array $matches )

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

Параметры

массив $matches

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

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

строка
Заменённые значения.

_linkEmails()source protected

_linkEmails( string $text , array $options )

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

Параметры

строка $text

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

массив $options

Массив опций для использования в HTML.

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

строка

См.

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

_linkUrls()source protected

_linkUrls( string $text , array $htmlOptions )

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

Параметры

строка $text

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

массив $htmlOptions

Опции для сгенерированных ссылок.

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

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

autoLink()source public

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

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

Опции

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

Параметры

строка $text

Текст

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

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

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

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

Ссылка

https://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.

Параметры

строка $text

Текст

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

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

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

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

Ссылка

https://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-параметров и параметров, перечисленных выше.

Возвращает

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

Ссылка

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

autoParagraph()source public

autoParagraph( string $text )

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

<

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

Параметры

строка $text

Текст

Возвращает

строка

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

<

p> и
тегами

Ссылка

https://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()

Ссылка

https://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()

Ссылка

https://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()

Ссылка

https://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()

Ссылка

https://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()

Ссылка

https://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()

Ссылка

https://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.

getView()source public

getView( )

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

Возвращает

Cake\View\View
Экземпляр привязанного представления.

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

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

Выбрасывает

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

config()source public deprecated

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

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

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

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

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

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

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

Возвращает

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

Выбрасывает

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()source public

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

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

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

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

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

Параметры

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

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

смешанное $default необязательно null

Возвращаемое значение, когда ключ не существует.

Возвращает

смешанное
Значение конфигурации, которое читается.

setConfig()source public

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

$this

Выбрасывает

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

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

[]

['Html']