Класс JsHelper

__call()source public

__call( string $method , array $params )

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

Например: $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

Переопределяет

Helper::__call()

__construct()source public

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

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

Параметры

View $View

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

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

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

Переопределяет

Helper::__construct()

_createVars()source protected

_createVars( )

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

_getHtmlOptions()source protected

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

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

Параметры

массив $options

Опции для фильтрации.

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

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

Возвращает

массив
Массив js опций и Htmloption

buffer()source public

buffer( string $script , boolean $top false )

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

Параметры

строка $script

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

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

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

Ссылка

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

getBuffer()source public

getBuffer( boolean $clear true )

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

Параметры

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

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

Возвращает

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

Ссылка

http://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 - дополнительные нестандартные атрибуты html. Стандартные атрибуты: class, id, rel, title, escape, onblur и onfocus.
• buffer - Отключить буферизацию и вернуть тег script в дополнение к ссылке.

Параметры

строка $title

Заголовок ссылки.

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

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

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

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

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

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

Ссылка

http://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 — значение для этого ключа.

Ссылка

http://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 необязательно array()

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

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

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

Ссылка

http://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 необязательно array()

Переменная PHP, которая должна быть преобразована в JSON

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

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

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

Имя ключа.

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

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

Переопределяет

Helper::value()

writeBuffer()source public

writeBuffer( array $options array() )

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

Параметры

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

Параметры

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

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

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

смешанное

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

Ссылка

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

__get()source public

__get( string $name )

Ленивая загрузка helpers. Предоставляет доступ к устаревшим свойствам запроса также.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в 3.0.

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

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

смешанное
Helper или свойство, найденное в $name

__set()source public

__set( string $name , mixed $value )

Обеспечивает обратную совместимость доступа для задания значений объекту запроса.

Устарело

3.0.0 Этот метод будет удален в 3.0

Параметры

строка $name

Имя свойства, к которому осуществляется доступ.

смешанное $value

Значение для задания.

_clean()source protected

_clean( )

Удаляет вредное содержимое из вывода

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Возвращает строку, которая будет использоваться в качестве обработчика onclick для диалогов подтверждения.

Параметры

строка $message

Сообщение для отображения

строка $okCode

Код, который будет выполнен после того, как пользователь выбрал 'OK'

строка $cancelCode необязательно ''

Код, который будет выполнен после того, как пользователь выбрал 'Отмена', также выполняется, когда okCode не возвращает значение

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

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

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

строка
JS код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

строка $url

URL для кодирования.

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

строка
URL, закодированный как для URL, так и для HTML контекстов.

_formatAttribute()source protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минимизированными атрибутами, значения которых совпадают с их именем, такими как 'disabled' и 'checked'

Устарело

3.0.0 Этот метод будет перемещен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута для создания

строка $value

Значение атрибута для создания.

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

Указывает, должно ли значение быть экранировано

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

строка
Составленный атрибут.

_initInputField()source protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива html-атрибутов.

Параметры

строка $field

Имя поля для инициализации.

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

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

Возвращает

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

_name()source protected

_name( array|string $options array() , string $field null , string $key 'name' )

Возвращает имя поля ввода для текущего тега. Создает атрибут имени input, используя форматирование CakePHP data[Model][field].

Параметры

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

Если массив, должен быть массивом атрибутов, к которому нужно добавить $key. Если строка или null, будет использоваться как сущность View.

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

Имя поля.

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

Имя атрибута для установки, по умолчанию 'name'

Возвращает

смешанный тип

Если для $options был передан массив, возвращается массив с установленным $key. Если была передана строка, возвращается строка.

_parseAttributes()source protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку, разделённую пробелами, с элементами массива $options. Если ключ массива $options оказывается одним из перечисленных в Helper::$_minimizedAttributes,

и его значение — одно из:

• '1' (строка)
• 1 (целое число)
• true (логическое значение)
• 'true' (строка)

то значение будет изменено, чтобы соответствовать имени ключа. Если значение не соответствует этим трём вариантам, параметр не выводится.

'escape' — специальный параметр, который управляет преобразованием атрибутов в их html-сущности. Установите в значение false, чтобы отключить html-кодирование.

Если значение для любого ключа параметра установлено в null или false, этот параметр будет исключён из вывода.

Устаревшее

3.0.0 Этот метод будет перемещен в HtmlHelper в 3.0

Параметры

массив $options

Массив параметров.

массив $exclude необязательно null

Массив параметров, которые будут исключены, эти параметры не будут частью возвращаемого значения.

строка $insertBefore необязательно ' '

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

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

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

Возвращает

строка
Составленные атрибуты.

_reset()source protected

_reset( )

Сбрасывает переменные, используемые Helper::clean(), в null

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

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

Параметры

строка или массив $data

Массив данных или имя модели.

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

Имя поля.

Возвращает

массив

addClass()source public

addClass( array $options array() , string $class null , string $key 'class' )

Добавляет заданный класс к параметрам элемента.

Параметры

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

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

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

Имя добавляемого класса.

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

Ключ, используемый для класса.

Возвращает

массив
Массив параметров с установленным $key.

afterLayout()source public

afterLayout( string $layoutFile )

