Класс TextHelper

__call()исходный код public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

Возвращает

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

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

Cake\View\Helper::__call()

__construct()исходный код 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()исходный код protected

_insertPlaceHolder( array $matches )

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

Параметры

массив $matches

Массив результатов регулярного выражения.

Возвращает

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

_linkEmails()исходный код protected

_linkEmails( string $text , array $options )

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

Параметры

строка $text

Текст, над которым выполняется операция

массив $options

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

Возвращает

string

См.

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

_linkUrls()исходный код protected

_linkUrls( string $text , array $htmlOptions )

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

Параметры

строка $text

Текст, над которым выполняется операция.

массив $htmlOptions

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

Возвращает

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

autoLink()исходный код public

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

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

Опции

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

Параметры

строка $text

Текст

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

Массив HTML-опций и вышеуказанных опций.

Возвращает

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

Ссылка

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

autoLinkEmails()исходный код public

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

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

Опции

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

Параметры

строка $text

Текст

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

Массив HTML-опций и вышеуказанных опций.

Возвращает

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

Ссылка

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 для включения найденной фразы.

Параметры

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

Код, который будет выполнен после выбора пользователем '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

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

булево|строка $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']);

Устаревшее

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

Параметры

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

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

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

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

булево $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

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

Возвращает

смешанный тип
Данные конфигурации по указанному ключу или 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

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

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

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

Возвращает

$this

Выбрасывает

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

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

[]

['Html']