Класс TextHelper

__callsource public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

Возвращает

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

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

Helper::__call()

__constructsource public

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

Конструктор

Настройки:

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

Параметры

View $View

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

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

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

Исключения

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

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

Helper::__construct()

_insertPlaceHoldersource protected

_insertPlaceHolder( array $matches )

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

Параметры

массив $matches

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

Возвращает

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

_linkEmailssource protected

_linkEmails( string $text , array $options )

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

Параметры

строка $text

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

массив $options

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

Возвращает

string
строка

См.

TextHelper::autoLinkEmails()

_linkUrlssource protected

_linkUrls( string $text , array $htmlOptions )

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

Параметры

строка $text

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

массив $htmlOptions

Опции для создаваемых ссылок.

Возвращает

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

autoLinksource public

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

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

Опции

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

Параметры

строка $text

Текст

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

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

Возвращает

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

Ссылка

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

autoLinkEmailssource public

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

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

Опции

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

Параметры

строка $text

Текст

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

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

Возвращает

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

Ссылка

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

autoLinkUrlssource public

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

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

Опции

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

Параметры

строка $text

Текст

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

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

Возвращает

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

Ссылка

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

autoParagraphsource public

autoParagraph( string $text )

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

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

Параметры

строка $text

Текст

Возвращает

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

и
тегами

Ссылка

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

excerptsource public

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

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

Параметры

строка $text

Строка для поиска фразы в ней

строка $phrase

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

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

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

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

Заключительный символ, который будет добавлен

Возвращает

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

См.

CakeText::excerpt()

Ссылка

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

highlightsource public

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

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

Параметры

строка $text

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

строка $phrase

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

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

Массив атрибутов и опций HTML.

Возвращает

string
Выделенный текст

См.

CakeText::highlight()

Ссылка

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

stripLinkssource public

stripLinks( string $text )

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

Параметры

строка $text

Текст

Возвращает

string
Текст без ссылок

См.

CakeText::stripLinks()

Ссылка

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

tailsource public

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

Обрезает текст, начиная с конца.

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

Параметры:

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

Параметры

строка $text

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

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

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

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

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

Возвращает

string
Обрезанная строка.

См. также

CakeText::tail()

Ссылка

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

toListsource public

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

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

Параметры

массив $list

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

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

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

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

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

Возвращает

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

См. также

CakeText::toList()

Ссылка

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

truncatesource public

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

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

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

Параметры:

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

Параметры

строка $text

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

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

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

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

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

Возвращает

string
Обрезанная строка.

См. также

CakeText::truncate()

Ссылка

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

__getsource public

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

Возвращает

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

__setsource public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанное $value

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

_cleansource protected

_clean( )

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

_confirmsource protected

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

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

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

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

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

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

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

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_formatAttributesource protected

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

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

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

Возвращает

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

_initInputFieldsource protected

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

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

Параметры

строка $field

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

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

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

Возвращает

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

_namesource protected

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

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

_parseAttributessource 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

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

Возвращает

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

_resetsource protected

_reset( )

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

_selectedArraysource protected

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

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

Параметры

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

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

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

Имя поля.

Возвращает

array
массив

addClasssource public

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

Добавляет заданный класс к параметрам элемента

Параметры

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

Массив параметров/атрибутов, к которым нужно добавить класс

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

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

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

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

Возвращает

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

afterLayoutsource public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

afterRendersource public

afterRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile

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

строка $content

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

assetTimestampsource public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrlsource public

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

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

Параметры

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

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

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

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

Возвращает

string
Сгенерированный URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

Макет, который собирается быть отрисованным.

beforeRendersource public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

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

cleansource public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако, не гарантирует удаление всех возможных вариантов. Наиболее эффективным способом предотвращения всех возможных атак является экранирование содержимого.

Устаревший

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

Параметры

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

Массив строк для очистки или одна строка для очистки.

Возвращает

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

domIdsource public

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

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

Параметры

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

Массив HTML-атрибутов для добавления $id или строка с путем к сущности представления для получения идентификатора domId.

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

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

Возвращает

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

entitysource public

entity( )

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

Возвращает

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

fieldsource public

field( )

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

Возвращает

string
строка

modelsource public

model( )

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

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

string
строка

outputsource public

output( string $str )

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

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

Устаревший

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

Параметры

строка $str

Строка для вывода.

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

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

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

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

urlsource public

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

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

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

Параметры

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

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

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

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

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

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

Ссылка

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

valuesource public

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

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

Параметры

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

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

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

Имя поля.

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

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

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

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

webrootsource public

webroot( string $file )

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

Параметры

строка $file

Файл для создания пути webroot.

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

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

_mergeVarssource protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

целое число|строка $status необязательно 0

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

dispatchMethodsource public

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

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

Параметры

строка $method

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

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

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

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

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

logsource 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
Успех записи в журнал

requestActionsource public

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

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

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

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

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

Параметры

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

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

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

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

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

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

toStringsource public

toString( )

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

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

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

array()

array('Html')

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

null

null

array()

array()

null