Класс JqueryEngineHelper
Помощник jQuery-движка для JsHelper
Предоставляет JavaScript, специфичный для jQuery, для JsHelper.
Реализует интерфейс JsHelper для jQuery. Все массивы $options поддерживают все параметры, найденные в JsHelper, а также те, что указаны в документации jQuery.
- AppHelper
-
JsBaseEngineHelper
-
JqueryEngineHelper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/JqueryEngineHelper.php
Резюме свойств
-
$_callbackArgumentsprotectedСписки аргументов обратного вызоваstring -
$_optionMapprotectedСопоставления параметров для jQueryarray -
$jQueryObjectpublicstringИмя переменной объекта jQuery, полезно, когда jQuery находится в режиме noConflict().
Унаследованные свойства
Резюме методов
- _methodTemplate() protectedВспомогательная функция для обертывания повторяющихся простых шаблонов методов.
- domReady() public
Создает событие domReady. Для jQuery. Этот метод не привязывает 'традиционное событие', так как
$(document).bind('ready', fn)Работает совершенно иначе, чем$(document).ready()Первый не выполнит функцию при eval() в ответ, второй выполнит. Из-за того, как выполняется AJAX-странирование, используется$().ready(). - drag() publicСоздает элемент Draggable
- drop() publicСоздает элемент Droppable
- each() publicСоздает итерацию по результатам текущего выбора.
- effect() publicВызывает эффект.
- event() publicДобавляет событие в кэш скриптов. Действует на выбранные в данный момент элементы.
- get() publicСоздает селектор JavaScript для CSS-правила
- request() publicСоздает вызов $.ajax().
- serializeForm() public
Сериализует форму, прикрепленную к $selector. Если текущий выбор не является элементом ввода или формой, будут созданы ошибки в JavaScript.
- slider() publicСоздает элемент Slider
- sortable() publicСоздаёт сортируемый элемент.
Подробное описание методов
_methodTemplate()source protected
_methodTemplate( string $method , string $template , array $options , array $extraSafeKeys array() )
Вспомогательная функция для обертывания повторяющихся простых шаблонов методов.
Параметры
- строка
$method - Название генерируемого метода.
- строка
$template - Шаблон метода
- массив
$options - Массив параметров для метода
- массив
$extraSafeKeysопционально массив() - Дополнительные безопасные ключи
Возвращает
строкаСтрока с составленным методом
domReady()source public
domReady( string $functionBody )
Создает событие domReady. Для jQuery. Этот метод не привязывает 'традиционное событие', так как $(document).bind('ready', fn) Работает совершенно иначе, чем $(document).ready() Первый не выполнит функцию при eval() в ответ, второй выполнит. Из-за того, как выполняется AJAX-странирование, используется $().ready().
Параметры
- строка
$functionBody - Код, который нужно выполнить при domReady
Возвращает
строкаЗавершенный метод domReady
drag()source public
drag( array $options array() )
Создает элемент Draggable
Требуется загрузка Ui.Core и Ui.Draggable.
Параметры
- массив
$optionsопционально массив() - Массив параметров для элемента draggable.
Возвращает
строкаЗавершенный скрипт Draggable.
См. также
JsBaseEngineHelper::drag() для списка параметров.drop()source public
drop( array $options array() )
Создает элемент Droppable
Требуется загрузка Ui.Core и Ui.Droppable.
Параметры
- массив
$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 - Целевой селектор
Возвращает
JqueryEngineHelperrequest()source public
request( string|array $url , array $options array() )
Создает вызов $.ajax().
Если ключ 'update' задан, обратный вызов при успехе будет переопределён.
Параметры
- строка|массив
$url - URL
- массив
$optionsопционально массив() - См. JsHelper::request() для параметров.
Возвращает
строкаЗавершенный вызов ajax.
См. также
JsBaseEngineHelper::request() для списка параметров.serializeForm()source public
serializeForm( array $options array() )
Сериализуйте форму, прикреплённую к $selector. Если текущий выбор не является элементом ввода или формой, в JavaScript будут созданы ошибки.
Параметры
- массив
$optionsнеобязательный array() - Параметры для сериализации
Возвращает
строказавершенный скрипт сериализации формы.
См. также
JsBaseEngineHelper::serializeForm() для списка параметров.slider()source public
slider( array $options array() )
Создайте элемент слайдера.
Требуется загрузка Ui.Core и Ui.Slider.
Параметры
- массив
$optionsнеобязательный array() - Массив параметров для элемента слайдера.
Возвращает
строкаЗавершенный скрипт слайдера.
См. также
JsBaseEngineHelper::slider() для списка параметров.sortable()source public
sortable( array $options array() )
Создайте сортируемый элемент.
Требуется загрузка Ui.Core и Ui.Sortables.
Параметры
- массив
$optionsнеобязательный array() - Массив параметров для сортируемого элемента.
Возвращает
строкаЗавершенный скрипт сортируемого элемента.
См. также
JsBaseEngineHelper::sortable() для списка параметров.Методы, унаследованные от JsBaseEngineHelper
_mapOptions()source protected
_mapOptions( string $method , array $options )
Преобразует параметры из абстрактного формата в формат, специфичный для движка. Если атрибуты отсутствуют в отображении, они не изменяются.
Параметры
- строка
$method - Имя метода, параметры которого обрабатываются.
- массив
$options - Массив параметров для преобразования.
Возвращает
массивМассив преобразованных параметров.
_parseOptions()source protected
_parseOptions( array $options , array $safeKeys array() )
Анализирует массив параметров типа ассоциативный массив в строковый литерал JavaScript. Аналогично object(), но любые нецелочисленные значения обрабатываются как строки, не включает { }.
Параметры
- массив
$options - Параметры для преобразования
- массив
$safeKeysнеобязательный array() - Ключи, которые не должны быть экранированы.
Возвращает
строкаОбработанные параметры JSON без заключительных { }.
_prepareCallbacks()source protected
_prepareCallbacks( string $method , array $options , array $callbacks array() )
Подготавливает обратные вызовы и оборачивает их функцией ([аргументы]) { }, как определено в массиве _callbackArgs.
Параметры
- строка
$method - Имя метода, для которого подготавливаются обратные вызовы.
- массив
$options - Массив обрабатываемых параметров.
- массив
$callbacksнеобязательный array() - Дополнительные ключи, содержащие обратные вызовы.
Возвращает
массивМассив параметров с добавленными обратными вызовами.
_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) из массива. Использует встроенный метод JSON encode, если он доступен, и $useNative == true.
Параметры:
-
prefix- Строка, добавляемая перед возвращаемыми данными. -
postfix- Строка, добавляемая после возвращаемых данных.
Параметры
- массив
$dataнеобязательный array() - Данные для преобразования.
- массив
$optionsнеобязательный array() - Набор параметров, см. выше.
Возвращает
строкаБлок кода 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.
Параметры
- mixed
$valнеобязательно array() - Переменная PHP, подлежащая преобразованию в JSON
- boolean
$quoteStringнеобязательно null - Если false, строковые значения остаются без кавычек
- string
$keyнеобязательно 'value' - Имя ключа.
Возвращает
stringБезопасное для JavaScript/JSON представление $val
Подробное описание свойств
$_callbackArgumentssource
protected string
Списки аргументов обратного вызова
array(
'slider' => array(
'start' => 'event, ui',
'slide' => 'event, ui',
'change' => 'event, ui',
'stop' => 'event, ui'
),
'sortable' => array(
'start' => 'event, ui',
'sort' => 'event, ui',
'change' => 'event, ui',
'beforeStop' => 'event, ui',
'stop' => 'event, ui',
'update' => 'event, ui',
'receive' => 'event, ui',
'remove' => 'event, ui',
'over' => 'event, ui',
'out' => 'event, ui',
'activate' => 'event, ui',
'deactivate' => 'event, ui'
),
'drag' => array(
'start' => 'event, ui',
'drag' => 'event, ui',
'stop' => 'event, ui',
),
'drop' => array(
'activate' => 'event, ui',
'deactivate' => 'event, ui',
'over' => 'event, ui',
'out' => 'event, ui',
'drop' => 'event, ui'
),
'request' => array(
'beforeSend' => 'XMLHttpRequest',
'error' => 'XMLHttpRequest, textStatus, errorThrown',
'success' => 'data, textStatus',
'complete' => 'XMLHttpRequest, textStatus',
'xhr' => ''
)
) $_optionMapsource
protected array
Сопоставления опций для jQuery
array(
'request' => array(
'type' => 'dataType',
'before' => 'beforeSend',
'method' => 'type',
),
'sortable' => array(
'complete' => 'stop',
),
'drag' => array(
'snapGrid' => 'grid',
'container' => 'containment',
),
'drop' => array(
'leave' => 'out',
'hover' => 'over'
),
'slider' => array(
'complete' => 'stop',
'direction' => 'orientation'
)
) $jQueryObjectsource
public string
Имя переменной объекта jQuery, полезно, когда jQuery используется в режиме noConflict().
'$'
© 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-JqueryEngineHelper.html