Spec-Zone.ru › CakePHP 2.7

Класс JsBaseEngineHelper

JsEngineBaseClass

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

Объект
Extended by Помощник
Extended by AppHelper
Extended by JsBaseEngineHelper

Непосредственные известные подклассы

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

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

_mapOptionsисходный код protected

_mapOptions( string $method , array $options )

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

Параметры

строка $method
Имя метода, параметры которого обрабатываются.
массив $options
Массив параметров для преобразования.

Возвращает

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

_parseOptionsисходный код protected

_parseOptions( array $options , array $safeKeys array() )

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

Параметры

массив $options
Параметры для преобразования
массив $safeKeys необязательно массив()
Ключи, которые не должны экранироваться.

Возвращает

string
Обработанные JSON-параметры без заключённых { }.

_prepareCallbacksисходный код protected

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

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

Параметры

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

Возвращает

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

_processOptionsисходный код protected

_processOptions( string $method , array $options )

Удобный оберточный метод для всех общих шагов обработки параметров. Выполняет _mapOptions, _prepareCallbacks и _parseOptions в определённом порядке.

Параметры

строка $method
Имя метода, для которого обрабатываются параметры.
массив $options
Массив параметров для обработки.

Возвращает

string
Строка обработанных параметров.

_toQuerystringисходный код protected

_toQuerystring( array $parameters )

Преобразует массив данных в строку запроса

Параметры

массив $parameters
Массив параметров для преобразования в строку запроса

Возвращает

string
Фрагмент строки запроса

_utf8ToHexисходный код protected

_utf8ToHex( string $string )

Кодирует строку в JSON. Преобразует и экранирует необходимые символы.

Параметры

строка $string
Строка, которая должна быть закодирована utf8->hex

alertисходный код public

alert( string $message )

Создаёт сообщение alert() в JavaScript

Параметры

строка $message
Сообщение, которое вы хотите изменить.

Возвращает

string
Завершенная функция alert()

confirmисходный код public

confirm( string $message )

Создаёт сообщение confirm()

Параметры

строка $message
Сообщение, которое вы хотите подтвердить.

Возвращает

string
Завершенная функция confirm()

confirmReturnисходный код public

confirmReturn( string $message )

Генерирует фрагмент confirm, который возвращает false из текущего контекста функции.

Параметры

строка $message
Сообщение для использования в диалоговом окне подтверждения.

Возвращает

string
Завершённый confirm с возвращаемым скриптом

domReadyисходный код abstract public

domReady( string $functionBody )

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

Параметры

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

Возвращает

string
Завершенный метод domReady

dragисходный код abstract public

drag( array $options array() )

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

Параметры

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

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

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

Параметры

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

Возвращает

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

dropисходный код abstract public

drop( array $options array() )

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

Параметры

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

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

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

Параметры

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

Возвращает

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

eachисходный код abstract public

each( string $callback )

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

Параметры

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

Возвращает

string
Завершенная итерация

effectsource abstract public

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

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

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

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

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

Параметры

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

Параметры

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

Возвращает

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

escapesource public

escape( string $string )

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

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

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

Параметры

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

Возвращает

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

eventsource abstract public

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

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

Параметры

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

Параметры

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

Возвращает

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

getsource abstract public

get( string $selector )

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

Параметры

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

Возвращает

self
экземпляр $this. Позволяет использовать методы цепочки.

objectsource public

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

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

Параметры:

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

Параметры

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

Возвращает

string
Блок кода JSON

promptsource public

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

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

Параметры

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

Возвращает

string
завершенный метод prompt()

redirectsource public

redirect( string|array $url null )

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

Параметры

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

Возвращает

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

requestsource abstract public

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

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

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

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

Параметры

  • method - Метод для выполнения запроса, по умолчанию GET в большинстве библиотек
  • async - Нужно ли асинхронное выполнение запроса.
  • data - Дополнительные данные для отправки.
  • update - Идентификатор DOM для обновления содержимого запроса.
  • type - Тип данных для ответа. Поддерживаются 'json' и 'html'. По умолчанию html для большинства библиотек.
  • evalScripts - Нужно ли выполнять теги <script>.
  • dataExpression - Нужно ли обрабатывать ключ data как обратный вызов. Полезно для предоставления $options['data'] как другой JavaScript-выражения.

Параметры

строка|массив $url
Массив или строка URL, который нужно обработать в запросе.
массив $options необязательно массив()
Массив параметров. См. выше для поддерживаемых параметров в разных библиотеках.

Возвращает

string
Запрос XHR.

serializeFormsource abstract public

serializeForm( array $options array() )

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

Параметры

  • isForm - Является ли текущий выбор формой или элементом ввода? (по умолчанию false)
  • inline - Будет ли сгенерированная строка использована внутри другого JS-выражения? (по умолчанию false)

