Класс JsBaseEngineHelper

JsEngineBaseClass

Абстрактный базовый класс для всех JsEngines для расширения. Предоставляет общие методы.

AppHelper

JsBaseEngineHelper

Прямые подклассы

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

Резюме свойств

$_callbackArguments protected

array
Содержит список имён обратных вызовов -> аргументов по умолчанию.
$_optionMap protected

array

Коллекция карт опций. Карты опций позволяют другим помощникам использовать общие имена для обратных вызовов движка и опций. Обеспечивает единообразный доступ к коду для всех типов движков. Хотя их использование необязательно для конечных пользователей.
$bufferedMethods public

array

Массив имён методов с нижним регистром в движке, которые буферизуются, если не отключены иначе. Это позволяет определённым методам «точки назначения» автоматически буферизоваться помощником JsHelper.
$selection public

string
Фрагмент JavaScript для текущего выделения.

Резюме методов

_mapOptions() protected

Преобразует абстрактные опции в специфичные для движка имена опций. Если атрибуты отсутствуют в карте, они не изменяются.
_parseOptions() protected

Парсит массив ассоциаций опций в литерал объекта JavaScript. Аналогично object(), но обрабатывает любые значения, не являющиеся целыми числами, как строки, не включает { }
_prepareCallbacks() protected

Подготавливает обратные вызовы и оборачивает их функцией ([args]) { }, как определено в массиве _callbackArgs.
_processOptions() protected

Удобный оберточный метод для всех общих шагов обработки опций. Выполняет _mapOptions, _prepareCallbacks и _parseOptions в заданном порядке.
_toQuerystring() protected
Преобразует массив данных в строку запроса
_utf8ToHex() protected
Кодирует строку в JSON. Преобразует и экранирует необходимые символы.
alert() public
Создаёт сообщение alert() в JavaScript
confirm() public
Создаёт сообщение confirm()
confirmReturn() public

Генерирует фрагмент подтверждения, возвращающий false из текущего контекста функции.
domReady() abstract public
Создаёт событие domReady. Это специальное событие во многих библиотеках
drag() abstract public

Создаёт перетаскиваемый элемент. Работает с текущим выбранным элементом. Дополнительные опции могут поддерживаться реализацией библиотеки.
drop() abstract public

Создаёт элемент, принимающий падение. Позволяет перетаскиваемым элементам падать на него. Дополнительные опции могут поддерживаться реализацией библиотеки.
each() abstract public
Создаёт итерацию по результатам текущего выбора.
effect() abstract public
Вызывает эффект.
escape() public
Экранирует строку для дружественности к JSON.
event() abstract public
Добавляет событие к кэшу скрипта. Операции проводятся над текущими выбранными элементами.
get() abstract public
Создаёт селектор JavaScript для CSS правила
object() public

Генерирует объект JavaScript в формате JavaScript Object Notation (JSON) из массива. Будет использовать метод native JSON encode, если он доступен, и $useNative == true
prompt() public
Создаёт функцию JavaScript prompt()
redirect() public

Перенаправляет на URL. Создаёт фрагмент кода, изменяющего window.location, который можно использовать для запуска «перенаправлений» из JavaScript.
request() abstract public
Выполняет запрос XHR
serializeForm() abstract public

Сериализует форму, прикреплённую к $selector. Передайте true для $isForm, если текущий выбор — элемент формы. Преобразует форму или элемент формы, прикреплённый к текущему выбору, в строку/объект JSON (в зависимости от реализации библиотеки) для использования с операциями XHR.
slider() abstract public

Создаёт виджет UI ползунка. Состоит из дорожки и ползунка. Дополнительные опции могут поддерживаться реализацией библиотеки.
sortable() abstract public

Создаёт сортируемый элемент. Дополнительные опции могут поддерживаться реализацией библиотеки.
value() public
Преобразует PHP-переменную любого типа в эквивалентное JSON представление

Подробное описание методов

_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: Массив опций для обработки.

Возвращает

строка
Строка обработанных опций.

END_OF_DOCUMENT_MARKER

_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 с возвращаемым скриптом

domReady()source abstract public

domReady( string $functionBody )

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

Параметры

строка $functionBody: Код, который нужно выполнить при domReady

Возвращает

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

drag()source abstract public

drag( array $options array() )

Создать перетаскиваемый элемент. Работает с текущим выбранным элементом. Дополнительные параметры могут поддерживаться реализацией библиотеки.

Параметры

