Класс PrototypeEngineHelper

domReady()source public

domReady( string $functionBody )

Создать событие domReady. Это специальное событие во многих библиотеках

Параметры

строка $functionBody

Код, который нужно выполнить при domReady

Возвращает

строка
завершенный метод domReady

drag()source public

drag( array $options array() )

Создать элемент Draggable.

Примечание: Для работы требуется загрузка scriptaculous.

Параметры

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

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

Возвращает

строка
Завершенный скрипт draggable.

См. также

JsBaseEngineHelper::draggable() для списка параметров.

drop()source public

drop( array $options array() )

Создать элемент Droppable.

Примечание: Для работы требуется загрузка scriptaculous.

Параметры

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

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

Возвращает

строка
Завершенный скрипт droppable.

См. также

JsBaseEngineHelper::droppable() для списка параметров.

each()source public

each( string $callback )

Создать итерацию по результатам текущего выбора.

Параметры

строка $callback

Тело функции, которую вы хотите применить во время итерации.

Возвращает

строка
завершенная итерация

effect()source public

effect( string $name , array $options array() )

Спровоцировать эффект.

Примечание: Для работы с эффектами требуется Scriptaculous.

Параметры

строка $name

Имя эффекта, который нужно запустить.

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

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

Возвращает

строка
завершенная строка с эффектом.

См. также

JsBaseEngineHelper::effect()

event()source public

event( string $type , string $callback , array $options array() )

Добавить событие в кэш скрипта. Операции выполняются с текущими выбранными элементами.

Параметры

• wrap - Нужно ли оборачивать обратный вызов в анонимную функцию. (по умолчанию true)
• stop - Нужно ли останавливать событие. (по умолчанию true)

Параметры

строка $type

Тип события, к которому нужно привязать текущий идентификатор 946

строка $callback

JavaScript-функция, которую нужно запустить, или функция-литерал

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

Параметры для события.

Возвращает

строка
завершенный обработчик событий

get()source public

get( string $selector )

Создать JavaScript-селектор для CSS-правила

Параметры

строка $selector

Целевой селектор

Возвращает

PrototypeEngineHelper

request()source public

request( string|array $url , array $options array() )

Создать вызов Ajax или Ajax.Updater.

Параметры

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

URL.

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

Список параметров.

Возвращает

строка
Завершенный вызов ajax.

serializeForm()source public

serializeForm( array $options array() )

Сериализовать форму, прикрепленную к $selector.

Параметры

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

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

Возвращает

строка
Завершенный фрагмент serializeForm()

См. также

JsBaseEngineHelper::serializeForm()

slider()source public

slider( array $options array() )

Создаёт виджет ползунка.

Примечание: Для работы требуется загрузка scriptaculous.

Параметры

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

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

Возвращает

строка
Завершенный скрипт ползунка.

См. также

JsBaseEngineHelper::slider() для списка параметров.

sortable()source public

sortable( array $options array() )

Создать сортируемый элемент.

Примечание: Требуется загрузка scriptaculous.

Реализация сортировки scriptaculous не поддерживает параметры «start» и «distance».

Параметры

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

Массив параметров для сортируемого элемента.

Возвращает

строка
Завершенный скрипт сортировки.

См. также

JsBaseEngineHelper::sortable() для списка параметров.

_mapOptions()source protected

_mapOptions( string $method , array $options )

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

Параметры

строка $method

Имя метода, параметры которого обрабатываются.

массив $options

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

Возвращает

массив
Массив преобразованных параметров.

_parseOptions()source protected

_parseOptions( array $options , array $safeKeys array() )

Разбор массива параметров в объект JavaScript. Аналогично object(), но любые значения, отличные от целых чисел, рассматриваются как строки, и не включает { }

Параметры

массив $options

Параметры для преобразования

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

Ключи, которые не должны быть экранированы.

Возвращает

строка
Разбор параметров в формате JSON без окружающих фигур {}.

_prepareCallbacks()source protected

_prepareCallbacks( string $method , array $options , array $callbacks array() )

Подготовка обратных вызовов и их обертывание в функцию ([args]) { }, как определено в массиве _callbackArgs.

Параметры

строка $method

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

массив $options

Массив обрабатываемых параметров.

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

Дополнительные ключи, содержащие обратные вызовы

Возвращает

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

_processOptions()source protected

_processOptions( string $method , array $options )

Обёртка для всех общих шагов обработки параметров. Вызывает _mapOptions, _prepareCallbacks и _parseOptions в указанном порядке.

Параметры

строка $method

Имя метода, для обработки которого предназначены параметры.

массив $options

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

Возвращает

строка
Строка обработанных параметров.

_toQuerystring()source protected

_toQuerystring( array $parameters )

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

Параметры

массив $parameters

Массив параметров, которые нужно преобразовать в строку запроса.

Возвращает

строка
Часть строки запроса

_utf8ToHex()source protected

_utf8ToHex( string $string )

Кодировка строки в JSON. Преобразует и экранирует необходимые символы.

Параметры

строка $string

Строка, которая должна быть закодирована utf8->hex.

alert()source public

