Класс MootoolsEngineHelper

domReady()source public

domReady( string $functionBody )

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

Параметры

строка $functionBody

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

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

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

drag()source public

drag( array $options array() )

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

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

Параметры

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

Массив опций для Draggable.

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

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

См. также

JsHelper::drag() для списка опций.

drop()source public

drop( array $options array() )

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

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

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

Параметры

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

Массив опций для Droppable.

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

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

См. также

JsBaseEngineHelper::drop() для списка опций.

each()source public

each( string $callback )

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

Параметры

строка $callback

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

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

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

effect()source public

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

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

Параметры

строка $name

Название эффекта, который нужно вызвать.

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

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

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

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

См. также

JsBaseEngineHelper::effect()

event()source public

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

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

Опции

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

Параметры

строка $type

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

строка $callback

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

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

Опции для события.

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

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

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 необязательно array()

Список опций.

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

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

serializeForm()source public

serializeForm( array $options array() )

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

Параметры

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

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

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

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

См. также

JsBaseEngineHelper::serializeForm()

slider()source public

slider( array $options array() )

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

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

Параметры

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

Массив опций для ползунка.

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

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

См. также

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 )

Генерирует фрагмент 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 '' )

Создаёт функцию JavaScript prompt()

Параметры

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

Имя ключа.

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

строка
Представление переменной $val, безопасное для JavaScript/JSON

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