Класс JsBaseEngineHelper

JsEngineBaseClass

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

AppHelper

JsBaseEngineHelper

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

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

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

$_callbackArguments protected

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

array

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

array

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

string
JS-фрагмент для текущего выделения.

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

_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) из массива. Будет использовать метод кодирования JSON из стандартной библиотеки, если доступен и $useNative == true
prompt() public
Создаёт prompt() функцию JavaScript
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 )

Сгенерировать фрагмент подтверждения, который возвращает 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 - Скорость анимации. Допустимые значения 'slow', 'fast'. Не все эффекты используют параметр скорости.

Параметры

строка $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: Сообщение, которое нужно отобразить в диалоговом окне.
строка $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–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-JsBaseEngineHelper.html