Параметры

массив $options необязательно массив()
Параметры для генерации сериализации.

Возвращает

string
завершенный скрипт сериализации формы

slidersource abstract public

slider( array $options array() )

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

Параметры

  • handle - Идентификатор элемента, используемого в перемещении.
  • direction - Направление ползунка, 'вертикальное' или 'горизонтальное'
  • min - Минимальное значение для ползунка.
  • max - Максимальное значение для ползунка.
  • step - Количество шагов или делений ползунка.
  • value - Начальное смещение ползунка.

События

  • change - Срабатывает при обновлении значения ползунка.
  • complete - Срабатывает, когда пользователь прекращает перемещение ползунка.

Параметры

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

Возвращает

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

sortablesource abstract public

sortable( array $options array() )

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

Параметры

  • containment - Контейнер для действий перемещения
  • handle - Селектор для обработки элемента. Только этот элемент начнет действие сортировки.
  • revert - Использовать эффект для перемещения сортируемого элемента в конечное положение.
  • opacity - Непрозрачность заполнитель.
  • distance - Расстояние, на которое сортируемый элемент должен быть перетащен перед началом сортировки.

События

  • start - Событие срабатывает при начале сортировки.
  • sort - Событие срабатывает во время сортировки.
  • complete - Событие срабатывает по завершении сортировки.

Параметры

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

Возвращает

string
Завершенный скрипт сортировки.

valuesource public

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

Преобразует переменную PHP любого типа в эквивалентное представление JSON.

Параметры

mixed $val необязательно array()
Переменная PHP, которая должна быть преобразована в JSON
boolean $quoteString необязательно null
Если false, строковые значения остаются необрамленными в кавычки
string $key необязательно 'value'
Имя ключа.

Возвращает

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

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

Helper::value()

Методы, унаследованные от Helper

__callsource public

__call( string $method , array $params )

Обеспечивает отсутствие критических ошибок при вызове отсутствующего метода.

Параметры

string $method
Метод для вызова
array $params
Массив параметров для метода.

__constructsource public

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

Конструктор по умолчанию

Параметры

View $View
Представление, к которому подключается помощник.
array $settings необязательно array()
Настройки конфигурации помощника.

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

Object::__construct()

__getsource public

__get( string $name )

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

Устарело

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

Параметры

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

Возвращает

mixed
Помощник или свойство, найденное в $name

__setsource public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

string $name
Имя свойства, к которому осуществляется доступ.
mixed $value
Значение для установки.

_cleansource protected

_clean( )

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

_confirmsource protected

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

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

Параметры

string $message
Сообщение для отображения
string $okCode
Код, который выполняется после выбора пользователем 'OK'
string $cancelCode необязательно ''
Код, который выполняется после выбора пользователем 'Отмена'
array $options необязательно array()
Массив опций

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

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

Параметры

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

Возвращает

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

_formatAttributesource protected

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

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

Устарело

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

Параметры

string $key
Имя атрибута для создания.
string $value
Значение атрибута для создания.
boolean $escape необязательно true
Определяет, должно ли значение быть экранировано.

Возвращает

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

_initInputFieldsource protected

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

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

Параметры

string $field
Имя поля для инициализации.
array $options необязательно array()
Массив опций для использования при инициализации поля ввода.

Возвращает

array
Массив опций для поля формы.

_namesource protected

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

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

Параметры

array|string $options необязательно array()
Если массив, должен быть массивом атрибутов, к которому нужно добавить $key. Если строка или null, будет использоваться как сущность View.
string $field необязательно null
Имя поля.
string $key необязательно 'name'
Имя атрибута для установки, по умолчанию 'name'.

Возвращает

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

_parseAttributessource 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

Параметры

array $options
Массив опций.
array $exclude необязательно null
Массив опций, которые будут исключены, эти опции не будут частью возвращаемого значения.
string $insertBefore необязательно ' '
Строка, которая будет вставлена перед опциями.
string $insertAfter необязательно null
Строка, которая будет вставлена после опций.

Возвращает

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

_resetsource protected

_reset( )

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

_selectedArraysource protected

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

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

Параметры

string|array $data
Массив данных или имя модели.
string $key необязательно 'id'
Имя поля.

Возвращает

array
массив
END_OF_DOCUMENT_MARKER

addClasssource public

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

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

Параметры

массив $options необязательно массив()
Массив параметров/атрибутов для добавления класса
строка $class необязательно null
Имя добавляемого класса.
строка $key необязательно 'class'
ключ для использования класса.

Возвращает

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

afterLayoutsource public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile
Файл макета, который был рендерен.

afterRendersource public

