Класс TextHelper

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

Параметры для передачи методу.

Возвращает

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

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

Helper::__call()

__construct()source public

__construct( View $View , array $settings array() )

Конструктор

Настройки:

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

Параметры

View $View

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

массив $settings необязательно array()

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

Исключения

CakeException
если класс движка не найден.

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

Helper::__construct()

_insertPlaceHolder()source protected

_insertPlaceHolder( array $matches )

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

Параметры

массив $matches

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

Возвращает

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

_linkEmails()source protected

_linkEmails( string $text , array $options )

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

Параметры

строка $text

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

массив $options

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

Возвращает

строка

См.

TextHelper::autoLinkEmails()

_linkUrls()source protected

_linkUrls( string $text , array $htmlOptions )

Заменяет плейсхолдеры ссылками.

Параметры

строка $text

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

массив $htmlOptions

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

Возвращает

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

autoLink()source public

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

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

Опции

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

Параметры

строка $text

Текст

массив $options необязательно array()

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLink

autoLinkEmails()source public

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

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

Опции

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

Параметры

строка $text

Текст

массив $options необязательно array()

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkEmails

autoLinkUrls()source public

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

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

Параметры

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

Параметры

строка $text

Текст

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoLinkUrls

autoParagraph()source public

autoParagraph( string $text )

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

<

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

Параметры

строка $text

Текст

Возвращает

строка

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

<

p> и
тегами

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoParagraph

excerpt()source public

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

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

Параметры

строка $text

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

строка $phrase

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

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

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

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

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

Возвращает

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

См. также

CakeText::excerpt()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::excerpt

highlight()source public

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

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

Параметры

строка $text

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

строка $phrase

Искомая фраза

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

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

Возвращает

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

См. также

CakeText::highlight()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::highlight

stripLinks()source public

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

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

См. также

CakeText::stripLinks()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::stripLinks

tail()source public

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

Усекает текст, начиная с конца.

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

Параметры:

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

Параметры

строка $text

Строка для усечения.

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

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

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

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

Возвращает

строка
Усечённая строка.

См. также

CakeText::tail()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::tail

toList()source public

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

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

Параметры

массив $list

Список, который нужно объединить.

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

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

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

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

Возвращает

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

См. также

CakeText::toList()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::toList

truncate()source public

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

Усекает текст.

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

Параметры:

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

Параметры

строка $text

Строка для усечения.

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

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

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

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

Возвращает

строка
Усечённая строка.

См. также

CakeText::truncate()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::truncate

__get()source public

__get( string $name )

Лениво загружает помощники. Также предоставляет доступ к устаревшим свойствам запроса.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удалён в версии 3.0.

Параметры

строка $name

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

Возвращает

смешанный тип
Помощник или свойство, найденное в $name

__set()source public

__set( string $name , mixed $value )

Обеспечивает обратную совместимость доступа для установки значений в объект запроса.

Устарело

3.0.0 Этот метод будет удалён в версии 3.0

Параметры

строка $name

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

смешанный тип $value

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

_clean()source protected

_clean( )

Удаляет вредное содержимое из вывода

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

Код, который будет выполнен после того, как пользователь выбрал 'Отмена', также выполняется, когда okCode не возвращает значение

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

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

Возвращает

строка
JS код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

строка $url

URL для кодирования.

Возвращает

строка
URL, закодированный как для URL, так и для HTML контекстов.

_formatAttribute()source protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимизированными атрибутами, которые имеют то же значение, что и их имя, такие как 'disabled' и 'checked'.

Устарело

3.0.0 Этот метод будет перенесен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута для создания

строка $value

Значение атрибута для создания.

логическое значение $escape необязательно true

Определяет, нужно ли экранировать значение.

Возвращает

строка
Составленный атрибут.

_initInputField()source protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива атрибутов html.

Параметры

строка $field

Имя поля для инициализации.

массив $options необязательно array()

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

Возвращает

массив
Массив опций для поля ввода формы.

_name()source protected

