Spec-Zone.ru › CakePHP 2.9

Класс JqueryEngineHelper

Помощник движка jQuery для JsHelper

Предоставляет JavaScript, специфичный для jQuery, для JsHelper.

Реализует интерфейс JsHelper для jQuery. Все массивы $options поддерживают все опции, найденные в JsHelper, а также те, которые есть в документации jQuery.

AppHelper
Extended by JsBaseEngineHelper
Extended by JqueryEngineHelper
Пакет: Cake\View\Helper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/JqueryEngineHelper.php

Краткое описание свойств

  • $_callbackArguments protected
    string
    Списки аргументов обратного вызова
  • $_optionMap protected
    array
    Сопоставления опций для jQuery
  • $jQueryObject public
    string

    Имя переменной объекта jQuery, полезно, когда jQuery находится в режиме noConflict().

Унаследованные свойства

  • bufferedMethods, selection

Краткое описание методов

  • _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() )

Вспомогательная функция для обертывания повторяющихся простых шаблонов методов.

Параметры

string $method
Имя генерируемого метода.
string $template
Шаблон метода
array $options
Массив опций для метода
array $extraSafeKeys optional array()
Дополнительные безопасные ключи

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

string
Строка составленного метода

domReady()source public

domReady( string $functionBody )

Создаёт событие domReady. Для jQuery. Этот метод не привязывает 'традиционное событие' как $(document).bind('ready', fn) Работает совершенно иначе, чем $(document).ready() Первый не выполнит функцию при eval() как часть ответа, второй выполнит. Из-за того, как выполняется AJAX-пагинация, используется $().ready().

Параметры

string $functionBody
Код для выполнения при domReady

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

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

drag()source public

drag( array $options array() )

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

Требуется загрузка Ui.Core и Ui.Draggable.

Параметры

array $options optional array()
Массив опций для элемента draggable.

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

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

См. также

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

drop()source public

drop( array $options array() )

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

Требуется загрузка Ui.Core и Ui.Droppable.

Параметры

array $options optional array()
Массив опций для элемента droppable.

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

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

См. также

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

each()source public

each( string $callback )

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

Параметры

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

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

string
Завершенная итерация

effect()source public

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

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

Параметры

string $name
Название эффекта для вызова.
array $options optional array()
Массив опций для эффекта.

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

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

См. также

JsBaseEngineHelper::effect()

event()source public

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

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

Опции

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

Параметры

string $type
Тип события для привязки к текущему идентификатору DOM
string $callback
Функция JavaScript, которую вы хотите вызвать или функция-литерал
array $options optional array()
Опции для события.

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

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

get()source public

get( string $selector )

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

Параметры

string $selector
Нацеленный селектор

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

JqueryEngineHelper

request()source public

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

Создаёт вызов $.ajax().

Если ключ 'update' задан, обратный вызов успеха будет переопределён.

Параметры

string|array $url
URL
array $options optional array()
См. JsHelper::request() для опций.

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

string
Завершенный вызов ajax.

См. также

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

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

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

Параметры

массив $options
Параметры для преобразования
массив $safeKeys необязательно array()
Ключи, которые не должны быть экранированы.

Возвращает

строка
Обработанные JSON-параметры без заключительных { }.

_prepareCallbacks()source protected

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

Подготавливает обратные вызовы и оборачивает их функцией ([args]), как определено в массиве _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 )

Сгенерируйте сообщение 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) из массива. Использует метод native 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–2016 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.9/class-JqueryEngineHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API