Класс TextHelper

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

Возвращает

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

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

Cake\View\Helper::__call()

__construct()source public

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

Конструктор

Настройки:

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

Параметры

Cake\View\View $View

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

массив $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
Экземпляр помощника, если помощник с заданным именем существует

__set()source public

__set( string $name , mixed $value )

Магический установщик для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанный $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанный

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

строка $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

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

Выбрасывает

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

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

Возвращает

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

Выбрасывает

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

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

Возвращает

$this

Выбрасывает

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

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

[]

['Html']