Класс Helper

__call()source public

__call( string $method , array $params )

Предоставление ошибок при отсутствии вызова метода без фатальных последствий.

Параметры

string $method

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

array $params

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

__construct()source public

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

Конструктор по умолчанию

Параметры

View $View

Представление, к которому прикреплен хелпер.

array $settings optional array()

Настройки конфигурации для хелпера.

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

CakeObject::__construct()

__get()source public

__get( string $name )

Леничная загрузка хелперов. Предоставляет доступ к устаревшим свойствам запроса.

Устаревшее

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

Параметры

string $name

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

Возвращает

mixed
Хелпер или найденное свойство по $name

__set()source public

__set( string $name , mixed $value )

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

Устаревшее

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

Параметры

string $name

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

mixed $value

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

_clean()source protected

_clean( )

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

_confirm()source protected

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

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

Параметры

string $message

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

string $okCode

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

string $cancelCode optional ''

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

array $options optional array()

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

Возвращает

string
JS код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

string $url

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

Возвращает

string
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' (строка)

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

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

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

Параметры

строка $viewFile

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

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

Файл, который собираются отобразить.

clean()source public

clean( string|array $output )

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

Устарело

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

Параметры

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

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

Возвращает

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

domId()source public

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

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

Параметры

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

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

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

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

Возвращает

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

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

строка

model()source public

model( )

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

Возвращает

строка

output()source public

output( string $str )

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

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

Устарело

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

Параметры

строка $str

Строка, подлежащая выводу.

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

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

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

url()source public

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

value()source public

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

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

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

Файл, для которого нужно создать путь webroot.

Возвращает

строка
Web-доступный путь к файлу.

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

смешанный тип
Возвращает результат вызова метода

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|string|массив $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. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

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

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

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

Возвращает

смешанное

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

toString()source public

toString( )

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

Возвращает

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

'%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()

array()

null

null

array()

array()

null