Класс JsHelper

__call()source public

__call( string $method , array $params )

Разрешает вызов методов помощника двигателя. Методы в списке bufferedMethods двигателя будут автоматически буферизованы. Вы можете управлять буферизацией с помощью параметра буфера также. Установив последний параметр любого метода двигателя в булево значение, вы можете принудительно включить или отключить буферизацию.

Например: $js->get('#foo')->effect('fadeIn', array('speed' => 'slow'), true);

Принудительно включит буферизацию для метода effect. Если метод принимает массив параметров, вы также можете добавить параметр 'buffer' в массив параметров и управлять буферизацией там также.

Например: $js->get('#foo')->event('click', $functionContents, array('buffer' => true));

Параметр buffer не будет передан в EngineHelper.

Параметры

строка $method

Метод, который будет вызван

массив $params

Параметры для вызываемого метода.

Возвращает

смешанное
Зависит от результата вызова метода или это может быть экземпляр EngineHelper

__construct()source public

__construct( View $View , string|array $settings array() )

Конструктор - определяет помощника движка

Параметры

View $View

объект представления, к которому прикреплен помощник.

строка|массив $settings необязательно массив()

Массив настроек содержит имя помощника движка.

_createVars()source protected

_createVars( )

Генерирует строку объекта для переменных, передаваемых в javascript, и добавляет ее в буфер

_getHtmlOptions()source protected

_getHtmlOptions( array $options , array $additional array() )

Обработка набора параметров и извлечение параметров Html. Извлеченные параметры Html удаляются из параметра $options.

Параметры

массив $options

Параметры для фильтрации.

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

Массив дополнительных ключей для извлечения и включения в возвращаемый массив параметров.

Возвращает

массив
Массив параметров js и Htmloptions

buffer()source public

buffer( string $script , boolean $top false )

Записать скрипт в буферизованные скрипты.

Параметры

строка $script

Строка скрипта для добавления в буфер.

булево $top необязательно false

Если true, скрипт будет добавлен в начало массива буферизованных скриптов. Если false — в конец.

Ссылка

https://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::buffer

getBuffer()source public

getBuffer( boolean $clear true )

Получить все буферизованные скрипты

Параметры

булево $clear необязательно true

Очистить ли кэш скриптов (по умолчанию true)

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/en/core-libraries/helpers/js.html#JsHelper::getBuffer

link()source public

link( string $title , string|array $url null , array $options array() )

Создать ссылку 'Ajax'. Использует выбранный JS-движок для создания элемента ссылки, который улучшен с помощью Javascript. Параметры могут включать как те, что для HtmlHelper::link(), так и для JsBaseEngine::request(), JsBaseEngine::event();

Параметры

• confirm - Сгенерировать диалоговое окно подтверждения confirm() перед отправкой события.
• id - использовать пользовательский идентификатор.
• htmlAttributes - дополнительные нестандартные htmlAttributes. Стандартные атрибуты — class, id, rel, title, escape, onblur и onfocus.
• buffer - Отключить буферизацию и вернуть тег скрипта дополнительно к ссылке.

Параметры

строка $title

Текст ссылки.

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

Смешанный тип: либо строка URL, либо массив CakePHP URL.

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

Параметры как для HTML-элемента, так и для Js::request()

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

строка
Завершенная ссылка. Если буферизация отключена, возвращается также тег скрипта.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/js.html#JsHelper::link

set()source public

set( string|array $one , string|array $two null )

Передать переменные в Javascript. Позволяет задать переменные, которые будут выведены при получении буфера с помощью JsHelper::getBuffer() или JsHelper::writeBuffer() Переменная Javascript, используемая для вывода заданных переменных, может контролироваться с помощью JsHelper::$setVariable

Параметры

строка|массив $one

Массив переменных для установки или имя переменной для установки.

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

Если $one — строка, то $two — значение для этого ключа.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/js.html#JsHelper::set

submit()source public

submit( string $caption null , array $options array() )

Использует выбранный JS-движок для создания элемента ввода submit, который улучшен с помощью Javascript. Параметры могут включать как те, что для FormHelper::submit(), так и для JsBaseEngine::request(), JsBaseEngine::event();

Формы, отправляемые этим методом, не могут отправлять файлы. Файлы не передаются по XmlHttpRequest и требуют iframe или flash.

Параметры

• url Адрес, куда вы хотите отправить запрос XHR.
• confirm Строка для сообщения confirm() перед отправкой запроса.
• method Метод отправки формы, по умолчанию POST
• buffer Необходимо ли буферизовать код скрипта, по умолчанию true.
• Также см. параметры для JsHelper::request() и JsHelper::event()

Параметры

строка $caption необязательно null

Текст отображения кнопки отправки.

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

Массив параметров. См. параметры вышеупомянутых методов.

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

строка
Завершенная кнопка отправки.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/js.html#JsHelper::submit

value()source public

value( mixed $val array() , boolean $quoteString null , string $key 'value' )

Переопределение унаследованного Helper::value() Дополнительная информация об этом методе содержится в JsBaseEngineHelper::value().

Параметры

смешанный $val необязательно массив()

PHP переменная для преобразования в JSON

булево $quoteString необязательно null

Если false, значения строк не заключаются в кавычки

строка $key необязательно 'значение'

Имя ключа.

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

строка
Представление $val, безопасное для JavaScript/JSON

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/js.html#JsHelper::value

writeBuffer()source public

writeBuffer( array $options array() )

Записывает весь сгенерированный Javascript в блок кода или кеширует его в файл и возвращает ссылку на скрипт. Если не было закешированных скриптов, этот метод вернёт null. Если запрос — XHR (ajax), onDomReady будет установлен в false. Так как DOM уже «готов».

Параметры

• inline - Установить в true, чтобы скрипты выводились как inline-блок скрипта. Если cache также true, будет сгенерирован тег ссылки на скрипт. (по умолчанию true)
• cache - Установить в true, чтобы скрипты кешировались в файле и ссылались на них (по умолчанию false)
• clear - Установить в false, чтобы предотвратить очистку кэша скриптов (по умолчанию true)
• onDomReady - Установить в true, чтобы обернуть кешированные скрипты в событие domready (по умолчанию true)
• safe - Если генерируется inline-блок, следует ли его обернуть в (по умолчанию true)

Параметры

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

Параметры для блока кода

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

смешанный

Завершенный тег javascript, если есть скрипты; если нет закешированных скриптов, будет возвращен null.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/js.html#JsHelper::writeBuffer

array()

array()

true

array('Html', 'Form')

'app'