Класс MootoolsEngineHelper
Помощник MooTools Engine для JsHelper
Предоставляет JavaScript, специфичный для MooTools, для JsHelper. Предполагается, что у вас есть следующие пакеты MooTools:
- Remote, Remote.HTML, Remote.JSON
- Fx, Fx.Tween, Fx.Morph
- Selectors, DomReady,
- Drag, Drag.Move
- AppHelper
-
JsBaseEngineHelper
-
MootoolsEngineHelper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/MootoolsEngineHelper.php
Краткое описание свойств
-
$_callbackArgumentsprotectedСодержит список имён обратных вызовов -> аргументов по умолчанию.array -
$_optionMapprotectedСопоставления параметров для MooToolsarray
Унаследованные свойства
Краткое описание методов
- domReady() publicСоздаёт событие domReady. Это специальное событие во многих библиотеках
- drag() publicСоздаёт элемент Draggable.
- drop() publicСоздаёт элемент Droppable.
- each() publicСоздаёт итерацию по текущим результатам выбора.
- effect() publicВызывает эффект.
- event() publicДобавляет событие в кэш скрипта. Операции выполняются с текущими выбранными элементами.
- get() publicСоздаёт JavaScript-селектор для CSS-правила
- request() publicСоздаёт новый Request.
- serializeForm() publicСериализует форму, присоединённую к $selector.
- slider() publicСоздаёт контрол слайдера
- sortable() publicСоздаёт сортируемый элемент.
Подробное описание методов
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 - Селектор, который нацелен
Возвращает
MootoolsEngineHelperrequest()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() для списка опций.Методы, унаследованные от JsBaseEngineHelper
_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 в формате JSON из массива. Использует метод native 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' - Имя ключа.
Возвращаемое значение
строкаJavaScript-безопасная/JSON-представление $val
Подробное описание свойств
$_callbackArgumentssource
protected массив
Содержит список имён обратных вызовов -> аргументов по умолчанию.
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',
)
) $_optionMapsource
protected массив
Сопоставления параметров для MooTools.
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'
)
)
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-MootoolsEngineHelper.html