alert( string $message )

Создание сообщения alert() в JavaScript

Параметры

строка $message

Сообщение, которое нужно изменить.

Возвращает

строка
Завершенный alert()

confirm()source public

confirm( string $message )

Создание сообщения confirm()

Параметры

строка $message

Сообщение, которое нужно подтвердить.

Возвращает

строка
Завершенный confirm()

confirmReturn()source public

confirmReturn( string $message )

Генерация фрагмента confirm, возвращающего значение false из текущей области видимости функции.

Параметры

строка $message

Сообщение для использования в диалоговом окне подтверждения.

Возвращает

строка
Завершенный confirm со скриптом возврата

escape()source public

escape( string $string )

Экранирование строки для совместимости с JSON.

Список экранируемых элементов:

• "\r" => '\n'
• "\n" => '\n'
• '"' => '\"'

Параметры

строка $string

Строка, которую нужно экранировать.

Возвращает

строка
Экранированная строка.

object()source public

object( array $data array() , array $options array() )

Генерирует объект JavaScript в формате JavaScript Object Notation (JSON) из массива. Использует встроенный метод JSON encode, если он доступен и $useNative == true

Параметры:

• prefix - Строка, добавляемая перед возвращаемыми данными.
• postfix - Строка, добавляемая после возвращаемых данных.

Параметры

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

Данные для преобразования.

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

Набор параметров, см. выше.

Возвращает

строка
Блок кода JSON

prompt()source public

prompt( string $message , string $default '' )

Создание функции prompt() JavaScript

Параметры

строка $message

Сообщение для запроса.

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

Значение по умолчанию

Возвращает

строка
Завершенный prompt()

redirect()source public

redirect( string|array $url null )

Перенаправление на URL. Создает фрагмент кода window.location, который можно использовать для перенаправления из JavaScript.

Параметры

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

URL

Возвращает

строка
Завершенное перенаправление в JavaScript

value()source public

value( mixed $val array() , boolean $quoteString null , string $key 'value' )

Преобразование PHP-переменной любого типа в эквивалентное представление JSON.

Параметры

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

PHP-переменная для преобразования в JSON

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

Если false, значения строк остаются без кавычек

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

Имя ключа.

Возвращает

строка
Безопасное для JavaScript представление $val в формате JSON

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

Helper::value()

__call()source public

__call( string $method , array $params )

Предоставляет некритические ошибки при вызовах отсутствующих методов.

Параметры

строка $method

Вызываемый метод

массив $params

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

__construct()source public

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

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

Параметры

View $View

Вид, к которому прикрепляется помощник.

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

Настройки конфигурации помощника.

Переопределения

Object::__construct()

__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 необязательный массив()

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

Возвращает

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

_name()source protected

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

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

Параметры

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

Если массив, должен быть массивом атрибутов, к которым необходимо добавить $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 необязательный массив()

Массив параметров/атрибутов для добавления класса к ним

строка $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 необязательно массив()

Массив опций. Возможные ключи: 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' )

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

Параметры

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

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

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

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

Возвращает

смешанное

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

строка

model()source public

model( )

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

Возвращает

строка

output()source public

output( string $str )

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

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

Устаревшее

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

Параметры

строка $str

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

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства helper'a model и field в пару значений, разделенных точкой, в $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 с базовым путём.

Ссылка

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

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

Возвращает

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

_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

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

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

Параметры

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

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

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

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

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

mixed

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

toString()source public

toString( )

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

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

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

array(
    'slider' => array(
        'onSlide' => 'value',
        'onChange' => 'value',
    ),
    'drag' => array(
        'onStart' => 'event',
        'onDrag' => 'event',
        'change' => 'draggable',
        'onEnd' => 'event',
    ),
    'drop' => array(
        'onHover' => 'draggable, droppable, event',
        'onDrop' => 'draggable, droppable, event',
    ),
    'request' => array(
        'onCreate' => 'transport',
        'onComplete' => 'transport',
        'onFailure' => 'response, jsonHeader',
        'onRequest' => 'transport',
        'onSuccess' => 'response, jsonHeader'
    ),
    'sortable' => array(
        'onStart' => 'element',
        'onChange' => 'element',
        'onUpdate' => 'element',
    ),
)

false

array(
    'request' => array(
        'async' => 'asynchronous',
        'data' => 'parameters',
        'before' => 'onCreate',
        'success' => 'onSuccess',
        'complete' => 'onComplete',
        'error' => 'onFailure'
    ),
    'sortable' => array(
        'sort' => 'onChange',
        'complete' => 'onUpdate',
    ),
    'drag' => array(
        'snapGrid' => 'snap',
        'container' => 'constraint',
        'stop' => 'onEnd',
        'start' => 'onStart',
        'drag' => 'onDrag',
    ),
    'drop' => array(
        'hover' => 'onHover',
        'drop' => 'onDrop',
        'hoverClass' => 'hoverclass',
    ),
    'slider' => array(
        'direction' => 'axis',
        'change' => 'onSlide',
        'complete' => 'onChange',
        'value' => 'sliderValue',
    )
)