Класс MootoolsEngineHelper

domReady()source public

domReady( string $functionBody )

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

Параметры

строка $functionBody

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

Возвращает

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

drag()source public

drag( array $options array() )

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

Требует плагин Drag из MootoolsMore

Параметры

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

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

Возвращает

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

См.

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

drop()source public

drop( array $options array() )

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

Требует плагины Drag и Drag.Move из MootoolsMore

Droppable в Mootools работают иначе, чем в других библиотеках. Droppables реализованы как расширение Drag. Поэтому помимо выбора элемента droppable с помощью get(), необходимо также указать селектор для элемента draggable. Кроме того, Mootools droppables наследуют все параметры от Drag.

Параметры

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

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

Возвращает

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

См.

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

each()source public

each( string $callback )

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

Параметры

строка $callback

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

Возвращает

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

effect()source public

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

Вызывает эффект.

Параметры

строка $name

Имя вызываемого эффекта.

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

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

Возвращает

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

См.

JsBaseEngineHelper::effect()

event()source public

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

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

Параметры

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

Параметры

строка $type

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

строка $callback

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

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

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

Возвращает

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

get()source public

get( string $selector )

Создаёт javascript селектор для правила CSS

Параметры

строка $selector

Целевое селекторное правило

Возвращает

MootoolsEngineHelper

request()source public

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

Создаёт новый запрос.

Требует Request. Если вы хотите использовать ключ 'update', вам понадобится Request.HTML. Если вы хотите выполнить Json-запрос, вам потребуется JSON и Request.JSON.

Параметры

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

URL

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

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

Возвращает

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

serializeForm()source public

serializeForm( array $options array() )

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

Параметры

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

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

Возвращает

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

См.

JsBaseEngineHelper::serializeForm()

slider()source public

slider( array $options array() )

Создать элемент управления ползунком

Требуется Slider из MootoolsMore

Параметры

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

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

Возвращает

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

См. также

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

sortable()source public

sortable( array $options array() )

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

Требуется плагин Sortables из MootoolsMore

Параметры

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

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

Возвращает

строка
Готовый скрипт сортируемого элемента.

См. также

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

_mapOptions()source protected

_mapOptions( string $method , array $options )

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

Параметры

строка $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 )

Генерирует фрагмент подтверждения, возвращающий 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) из массива. Использует метод native 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/JSON представление $val

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

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

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

Параметры

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

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

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

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

строка $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 optional array()

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

Возвращает

строка
Сгенерированный 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 optional null

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

строка $id optional '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 )

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

Параметры

строка $entity

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

булево $setScope optional false

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

url()source public

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

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

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

Параметры

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

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

булево $full optional 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

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

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

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().

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

булево
Успех записи в журнал

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, а также именованных/переданных аргументов.

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

смешанное

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

toString()source public

toString( )

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

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

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

array(
    'slider' => array(
        'onTick' => 'position',
        'onChange' => 'step',
        'onComplete' => 'event'
    ),
    'request' => array(
        'onRequest' => '',
        'onComplete' => '',
        'onCancel' => '',
        'onSuccess' => 'responseText, responseXML',
        'onFailure' => 'xhr',
        'onException' => 'headerName, value',
    ),
    'drag' => array(
        'onBeforeStart' => 'element',
        'onStart' => 'element',
        'onSnap' => 'element',
        'onDrag' => 'element, event',
        'onComplete' => 'element, event',
        'onCancel' => 'element',
    ),
    'drop' => array(
        'onBeforeStart' => 'element',
        'onStart' => 'element',
        'onSnap' => 'element',
        'onDrag' => 'element, event',
        'onComplete' => 'element, event',
        'onCancel' => 'element',
        'onDrop' => 'element, droppable, event',
        'onLeave' => 'element, droppable',
        'onEnter' => 'element, droppable',
    ),
    'sortable' => array(
        'onStart' => 'element, clone',
        'onSort' => 'element, clone',
        'onComplete' => 'element',
    )
)

array(
    'request' => array(
        'complete' => 'onComplete',
        'success' => 'onSuccess',
        'before' => 'onRequest',
        'error' => 'onFailure'
    ),
    'sortable' => array(
        'distance' => 'snap',
        'containment' => 'constrain',
        'sort' => 'onSort',
        'complete' => 'onComplete',
        'start' => 'onStart',
    ),
    'drag' => array(
        'snapGrid' => 'snap',
        'start' => 'onStart',
        'drag' => 'onDrag',
        'stop' => 'onComplete',
    ),
    'drop' => array(
        'drop' => 'onDrop',
        'hover' => 'onEnter',
        'leave' => 'onLeave',
    ),
    'slider' => array(
        'complete' => 'onComplete',
        'change' => 'onChange',
        'direction' => 'mode',
        'step' => 'steps'
    )
)