Обработчик после макета. afterLayout вызывается после отрисовки макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был отрисован.

afterRender()source public

afterRender( string $viewFile )

Обработчик после отрисовки. afterRender вызывается после отрисовки файла представления, но перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был отрисован.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

Обработчик после отрисовки файла. Вызывается после отрисовки любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

Содержимое, которое было отрисовано.

assetTimestamp()source public

assetTimestamp( string $path )

Добавляет метку времени к файлу-ресурсу, основываясь на значении Asset.timestamp в Configure. Если Asset.timestamp — true и debug > 0, или Asset.timestamp === 'force', метка времени будет добавлена.

Параметры

строка $path

Путь к файлу для добавления метки времени, путь должен находиться внутри WWW_ROOT

Возвращает

строка
Путь с добавленной меткой времени или без.

assetUrl()source public

assetUrl( string|array $path , array $options array() )

Генерирует URL для данного файла ресурса. В зависимости от переданных параметров предоставляет полный URL с доменным именем. Также вызывает Helper::assetTimestamp() для добавления метки времени к локальным файлам.

Параметры

строка или массив $path

Строка пути или массив URL.

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

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Ложное значение предотвратит обработку пути как плагина

Возвращает

строка
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

Обработчик перед макетом. beforeLayout вызывается перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который будет отрисован.

beforeRender()source public

beforeRender( string $viewFile )

Обработчик перед отрисовкой. beforeRender вызывается перед отрисовкой файла представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который будет отрисован.

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Обработчик перед отрисовкой файла. Вызывается перед отрисовкой любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который будет отрисован.

clean()source public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако не гарантирует удаление всех возможностей. Лучшим способом предотвращения всех возможных атак является экранирование содержимого.

Устаревшее

3.0.0 Этот метод будет удалён в версии 3.0

Параметры

строка или массив $output

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

строка или массив или null
Очищенное содержимое для вывода

domId()source public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора атрибута в формате CamelCase.

Параметры

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

Либо массив HTML-атрибутов, в который нужно добавить $id, либо строка с путём к сущности представления для получения domId.

строка $id необязательно 'id'

Имя атрибута 'id'.

Возвращает

смешанный тип

Если $options был массивом, будет возвращён массив с установленным $id. Если была передана строка, будет возвращена строка.

entity()source public

entity( )

Возвращает ссылку на сущность текущего контекста в виде массива частей идентификатора.

Возвращает

массив
Массив, содержащий элементы идентификации сущности

field()source public

field( )

Получает поле модели, используемое в текущем контексте рендеринга. Удаляет суффиксы полей, такие как year, month, day, hour, min, meridian, когда текущая сущность содержит более 2 элементов.

Возвращает

строка

model()source public

model( )

Получает модель, используемую в текущем контексте рендеринга.

Возвращает

строка

output()source public

output( string $str )

Возвращает строку, сгенерированную методом помощника.

Этот метод можно переопределить в подклассах для выполнения обобщённой обработки вывода после рендеринга.

Устаревшая функция

3.0.0 Этот метод будет удален в будущих версиях.

Параметры

строка $str

Строка для вывода.

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника на значение в паре «ключ-значение» в $entity, разделённых точками.

Параметры

строка $entity

Имя поля, например, «ModelName.fieldName» или «ModelName.ID.fieldName»

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

Устанавливает область видимости представления для модели, указанной в $tagValue

url()source public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

Возвращает URL, указывающий на предоставленные параметры.

Параметры

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

Либо относительный URL-адрес, например, /products/view/23, либо массив параметров URL-адреса. Использование массива для URL позволит использовать возможности обратного маршрутизирования CakePHP.

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

Если true, полный базовый URL будет добавлен к результату

Возвращает

строка
Полный переведённый URL с базовым путём.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

webroot()source public

webroot( string $file )

Проверяет существование файла при использовании темы; если файл не найден, возвращает путь по умолчанию.

Параметры

строка $file

Файл, для которого необходимо получить путь webroot.

Возвращает

строка
Путь к файлу, доступному через веб.

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойство $property этого объекта со свойством в определении $class. Значение свойства этого класса будет объединено поверх $class’.

Это обеспечивает некоторую DRY-магию CakePHP. Если вы хотите её отключить, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с ним.

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

Установите в значение true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будут установлены только свойства, которые являются частью объявления класса.

Параметры

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

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего сценария. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет ОО-обёртку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

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

Список параметров для использования при вызове $method

Возвращает

смешанный тип
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. См. CakeLog::write() для получения дополнительной информации о записи в журналы.

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создаётся сообщение журнала. См. CakeLog::config() для получения дополнительной информации о журналах.

Возвращает

булево
Успех записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

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

Внутри метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вам следует использовать форматы URL, совместимые с Router::reverse()

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

Строка или массив, представляющий URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

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

Если массив содержит ключ «return», устанавливает AutoRender в значение true. Также может быть использован для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

смешанный тип

Логическое значение true или false при успехе/неудачи, или содержимое отрисованного действия, если в $extra установлен ключ «return».

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по необходимости.

Возвращает

строка
Имя этого класса

array()

array()

true

array('Html', 'Form')

'app'