handle - селектор элемента-кнопки.
snapGrid - пиксельная сетка, к которой привязывается перемещение, массив (x, y)
container - элемент, который действует как ограничительная рамка для перетаскиваемого элемента.

Параметры событий

start - событие, срабатывающее при начале перетаскивания
drag - событие, срабатывающее на каждой стадии перетаскивания
stop - событие, срабатывающее при остановке перетаскивания (отпускание мыши)

Параметры

массив $options необязательно массив(): Массив параметров, см. выше.

Возвращает

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

drop()source abstract public

drop( array $options array() )

Создать элемент-приемник. Позволяет перетаскивать элементы на него. Дополнительные параметры могут поддерживаться реализацией библиотеки.

Параметры

accept - селектор элементов, которые этот приемник будет принимать.
hoverclass - класс, добавляемый к приемнику, когда перетаскиваемый элемент находится над ним.

Параметры событий

drop - событие, срабатывающее при падении элемента в зону приема.
hover - событие, срабатывающее при входе перетаскиваемого элемента в зону приема.
leave - событие, срабатывающее при удалении перетаскиваемого элемента из зоны приема без его отпускания.

Параметры

массив $options необязательно массив(): Массив параметров для приема. См. выше.

Возвращает

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

each()source abstract public

each( string $callback )

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

Параметры

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

Возвращает

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

effect()source abstract public

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

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

Поддерживаемые эффекты

Следующие эффекты поддерживаются всеми ядрами JsEngines

show - отобразить элемент.
hide - скрыть элемент.
fadeIn - плавно показать элемент.
fadeOut - плавно скрыть элемент.
slideIn - плавно скользить элемент внутрь.
slideOut - плавно скользить элемент наружу.

Параметры

speed - Скорость анимации. Допустимые значения: 'медленно', 'быстро'. Не все эффекты используют параметр скорости.

Параметры

строка $name: Название эффекта, который нужно вызвать.
массив $options необязательно массив(): Массив параметров для эффекта.

Возвращает

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

escape()source public

escape( string $string )

Экранировать строку для работы с JSON.

Список экранированных элементов:

"\r" => '\n'
"\n" => '\n'
'"' => '\"'

Параметры

строка $string: Строка, которую нужно экранировать.

Возвращает

строку
Экранированная строка.

event()source abstract public

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

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

Параметры

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

Параметры

строка $type: Тип события, который нужно привязать к текущему идентификатору DOM
строка $callback: JavaScript-функция, которую нужно запустить, или литерал функции
массив $options необязательно массив(): Параметры события.

Возвращает

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

get()source abstract public

get( string $selector )

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

Параметры

строка $selector: Целевый селектор

Возвращает

JsBaseEngineHelper
экземпляр $this. Позволяет цепочку методов.

object()source public

object( array $data array() , array $options array() )

Генерирует JavaScript-объект в формате JavaScript Object Notation (JSON) из массива. Будет использовать метод native JSON encode, если он доступен и $useNative == true

Параметры:

prefix - строка, добавляемая в начало возвращаемых данных.
postfix - строка, добавляемая в конец возвращаемых данных.

Параметры

массив $data необязательно массив(): Данные для преобразования.
массив $options необязательно массив(): Набор параметров, см. выше.

Возвращает

строку
Блок кода JSON

prompt()source public

prompt( string $message , string $default '' )

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

Параметры

строка $message: Сообщение, которое нужно отобразить в окне prompt.
строка $default необязательно '': Значение по умолчанию

Возвращает

строку
завершенный prompt()

END_OF_DOCUMENT_MARKER

redirect()source public

redirect( string|array $url null )

Перенаправляет на URL. Создаёт фрагмент кода для изменения window.location, который можно использовать для триггера «перенаправлений» из JavaScript.

Параметры

string|array $url необязательно null: URL

Возвращает

string
завершенное перенаправление в javascript

request()source abstract public

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

Выполнить запрос XHR

Параметры событий

complete - Обратный вызов для срабатывания при завершении.
success - Обратный вызов для срабатывания при успехе.
before - Обратный вызов для срабатывания при инициализации запроса.
error - Обратный вызов для срабатывания при ошибке запроса.

Опции

method - Метод для выполнения запроса, по умолчанию GET во многих библиотеках
async - Требуется ли асинхронный запрос.
data - Дополнительные данные для отправки.
update - ID DOM-элемента для обновления содержимым запроса.
type - Тип данных ответа. Поддерживаются 'json' и 'html'. По умолчанию 'html' во многих библиотеках.
evalScripts -

Подписаться на @CakePHP

© 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-JsBaseEngineHelper.html