_name( array|string $options array() , string $field null , string $key 'name' )

Получает имя поля ввода для текущего тега. Создает атрибуты имени ввода, используя формат CakePHP data[Model][field].

Параметры

массив или строка $options необязательно array()

Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использовано как сущность View.

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

Имя поля.

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

Имя атрибута для установки, по умолчанию 'name'

Возвращает

смешанное значение

Если для $options был передан массив, будет возвращен массив с установленным $key. Если была передана строка, будет возвращена строка.

_parseAttributes()source protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку, разделенную пробелами, с элементами массива $options. Если ключ массива $options совпадает с одним из перечисленных в Helper::$_minimizedAttributes,

и его значение равно:

• '1' (строка)
• 1 (целое число)
• true (булево значение)
• 'true' (строка)

то значение будет переопределено на идентичное имени ключа. Если значение не соответствует этим трем условиям, параметр не выводится.

'escape' — специальная опция, которая управляет преобразованием атрибутов в их эквиваленты, закодированные в HTML-сущностях. Установите в false, чтобы отключить кодировку HTML.

Если значение любого ключа опции установлено в null или false, эта опция будет исключена из вывода.

Устарело

3.0.0 Этот метод будет перенесен в HtmlHelper в версии 3.0

Параметры

массив $options

Массив опций.

массив $exclude необязательно null

Массив опций, которые необходимо исключить, эти опции не будут частью результата.

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

Строка, которая должна быть вставлена перед опциями.

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

Строка, которая должна быть вставлена после опций.

Возвращает

строка
Составленные атрибуты.

_reset()source protected

_reset( )

Сбрасывает переменные, используемые Helper::clean(), в null

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных опций для элемента множественного выбора.

Параметры

строка или массив $data

Массив данных или имя модели.

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

Имя поля.

Возвращает

массив

addClass()source public

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

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

Параметры

массив $options необязательно array()

Массив опций/атрибутов, к которому добавляется класс.

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

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

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

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

Возвращает

массив
Массив опций с установленным $key.

afterLayout()source public

afterLayout( string $layoutFile )

Обработчик после макета. afterLayout вызывается после отрисовки макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был отрисован.

afterRender()source public

afterRender( string $viewFile )

Обработчик после отрисовки. afterRender вызывается после отрисовки файла представления, но перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был отрисован.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

Обработчик после отрисовки файла. Вызывается после отрисовки любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

Содержимое, которое было отрисовано.

assetTimestamp()source public

assetTimestamp( string $path )

Добавляет отметку времени к файловому ресурсу, основанному на значении Asset.timestamp в Configure. Если Asset.timestamp — true и debug > 0, или Asset.timestamp === 'force', отметка времени будет добавлена.

Параметры

строка $path

Путь к файлу, которому нужно добавить отметку времени, путь должен находиться внутри WWW_ROOT.

Возвращает

строка
Путь с добавленной отметкой времени или без неё.

assetUrl()source public

assetUrl( string|array $path , array $options array() )

Генерирует URL для заданного файла ресурса. В зависимости от переданных опций предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp(), чтобы добавить отметку времени к локальным файлам.

Параметры

строка или массив $path

Строка пути или массив URL

массив $options необязательно array()

Массив опций. Возможные ключи: fullBase Возвращает полный URL с именем домена pathPrefix Префикс пути для относительных URL ext Расширение файла ресурса для добавления plugin Ложное значение предотвратит обработку пути как плагина

Возвращает

строка
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

Обработчик перед макетом. beforeLayout вызывается перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который должен быть отрисован.

beforeRender()source public

beforeRender( string $viewFile )

Обратный вызов перед рендерингом. beforeRender вызывается перед рендерингом файла представления.

Переопределяется в подклассах.

Параметры

string $viewFile

Файл представления, который будет рендериться

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Обратный вызов перед рендерингом файла. Вызывается перед рендерингом любого фрагмента представления.

Переопределяется в подклассах.

Параметры

string $viewFile

Файл, который собирается быть рендеренным.

