Класс TextHelper

__call()source public

__call( string $method , array $params )

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

Параметры

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
Текст со ссылками

Ссылка

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.

Параметры

string $text

Текст

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

_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'

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

Возвращает

массив
Массив параметров с заданным ключом.

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

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

Возвращает

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

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