Класс PrototypeEngineHelper

domReady()source public

domReady( string $functionBody )

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

Параметры

строка $functionBody

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

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

строка
готовый метод domReady

drag()source public

drag( array $options array() )

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

Примечание: Требуется загрузка scriptaculous.

Параметры

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

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

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

строка
Завершенный код draggable.

См. также

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

drop()source public

drop( array $options array() )

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

Примечание: Требуется загрузка scriptaculous.

Параметры

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

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

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

строка
Завершенный код droppable.

См. также

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

each()source public

each( string $callback )

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

Параметры

строка $callback

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

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

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

effect()source public

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

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

Примечание: Для эффектов требуется загрузка Scriptaculous.

Параметры

строка $name

Имя эффекта, который необходимо вызвать.

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

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

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

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

См. также

JsBaseEngineHelper::effect()

event()source public

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

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

Опции

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

Параметры

строка $type

Тип события, которое нужно привязать к текущему элементу

строка $callback

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

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

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

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

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

get()source public

get( string $selector )

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

Параметры

строка $selector

Целевой селектор

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

PrototypeEngineHelper

request()source public

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

Создаёт вызов Ajax или Ajax.Updater.

Параметры

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

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

Примечание: Требуется загрузка scriptaculous.

Параметры

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

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

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

строка
Завершенный код слайдера.

См. также

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

sortable()source public

sortable( array $options array() )

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

Примечание: Требуется загрузка scriptaculous.

Реализация сортировки в scriptaculous не поддерживает параметры 'start' и 'distance'.

Параметры

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

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

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

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

См. также

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

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

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

Сообщение для использования в диалоговом окне подтверждения.

Возвращает

строка
Завершенное подтверждение с возвращаемым скриптом

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

Создаёт функцию 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

array(
    'slider' => array(
        'onSlide' => 'value',
        'onChange' => 'value',
    ),
    'drag' => array(
        'onStart' => 'event',
        'onDrag' => 'event',
        'change' => 'draggable',
        'onEnd' => 'event',
    ),
    'drop' => array(
        'onHover' => 'draggable, droppable, event',
        'onDrop' => 'draggable, droppable, event',
    ),
    'request' => array(
        'onCreate' => 'transport',
        'onComplete' => 'transport',
        'onFailure' => 'response, jsonHeader',
        'onRequest' => 'transport',
        'onSuccess' => 'response, jsonHeader'
    ),
    'sortable' => array(
        'onStart' => 'element',
        'onChange' => 'element',
        'onUpdate' => 'element',
    ),
)

false

array(
    'request' => array(
        'async' => 'asynchronous',
        'data' => 'parameters',
        'before' => 'onCreate',
        'success' => 'onSuccess',
        'complete' => 'onComplete',
        'error' => 'onFailure'
    ),
    'sortable' => array(
        'sort' => 'onChange',
        'complete' => 'onUpdate',
    ),
    'drag' => array(
        'snapGrid' => 'snap',
        'container' => 'constraint',
        'stop' => 'onEnd',
        'start' => 'onStart',
        'drag' => 'onDrag',
    ),
    'drop' => array(
        'hover' => 'onHover',
        'drop' => 'onDrop',
        'hoverClass' => 'hoverclass',
    ),
    'slider' => array(
        'direction' => 'axis',
        'change' => 'onSlide',
        'complete' => 'onChange',
        'value' => 'sliderValue',
    )
)