clean()source public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако, не гарантирует удаление всех возможных угроз. Лучший способ предотвратить все возможные атаки — экранирование содержимого.

Устарело

3.0.0 Этот метод будет удален в 3.0

Параметры

string|array $output

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

string|array|null
Очищенное содержимое для вывода

domId()source public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора атрибута в формате CamelCase.

Параметры

array|string $options optional null

Либо массив HTML-атрибутов, в который добавить $id, либо строка с путем к сущности представления для получения domId.

string $id optional 'id'

Имя атрибута 'id'.

Возвращает

mixed

Если $options был массивом, будет возвращен массив с установленным $id. Если была передана строка, будет возвращена строка.

entity()source public

entity( )

Возвращает ссылку на сущность текущего контекста как массив идентификационных частей.

Возвращает

array
Массив, содержащий идентификационные элементы сущности

field()source public

field( )

Получает текущее используемое поле модели контекста рендеринга. Удаляет суффиксы полей, такие как year, month, day, hour, min, meridian, когда текущая сущность содержит более 2 элементов.

Возвращает

string

model()source public

model( )

Получает текущую используемую модель контекста рендеринга.

Возвращает

string

output()source public

output( string $str )

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

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

Устарело

3.0.0 Этот метод будет удален в будущих версиях.

Параметры

string $str

Строка, которая должна быть выведена.

Возвращает

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

string $entity

Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"

boolean $setScope optional false

Устанавливает область видимости представления на модель, указанную в $tagValue

url()source public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

Возвращает URL, указывающий на предоставленные параметры.

Параметры

string|array $url optional null

Либо относительный URL-адрес, например /products/view/23, либо массив параметров URL. Использование массива для URL позволит вам использовать функции обратного маршрутизирования CakePHP.

boolean $full optional false

Если true, к результату будет добавлен полный базовый URL

Возвращает

string
Полный переведенный URL с базовым путем.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

value()source public

value( array|string $options array() , string $field null , string $key 'value' )

Получает данные для текущего тега.

Параметры

array|string $options optional array()

Если массив, должен быть массивом атрибутов, к которым необходимо добавить $key. Если строка или null, будет использоваться как сущность представления.

string $field optional null

Имя поля.

string $key optional 'value'

Имя атрибута для установки, по умолчанию 'value'

Возвращает

mixed

Если для $options был передан массив, будет возвращен массив с установленным $key. Если была передана строка, будет возвращена строка.

webroot()source public

webroot( string $file )

Проверяет существование файла при использовании темы, если файл не найден, возвращается расположение по умолчанию.

Параметры

string $file

Файл, для которого необходимо получить путь webroot.

Возвращает

string
Веб-доступный путь к файлу.

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет $property этого объекта со свойством в определении $class. Значение этого объекта для свойства будет объединено сверху $class'

Это обеспечивает часть DRY-магии CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

array $properties

Имя свойств для объединения.

string $class

Класс для объединения свойства с.

boolean $normalize optional true

Установите в true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будет установлены только свойства, которые являются частью объявления класса.

Параметры

array $properties optional array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Обёртка для exit(), облегчающая тестирование.

Параметры

integer|string $status optional 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет обёртку ООП для call_user_func_array.

Параметры

string $method

Имя метода для вызова

array $params optional array()

Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения дополнительной информации о записи в журналы, см. CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создается сообщение журнала. Дополнительную информацию о областях ведения журналов см. в CakeLog::config().

Возвращает

boolean
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любой точки. Может использоваться для связи контроллеров или подключения плагинов к основному приложению. requestAction может использоваться для возврата рендеренных представлений или получения возвращаемого значения из действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строку URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET можно смоделировать в requestAction. Для данных GET используйте $extra['url']. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

URL в виде строки или массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно массив()

Если массив содержит ключ "return", устанавливает AutoRender в значение true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

смешанный тип

Булевое значение true или false при успехе/неудачи, или содержимое рендеренного действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

строка
Имя этого класса

array()

array('Html')