Класс 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-фрагмент для текущего выделения.

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

_View, _association, _attributeFormat, _cleaned, _entityPath, _fieldSuffixes, _helperMap, _minimizedAttributeFormat, _minimizedAttributes, _modelScope, _tainted, fieldset, helpers, plugin, request, settings, tags, theme

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

_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

Генерирует фрагмент confirm, возвращающий 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

Создаёт виджет ползунка. Состоит из дорожки и ползунка. Дополнительные параметры могут поддерживаться реализацией библиотеки.
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 optional array(): Ключи, которые не должны быть экранированы.

Возвращает

строка
Преобразованные параметры JSON без окружающих { }.

_prepareCallbacks()source protected

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

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

Параметры

строка $method: Имя метода, для которого готовятся обратные вызовы.
массив $options: Массив параметров, которые парсятся
массив $callbacks optional array(): Дополнительные ключи, содержащие обратные вызовы

Возвращает

массив
Массив параметров с добавленными обратными вызовами.

END_OF_DOCUMENT_MARKER

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

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 optional array(): Массив опций, см. выше.

Возвращает

строка
Готовый скрипт перетаскивания

drop()source abstract public

drop( array $options array() )

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

Опции

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

Опции событий

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

Параметры

массив $options optional array(): Массив опций для падения. См. выше.

Возвращает

строка
Готовый скрипт падения

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 optional array(): Массив опций для эффекта.

Возвращает

строка
Готовая строка с эффектом.

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: Тип события, которое нужно привязать к текущему id элемента
строка $callback: JavaScript-функция, которую нужно вызвать, или литерал функции
массив $options optional array(): Опции для события.

Возвращает

строка
Готовый обработчик события

get()source abstract public

get( string $selector )

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

Параметры

строка $selector: Селектор, на который нацелен запрос

Возвращает

JsBaseEngineHelper
Экземпляр $this. Позволяет использовать цепочку методов.

object()source public

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

Генерирует JavaScript-объект в формате JSON из массива. Использует встроенный метод JSON encode, если он доступен и $useNative == true

Опции:

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

Параметры

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

Возвращает

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

END_OF_DOCUMENT_MARKER

prompt()source public

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

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

Параметры

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

Возвращает

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

redirect()source public

redirect( string|array $url null )

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

Параметры

строка|массив $url необязательно null: URL

Возвращает

строку
завершённое перенаправление в 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.
http://api.cakephp.org/2.8/class-JsBaseEngineHelper.html