afterRender( string $viewFile )

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

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

Параметры

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

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile
Файл, который только что был рендерен.
строка $content
Содержание, которое было рендерене.

assetTimestampsource public

assetTimestamp( string $path )

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

Параметры

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

Возвращает

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

assetUrlsource public

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

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

Параметры

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

Возвращает

string
Сгенерированный URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile
Макет, который должен быть рендерен.

beforeRendersource public

beforeRender( string $viewFile )

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

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

Параметры

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

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

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

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

Параметры

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

cleansource public

clean( string|array $output )

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

Устарело

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

Параметры

строка|массив $output
Массив строк для очистки или одна строка для очистки.

Возвращает

string|array|null
Очищенное содержимое для вывода

domIdsource public

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

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

Параметры

массив|строка $options необязательно null
Массив HTML-атрибутов, в который нужно добавить $id, или строка с путем сущности представления для получения domId.
строка $id необязательно 'id'
Имя атрибута 'id'.

Возвращает

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

entitysource public

entity( )

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

Возвращает

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

fieldsource public

field( )

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

Возвращает

string
строка

modelsource public

model( )

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

Возвращает

string
строка

outputsource public

output( string $str )

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

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

Устарело

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

Параметры

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

Возвращает

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника для пары значений с точкой в $entity.

Параметры

строка $entity
Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"
булево $setScope необязательно false
Устанавливает область представления для модели, указанной в $tagValue

urlsource public

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

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

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

Параметры

строка|массив $url необязательно null
Относительный строковый URL, например, /products/view/23, или массив параметров URL. Использование массива для URL позволит использовать возможности обратного маршрутизирования CakePHP.
булево $full необязательно false
Если true, к результату будет добавлен полный базовый URL

Возвращает

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

Ссылка

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

webrootsource public

webroot( string $file )

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

Параметры

строка $file
Файл, для которого нужно создать путь в webroot.

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

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

Методы, унаследованные от Object

_mergeVarssource protected

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

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

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

Параметры

массив $properties
Название свойств для объединения.
строка $class
Класс для объединения свойств.
логическое значение $normalize необязательно true
Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_setsource protected

_set( array $properties array() )

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

Параметры

массив $properties необязательно array()
Ассоциативный массив, содержащий свойства и соответствующие значения.

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

целое число или строка $status необязательно 0
см. http://php.net/exit для значений

dispatchMethodsource public

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

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

Параметры

строка $method
Имя метода для вызова
массив $params необязательно array()
Список параметров для использования при вызове $method

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

mixed
Возвращает результат вызова метода

logsource 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().

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

boolean
Успешность записи в журнал

requestActionsource 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 и именованных/переданных аргументов.

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

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

toStringsource public

toString( )

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

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

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

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

$_callbackArgumentssource

protected массив

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

array()

$_optionMapsource

protected массив

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

array()

$bufferedMethodssource

public массив

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

array('event', 'sortable', 'drag', 'drop', 'slider')

$selectionsource

public строка

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

Свойства, унаследованные от Helper

$_Viewsource

protected View

Экземпляр View, к которому прикреплен этот помощник

$_associationsource

protected string

Имя текущей модели ассоциации, сущности которой находятся в области действия.

См.

Helper::setEntity()

$_attributeFormatsource

protected string

Формат атрибута

'%s="%s"'

$_cleanedsource

protected mixed

Содержит очищенное содержимое.

null

$_entityPathsource

protected string

Список элементов, разделённых точкой, для которых предназначена текущая сущность поля.

См.

Helper::setEntity()

$_fieldSuffixessource

protected array

Список строк, которые должны рассматриваться как суффиксы или подвходные данные для родительского ввода. Это используется в первую очередь для вводов даты/времени.

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

$_helperMapsource

protected array

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.

array()

$_minimizedAttributeFormatsource

protected string

Формат атрибута

'%s="%s"'

$_minimizedAttributessource

protected array

Минимизированные атрибуты

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

$_modelScopesource

protected string

Имя текущей модели, сущности которой находятся в области действия.

См.

Helper::setEntity()

$_taintedsource

protected mixed

Содержит содержимое, подлежащее очистке.

null

$fieldsetsource

public array

Массив полей ('имя_поля' => массив('тип' => 'строка', 'длина' => 100), первичный ключ и валидации (массив('имя_поля'))

array()

$helperssource

public array

Список помощников, используемых этим помощником

array()

$pluginsource

public string

Путь к плагину

null

$requestsource

public CakeRequest

Объект запроса

null

$settingssource

public array

Настройки для этого помощника.

array()

$tagssource

public array

Хранит шаблоны тегов.

array()

$themesource

public string

Название текущей темы, если она есть.

null

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API