Класс FormHelper
Библиотека помощника для форм.
Автоматическое создание HTML-форм из заданных данных.
- Объект
-
Помощник -
AppHelper -
FormHelper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Ссылка: http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html
Расположено в Cake/View/Helper/FormHelper.php
Подробное описание методов
__callsource public
__call( string $method , array $params )
Обработчик отсутствующего метода - реализует различные простые типы ввода. Используется для создания элементов различных типов. Например, $this->Form->text(); создаст <input type="text" />, а $this->Form->range(); создаст <input type="range" />
Использование
$this->Form->search('User.query', array('value' => 'test'));
Создаст элемент ввода, например:
<input type="search" id="UserQuery" name="data[User][query]" value="test" />
Первый аргумент типа ввода всегда должен быть именем поля в формате Model.field. Второй аргумент всегда должен быть массивом атрибутов для элемента ввода.
Параметры
- строка
$method - Имя метода/тип ввода.
- массив
$params - Параметры для вызова метода
Возвращает
stringОтформатированный метод ввода.
Исключения
CakeExceptionЕсли нет параметров для вызова метода.
Переопределяет
Helper::__call() __constructsource public
__construct( View $View , array $settings array() )
Копирует переменную validationErrors из объекта View в этот экземпляр
Параметры
-
View$View - Объект View, к которому прикрепляется помощник.
- массив
$settingsнеобязательный array() - Параметры конфигурации помощника.
Переопределяет
Helper::__construct() _csrfFieldsource protected
_csrfField( )
Возвращает элемент CSRF, если _Token присутствует. Используется для защиты форм в сочетании с SecurityComponent
Возвращает
stringстрока
_dateTimeSelectedsource protected
_dateTimeSelected( string $select , string $fieldName , array $attributes )
Выбирает значения для элементов выбора dateTime.
Параметры
- строка
$select - Имя поля элемента. Например, 'день'
- строка
$fieldName - Имя генерируемого поля имени, например, Model.created
- массив
$attributes - Массив атрибутов, обязательно содержащий ключ 'empty'.
Возвращает
arrayМассив атрибутов с текущим выбранным значением.
_divOptionssource protected
_divOptions( array $options )
Генерирует элементы div для ввода.
Параметры
- массив
$options - Список вариантов.
Возвращает
arrayмассив
_extractOptionsource protected
_extractOption( string $name , array $options , mixed $default null )
Извлекает один вариант из массива вариантов.
Параметры
- строка
$name - Имя варианта для извлечения.
- массив
$options - Массив вариантов для извлечения.
- смешанный
$defaultнеобязательный null - Значение варианта по умолчанию
Возвращает
mixedсодержимое варианта или значение по умолчанию
_generateOptionssource protected
_generateOptions( string $name , array $options array() )
Генерирует списки опций для стандартных меню <select />
Параметры
- строка
$name - Имя типа списка.
- массив
$optionsнеобязательно array() - Список опций.
Возвращает
arrayмассив
_getDateTimeValuesource protected
_getDateTimeValue( string|array $value , integer $timeFormat )
Обрабатывает значение для выбранного значения даты и времени
Параметры
- строка|массив
$value - Выбранное значение.
- целое число
$timeFormat - Формат времени
Возвращает
arrayМассив выбранного значения.
_getFormatsource protected
_getFormat( array $options )
Генерирует опции формата
Параметры
- массив
$options - Список опций.
Возвращает
arrayмассив
_getInputsource protected
_getInput( array $args )
Генерирует элемент ввода
Параметры
- массив
$args - Опции для элемента ввода
Возвращает
stringСгенерированный элемент ввода
_getLabelsource protected
_getLabel( string $fieldName , array $options )
Генерирует метку для поля ввода
Параметры
- строка
$fieldName - Имя поля.
- массив
$options - Список опций.
Возвращает
boolean|stringfalse или сгенерированный элемент метки
_getModelsource protected
_getModel( string $model )
Определяет местоположение модели на основе ее имени и пытается создать новый экземпляр или получить уже созданный экземпляр модели
Параметры
- строка
$model - Имя модели.
Возвращает
Model|nullЭкземпляр модели
_initInputFieldsource protected
_initInputField( string $field , array $options array() )
Устанавливает значения по умолчанию для поля и добавляет поле в хеш ввода для защиты формы. Также добавит класс 'form-error', если поле содержит ошибки валидации.
Опции
-
secure- логическое значение, определяющее, следует ли добавлять поле в поля безопасности. Отключение поля с помощью опцииdisabledтакже исключит поле из хешируемого ключа.
Этот метод преобразует индексированное численно поле 'disabled' в ассоциативное значение. Внутренние механизмы FormHelper ожидают ассоциативные опции.
Параметры
- строка
$field - Имя поля для инициализации опций.
- массив
$optionsнеобязательно array() - Массив опций для добавления опций.
Возвращает
arrayМассив опций для поля ввода.
Переопределяет
Helper::_initInputField() _inputLabelsource protected
_inputLabel( string $fieldName , string|array $label , array $options )
Генерирует метку для вызова input().
$options может содержать хеш переопределений id. Эти переопределения будут использоваться вместо сгенерированных значений, если они присутствуют.
Параметры
- строка
$fieldName - Имя поля.
- строка|массив
$label - Текст метки или массив с текстом и опциями.
- массив
$options - Опции для элемента метки. Опция 'NONE' устарела и будет удалена в версии 3.0
Возвращает
stringСгенерированный элемент метки
_introspectModelsource protected
_introspectModel( string $model , string $key , string $field null )
Просматривает свойства модели, чтобы извлечь из них информацию. В настоящее время он может извлечь информацию из полей, первичного ключа и обязательных полей.
Параметр $key принимает следующий список значений:
- key: Возвращает имя первичного ключа модели.
- fields: Возвращает схему модели.
- validates: возвращает список полей, которые являются обязательными.
- errors: возвращает список ошибок валидации.
Если параметр $field передан, он вернёт информацию только для этого поля.
$this->_introspectModel('Post', 'fields', 'title'); вернёт информацию о схеме столбца title.
Параметры
- строка
$model - имя модели, из которой нужно извлечь информацию.
- строка
$key - имя специального ключа информации для получения (key, fields, validates, errors).
- строка
$fieldнеобязательно null - имя поля модели, из которого нужно получить информацию.
Возвращает
mixedинформация, извлечённая для специального ключа и поля в модели
_isRequiredFieldsource protected
_isRequiredField( CakeValidationSet $validationRules )
Возвращает, является ли поле обязательным для заполнения на основе свойств валидации из объекта валидации.
Параметры
-
CakeValidationSet$validationRules - Набор правил валидации.
Возвращает
booleantrue, если поле необходимо заполнить, false в противном случае
_lastActionsource protected
_lastAction( string|array $url )
Устанавливает последнее созданное действие формы.
Параметры
- строка|массив
$url - URL.
_magicOptionssource protected
_magicOptions( array $options )
Магически устанавливает тип параметра и соответствующие параметры.
Параметры
- массив
$options - Список параметров.
Возвращает
arrayмассив
_maxLengthsource protected
_maxLength( array $options )
Вычисляет параметр maxlength.
Параметры
- массив
$options - Список параметров.
Возвращает
arrayмассив
_namesource protected
_name( array $options array() , string $field null , string $key 'name' )
Получает имя поля ввода для текущего тега.
Параметры
- массив
$optionsнеобязательно массив() - Список параметров.
- строка
$fieldнеобязательно null - Имя поля.
- строка
$keyнеобязательно 'name' - Имя ключа.
Возвращает
arrayмассив
Переопределяет
Helper::_name() _optionsOptionssource protected
_optionsOptions( array $options )
Генерирует список параметров для множественного выбора.
Параметры
- массив
$options - Список параметров.
Возвращает
arrayмассив
_parseOptionssource protected
_parseOptions( array $options )
Генерирует массив параметров ввода.
Параметры
- массив
$options - Список параметров.
Возвращает
arrayПараметры
_securesource protected
_secure( boolean $lock , string|array $field null , mixed $value null )
Определить, какие поля формы должны использоваться для хэширования. Заполняет $this->fields
Параметры
- boolean
$lock - Указывает, должно ли это поле быть частью валидации или исключено как часть unlockedFields.
- string|array
$fieldнеобязательно null - Ссылка на поле, которое должно быть защищено. Должно быть разделено точками для указания вложенности.
- mixed
$valueнеобязательно null - Значение поля, если значение не должно быть изменено.
_secureFieldNamesource protected
_secureFieldName( array $options )
Получить имя поля для использования с _secure().
Парсит атрибут name, чтобы создать значение имени, разделенное точками, для использования в хэшировании защищённого поля.
Параметры
- array
$options - Массив опций, возможно содержащий ключ name.
Возвращает
string|nullstring|null
_selectOptionssource protected
_selectOptions( array $elements array() , array $parents array() , boolean $showParents null , array $attributes array() )
Возвращает массив отформатированных элементов OPTION/OPTGROUP
Параметры
- array
$elementsнеобязательно array() - Элементы для форматирования.
- array
$parentsнеобязательно array() - Родители для OPTGROUP.
- boolean
$showParentsнеобязательно null - Показывать ли родителей.
- array
$attributesнеобязательно array() - Атрибуты HTML.
Возвращает
arrayarray
buttonsource public
button( string $title , array $options array() )
Создаёт тег <button>. Атрибут type по умолчанию type="submit". Вы можете изменить его на другое значение, используя $options['type'].
Опции:
-
escape- кодировать HTML-сущности $title кнопки. По умолчанию false.
Параметры
- string
$title - Подпись кнопки. Не кодируется автоматически в HTML.
- array
$optionsнеобязательно array() - Массив опций и атрибутов HTML.
Возвращает
stringТег HTML кнопки.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::buttoncheckboxsource public
checkbox( string $fieldName , array $options array() )
Создаёт виджет чекбокса.
Опции:
-
value- значение чекбокса -
checked- boolean, указывающий, что этот чекбокс отмечен. -
hiddenField- boolean, указывающий, нужно ли включать скрытый input с значением ''. -
disabled- создать отключённый input. -
default- Установить значение по умолчанию для чекбокса. Это позволяет устанавливать чекбоксы как отмеченные, не проверяя данные POST. Соответствующее значение в POST-данных перекроет значение по умолчанию.
Параметры
- string
$fieldName - Имя поля, например "Modelname.fieldname"
- array
$optionsнеобязательно array() - Массив атрибутов HTML.
Возвращает
stringЭлемент HTML текстового input.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputscreatesource public
create( mixed $model null , array $options array() )
Возвращает элемент HTML FORM.
Параметры:
-
typeМетод формы по умолчанию POST -
actionДействие контроллера, к которому отправляется форма (необязательно). -
urlURL, к которому отправляется форма. Может быть строкой или массивом URL. Если используется 'url', 'action' следует оставить неопределённым. -
defaultПозволяет создавать Ajax-формы. Установите в false, чтобы предотвратить обработчик событий по умолчанию. Создаст атрибут onsubmit, если он не существует. Если существует, добавит подавление действия по умолчанию. -
onsubmitИспользуется совместно с 'default' для создания Ajax-форм. -
inputDefaultsУстановите значения по умолчанию для FormHelper::input(). Любые параметры, которые могут быть установлены при использовании FormHelper::input(), могут быть установлены здесь. Параметры, установленные с помощьюinputDefaultsмогут быть переопределены при вызове input() -
encodingУстановите кодировку accept-charset для формы. По умолчаниюConfigure::read('App.encoding')
Параметры
- mixed
$modelнеобязательный null - Имя модели, для которой определяется форма. Должно включать имя плагина для моделей плагинов. Например,
ContactManager.Contact. Если передаётся массив, а аргумент $options пуст, массив будет использован как параметры. Еслиfalseмодель не используется. - array
$optionsнеобязательный array() - Массив атрибутов и параметров HTML.
Возвращаемое значение
stringОтформатированный открывающий тег FORM.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-createdateTimesource public
dateTime( string $fieldName , string $dateFormat 'DMY' , string $timeFormat '12' , array $attributes array() )
Возвращает набор элементов SELECT для полного набора даты и времени: день, месяц и год, затем время.
Атрибуты:
-
monthNamesЕсли false, будут использоваться двузначные числа вместо текста. Если массив, будет использован переданный массив. -
minYearНаименьший год для использования в списке выбора года -
maxYearНаибольший год для использования в списке выбора года -
intervalИнтервал для списка выбора минут. По умолчанию 1 -
separatorСодержимое строки между элементами списка выбора. По умолчанию '-' -
empty- Если true, пустой элемент списка выбора отображается. Если строка, эта строка отображается как пустой элемент. -
round- Установите вupилиdown, если необходимо принудительно округлять в любом направлении. По умолчанию null. -
value|defaultЗначение по умолчанию, используемое для входа. Значение в$this->dataс именем поля перекроет это значение. Если значение по умолчанию не предоставлено,time()будет использоваться.
Параметры
- string
$fieldName - Префикс имени для элемента SELECT
- string
$dateFormatнеобязательный 'DMY' - DMY, MDY, YMD или null, чтобы не генерировать вводы даты.
- string
$timeFormatнеобязательный '12' - 12, 24 или null, чтобы не генерировать вводы времени.
- array
$attributesнеобязательный array() - Массив атрибутов
Возвращаемое значение
stringСгенерированный набор элементов выбора для форматов даты и времени.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::dateTimedaysource public
day( string $fieldName null , array $attributes array() )
Возвращает элемент SELECT для дней.
Атрибуты:
-
empty- Если true, пустой элемент списка выбора отображается. Если строка, эта строка отображается как пустой элемент. -
valueВыбранное значение элемента ввода.
Параметры
- string
$fieldNameнеобязательный null - Префикс имени для элемента SELECT
- array
$attributesнеобязательный array() - Атрибуты HTML для элемента select
Возвращаемое значение
stringСгенерированный элемент выбора для дня.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::daydomIdSuffixsource public
domIdSuffix( string $value , string $type 'html4' )
Генерирует допустимый суффикс идентификатора DOM из строки. Также предотвращает коллизии, когда несколько значений преобразуются в один и тот же суффикс, добавляя числовое значение.
Для идентификаторов до HTML5 допустимы только символы a-z 0-9 - _ . HTML5 не имеет такого ограничения, но для предотвращения проблем с отображением по-прежнему фильтруются некоторые чувствительные символы.
Параметры
- строка
$value - Значение, которое должно быть преобразовано в суффикс идентификатора DOM.
- строка
$typeнеобязательно 'html4' - Тип документа, который нужно использовать. По умолчанию html4.
Возвращает
stringИдентификатор DOM
endsource public
end( string|array $options null , array $secureAttributes array() )
Закрывает HTML-форму, очищает значения, установленные FormHelper::create(), и записывает скрытые поля ввода, если это необходимо.
Если $options задан, будет создана кнопка отправки формы. Параметры могут быть строкой или массивом.
array usage: array('label' => 'save'); value="save" array('label' => 'save', 'name' => 'Whatever'); value="save" name="Whatever" array('name' => 'Whatever'); value="Submit" name="Whatever" array('label' => 'save', 'name' => 'Whatever', 'div' => 'good') <div class="good"> value="save" name="Whatever" array('label' => 'save', 'name' => 'Whatever', 'div' => array('class' => 'good')); <div class="good"> value="save" name="Whatever"
Если $secureAttributes задан, эти атрибуты HTML будут объединены в скрытые поля ввода, сгенерированные для компонента Security. Это особенно полезно для установки атрибутов HTML5, таких как 'form'
Параметры
- строка|массив
$optionsнеобязательно null - в виде строки будет использовать $options в качестве значения кнопки,
- массив
$secureAttributesнеобязательно array() - будет передан в качестве атрибутов HTML в скрытые поля ввода, сгенерированные для компонента Security.
Возвращает
stringЗакрывающая тэг FORM, необязательная кнопка отправки.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#closing-the-formerrorsource public
error( string $field , string|array $text null , array $options array() )
Возвращает отформатированное сообщение об ошибке для заданного поля FORM, NULL, если нет ошибок.
Параметры:
-
escapeboolean - Нужно ли экранировать содержимое сообщения об ошибке HTML. -
wrapmixed - Нужно ли обернуть сообщение об ошибке в div. Если строка, будет использоваться как тег HTML. -
wrapстрока - Имя класса для сообщения об ошибке
Параметры
- строка
$field - Имя поля, например "Modelname.fieldname"
- строка|массив
$textнеобязательно null - Сообщение об ошибке в виде строки или массива сообщений. Если массив содержит
attributesключ, он будет использован в качестве параметров для контейнера ошибок - массив
$optionsнеобязательно array() - Параметры отрисовки для тега обертки <div />
Возвращает
string|nullЕсли есть ошибки, метод возвращает сообщение об ошибке, в противном случае null.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::errorfilesource public
file( string $fieldName , array $options array() )
Создаёт поле ввода файла.
Параметры
- строка
$fieldName - Имя поля, в формате "Modelname.fieldname"
- массив
$optionsнеобязательно array() - Массив атрибутов HTML.
Возвращает
stringСгенерированное поле ввода файла.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::filehiddensource public
hidden( string $fieldName , array $options array() )
Создаёт скрытое поле ввода.
Параметры
- строка
$fieldName - Имя поля, в формате "Modelname.fieldname"
- массив
$optionsнеобязательно array() - Массив атрибутов HTML.
Возвращает
stringСгенерированное скрытое поле ввода
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::hiddenhoursource public
hour( string $fieldName , boolean $format24Hours false , array $attributes array() )
Возвращает элемент SELECT для часов.
Атрибуты:
-
empty— Если true, пустой параметр выбора отображается. Если строка, то эта строка отображается как пустой элемент. -
valueВыбранное значение входного элемента.
Параметры
- строка
$fieldName - Префиксное имя для элемента SELECT
- логическое значение
$format24Hoursнеобязательно false - True для 24-часового формата
- массив
$attributesнеобязательно array() - Список HTML-атрибутов
Возвращаемое значение
stringЗаполненный элемент выбора часов
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::hourinputsource public
input( string $fieldName , array $options array() )
Генерирует элемент формы ввода с меткой и оборачивающим div
Параметры
См. каждый метод типа поля для получения дополнительной информации. Любые параметры, которые являются частью $attributes или $options для различных методов type, могут быть включены в $options для input(). Кроме того, любые неизвестные ключи, которые не находятся в списке ниже или не являются частью параметров выбранного типа, будут обрабатываться как обычные html-атрибуты для генерируемого элемента ввода.
-
type— Вынужденный тип виджета, например,type => 'select' -
label— Метка в виде строки или массив параметров для метки. См. FormHelper::label(). -
div— Либоfalseдля отключения div, либо массив параметров для div.
См. HtmlHelper::div() для получения дополнительных параметров.
-
options— Для виджетов, которые принимают параметры (например, радио, выбор). -
error— Управление сообщением об ошибке. Установите вfalseдля отключения любого типа отчёта об ошибках (ошибки поля и сообщения об ошибках). -
errorMessage— Логическое значение для управления отображением сообщений об ошибках (ошибка поля всё ещё будет происходить). -
empty— Строка или логическое значение для включения пустых опций выпадающего списка. -
before— Содержимое, которое нужно разместить перед меткой + элементом ввода. -
after— Содержимое, которое нужно разместить после метки + элемента ввода. -
between— Содержимое, которое нужно разместить между меткой + элементом ввода. -
format— Шаблон формата для порядка элементов. Любой элемент, который не находится в массиве, не будет в выводе. - Порядок формата входного элемента по умолчанию: array('before', 'label', 'between', 'input', 'after', 'error')
- Порядок формата checkbox по умолчанию: array('before', 'input', 'between', 'label', 'after', 'error')
- Формат скрытого элемента ввода не будет отформатирован
- Для радиокнопок порядок элементов ввода и метки нельзя контролировать с помощью этих настроек.
Параметры
- строка
$fieldName - Должно быть «Modelname.fieldname»
- массив
$optionsнеобязательно array() - Каждый тип ввода принимает разные параметры.
Возвращаемое значение
stringЗаполненный виджет формы.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#creating-form-elementsinputDefaultssource public
inputDefaults( array $defaults null , boolean $merge false )
Устанавливает/получает inputDefaults для элементов формы
Параметры
- массив
$defaultsнеобязательно null - Новые значения по умолчанию
- логическое значение
$mergeнеобязательно false - Объединить с текущими значениями по умолчанию
Возвращаемое значение
arrayinputDefaults
inputssource public
inputs( array $fields null , array $blacklist null , array $options array() )
Создать набор элементов ввода для $fields. Если $fields равно null, будут использованы поля текущей модели.
Вы можете настроить отдельные элементы ввода с помощью $fields.
$this->Form->inputs(array( 'name' => array('label' => 'custom label') ));
В дополнение к выводу полей контроллера, $fields может использоваться для управления рендерингом легенды и fieldset. $this->Form->inputs('My legend'); сгенерирует набор ввода с настраиваемой легендой. Передача ключей fieldset и legend в массив $fields устарела с версии 2.3. Для более точного управления используйте ключи fieldset и legend в параметре $options.
Параметры
- массив
$fieldsнеобязательный null - Массив полей для генерации элементов ввода, или null.
- массив
$blacklistнеобязательный null - Простой массив полей, для которых не нужно создавать элементы ввода.
- массив
$optionsнеобязательный array() - Массив опций. Допустимые ключи: -
fieldsetУстановите в false, чтобы отключить fieldset. Если указана строка, она будет использована как имя класса для элемента fieldset. -legendУстановите в false, чтобы отключить легенду для сгенерированного набора ввода. Или укажите строку для настройки текста легенды.
Возвращаемое значение
stringЗаполненные поля формы.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::inputsisFieldErrorsource public
isFieldError( string $field )
Возвращает true, если для данного поля есть ошибка, иначе false.
Параметры
- строка
$field - Должно быть «ИмяМодели.ИмяПоля»
Возвращаемое значение
booleanЕсли есть ошибки, метод возвращает true, иначе false.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::isFieldErrorlabelsource public
label( string $fieldName null , string $text null , array|string $options array() )
Возвращает отформатированный элемент LABEL для HTML-форм. Автоматически сгенерирует атрибут for если он не задан.
Опции
-
for- Установите атрибут for, если он не определён, атрибут for будет сгенерирован из параметра $fieldName с помощью FormHelper::domId().
Примеры:
Текст и атрибут for генерируются из имени поля
echo $this->Form->label('Post.published'); <label for="PostPublished">Published</label>
Настраиваемый текст:
echo $this->Form->label('Post.published', 'Publish'); <label for="PostPublished">Publish</label>
Настраиваемое имя класса:
echo $this->Form->label('Post.published', 'Publish', 'required'); <label for="PostPublished" class="required">Publish</label>
Настраиваемые атрибуты:
echo $this->Form->label('Post.published', 'Publish', array( 'for' => 'post-publish' )); <label for="post-publish">Publish</label>
Предупреждение В отличие от большинства методов FormHelper, этот метод не автоматически экранирует параметр $text. Вы должны сами экранировать параметр $text, если используете данные, предоставленные пользователем.
Параметры
- строка
$fieldNameнеобязательный null - Должно быть «ИмяМодели.ИмяПоля»
- строка
$textнеобязательный null - Текст, который будет отображаться в поле метки. Если $text не определен, текст будет извлечен из fieldName.
- массив|строка
$optionsнеобязательный array() - Массив HTML-атрибутов или строка, используемая в качестве имени класса.
Возвращаемое значение
stringОтформатированный элемент LABEL.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::labelmeridiansource public
meridian( string $fieldName , array $attributes array() )
Возвращает элемент SELECT для AM или PM.
Атрибуты:
-
empty- Если true, пустой элемент выбора отображается. Если строка, эта строка отображается в качестве пустого элемента. -
valueВыбранное значение входных данных.
Параметры
- строка
$fieldName - Префиксное имя для элемента SELECT
- массив
$attributesнеобязательно массив() - Массив атрибутов
Возвращает
stringЗаполненный элемент выбора meridian
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::meridianminutesource public
minute( string $fieldName , array $attributes array() )
Возвращает элемент SELECT для минут.
Атрибуты:
-
empty- Если true, пустой элемент выбора отображается. Если строка, эта строка отображается в качестве пустого элемента. -
valueВыбранное значение входных данных.
Параметры
- строка
$fieldName - Префиксное имя для элемента SELECT
- массив
$attributesнеобязательно массив() - Массив атрибутов
Возвращает
stringЗаполненный элемент выбора минут.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::minutemonthsource public
month( string $fieldName , array $attributes array() )
Возвращает элемент SELECT для месяцев.
Атрибуты:
-
monthNames- Если false, будут использоваться 2-значные числа вместо текста. Если массив, будет использоваться предоставленный массив. -
empty- Если true, пустой элемент выбора отображается. Если строка, эта строка отображается в качестве пустого элемента. -
valueВыбранное значение входных данных.
Параметры
- строка
$fieldName - Префиксное имя для элемента SELECT
- массив
$attributesнеобязательно массив() - Атрибуты для элемента select
Возвращает
stringСгенерированный выпадающий список месяцев.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::monthpostButtonsource public
postButton( string $title , string|array $url , array $options array() )
Создает тег <button> с окружающим <form> который отправляет данные по POST.
Этот метод создает элемент <form>. Поэтому не используйте этот метод в уже открытой форме. Вместо этого используйте FormHelper::submit() или FormHelper::button() для создания кнопок внутри открытых форм.
Опции:
-
data- Массив с ключ/значение для передачи в скрытые поля ввода - Другие опции такие же, как у метода button.
Параметры
- строка
$title - Надпись кнопки. Не кодируется автоматически в HTML
- строка|массив
$url - URL как строка или массив
- массив
$optionsнеобязательно массив() - Массив опций и атрибутов HTML.
Возвращает
stringТег HTML кнопки.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::postButtonpostLinksource public
postLink( string $title , string|array $url null , array $options array() , boolean|string $confirmMessage false )
Создаёт HTML-ссылку, но обращается к URL с помощью указанного метода (по умолчанию POST). Требуется включенный JavaScript в браузере.
Этот метод создаёт элемент <form>. Если вы хотите использовать этот метод внутри существующей формы, необходимо использовать опции inline или block, чтобы новая форма была размещена в блоке представления, который может быть отображён вне основной формы.
Если вам нужен только элемент для отправки формы, используйте FormHelper::submit() вместо этого.
Параметры:
-
data- Массив с парами ключ/значение для передачи в скрытые поля ввода -
method- Метод запроса для использования. Установите в 'delete', чтобы имитировать запрос HTTP/1.1 DELETE. По умолчанию 'post'. -
confirm- Может использоваться вместо $confirmMessage. -
inline- Определяет, будет ли тег формы выводиться встроенно. Установите в false, чтобы добавить тег формы в блок представления 'postLink'. По умолчанию true. -
block- Выберите пользовательский блок для добавления тега формы. Использование этой опции переопределит опцию inline. - Другие опции аналогичны методу HtmlHelper::link().
- Опция
onclickбудет заменена.
Параметры
- строка
$title - Текст, который будет заключён в теги <a>.
- строка|массив
$urlнеобязательно null - URL, относящийся к Cake, или массив параметров URL, или внешний URL (начинается с http://)
- массив
$optionsнеобязательно array() - Массив атрибутов HTML.
- булево|строка
$confirmMessageнеобязательно false - Сообщение подтверждения JavaScript. Этот аргумент устарел начиная с версии 2.6. Используйте ключ
confirmв $options вместо этого.
Возвращаемое значение
stringЭлемент
<a />Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::postLinkradiosource public
radio( string $fieldName , array $options array() , array $attributes array() )
Создаёт набор элементов радиокнопок. По умолчанию создаёт легенду и область для ввода.
Можно настроить каждый элемент радиокнопки с помощью массива массивов:
$options = array( array('name' => 'United states', 'value' => 'US', 'title' => 'My title'), array('name' => 'Germany', 'value' => 'DE', 'class' => 'de-de', 'title' => 'Another title'), );
Атрибуты:
-
separator- строка, которая отображается между радиокнопками -
between- строка между легендой и набором элементов или массив строк для вставки строк между блоками ввода -
legend- управляет наличием области для ввода и легенды в наборе виджетов -
value- указывает значение, которое должно быть выбрано -
label- булево значение, указывающее, нужно ли отображать метки для виджетов -
hiddenField- булево значение, указывающее, нужно ли включать скрытое поле с значением '' в результатах radio(). Это полезно для создания наборов радиокнопок, которые не являются непрерывными -
disabled- Установите вtrueилиdisabledдля отключения всех радиокнопок. -
empty- Установите вtrueдля создания поля ввода со значением '' в качестве первого варианта. Когда используетсяtrue, метка радиокнопки будет 'пустое'. Установите эту опцию в строку для управления значением метки.
Параметры
- строка
$fieldName - Имя поля, например, "Modelname.fieldname"
- массив
$optionsнеобязательно array() - Массив параметров радиокнопок.
- массив
$attributesнеобязательно array() - Массив атрибутов HTML и специальных атрибутов.
Возвращаемое значение
stringГотовый набор виджетов радиокнопок.
Ссылка
http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputssecuresource public
secure( array|null $fields array() , array $secureAttributes array() )
Генерирует скрытое поле с хешем безопасности, основанным на полях, используемых в форме.
Если задан $secureAttributes, эти атрибуты HTML будут объединены с скрытыми тегами ввода, сгенерированными для компонента Security. Это особенно полезно для установки атрибутов HTML5, таких как 'form'.
Параметры
- массив|null
$fieldsнеобязательно массив() - Если задано, указывает список полей, которые будут использоваться при генерации хеша; в противном случае используется $this->fields.
- массив
$secureAttributesнеобязательно массив() - будет передан в качестве атрибутов HTML в скрытые элементы ввода, сгенерированные для компонента Security.
Возвращает
string|nullСкрытое поле ввода с хешем безопасности, в противном случае null.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::secureselectsource public
select( string $fieldName , array $options array() , array $attributes array() )
Возвращает отформатированный элемент SELECT.
Атрибуты:
-
showParents- Если включено в массив и установлено в true, для родительской группы каждого элемента options будет добавлен дополнительный элемент options. Вы можете установить опцию с тем же именем, и её ключ будет использован в качестве значения опции. -
multiple- отобразить поле множественного выбора. Если установлено в 'checkbox', будут созданы несколько флажков вместо поля. -
empty- Если true, отображается пустой элемент select. Если строка, эта строка отображается как пустой элемент. -
escape- Если true, содержимое опций будет закодировано в HTML-сущности. По умолчанию true. -
valueВыбранное значение поля. -
class- При использовании multiple = checkbox имя класса, которое следует применить к div. По умолчанию 'checkbox'. -
disabled- Управляет атрибутом disabled. При создании поля select, установить в true, чтобы отключить select. При создании флажков,trueотключит все флажки. Также вы можете установить disabled со списком значений, которые вы хотите отключить при создании флажков.
Использование опций
Простой массив создаст обычные опции:
$options = array(1 => 'one', 2 => 'two); $this->Form->select('Model.field', $options));
В то время как вложенный массив опций создаст группы options с опциями внутри них.
$options = array( 1 => 'bill', 'fred' => array( 2 => 'fred', 3 => 'fred jr.' ) ); $this->Form->select('Model.field', $options);
В приведенном выше примере 2 => 'fred' не сгенерирует элемент options. Вы должны включить атрибут showParents чтобы отобразить опцию fred.
Если у вас есть несколько опций, которым нужно иметь одинаковое значение атрибута, вы можете использовать массив массивов для выражения этого:
$options = array( array('name' => 'United states', 'value' => 'USA'), array('name' => 'USA', 'value' => 'USA'), );
Параметры
- строка
$fieldName - Атрибут имени SELECT
- массив
$optionsнеобязательно массив() - Массив элементов OPTION (как пары 'значение'=>'Текст'), которые будут использоваться в элементе SELECT
- массив
$attributesнеобязательно массив() - Атрибуты HTML элемента select.
Возвращает
stringОтформатированный элемент SELECT
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputssubmitsource public
submit( string $caption null , array $options array() )
Создаёт элемент кнопки отправки. Этот метод сгенерирует элементы <input />, которые могут использоваться для отправки и сброса форм, используя $options. Кнопки с изображением могут быть созданы, указав путь к изображению в $caption.
Параметры
-
div- Включить оборачивающий div? По умолчанию true. Принимает подпараметры, аналогичные FormHelper::input(). -
before- Содержимое, которое необходимо вставить перед элементом ввода. -
after- Содержимое, которое необходимо вставить после элемента ввода. -
type- Установите в 'reset' для элементов сброса. По умолчанию 'submit' - Другие атрибуты будут назначены элементу ввода.
Параметры
-
div- Включить оборачивающий div? По умолчанию true. Принимает подпараметры, аналогичные FormHelper::input(). - Другие атрибуты будут назначены элементу ввода.
Параметры
- строка
$captionнеобязательно null - Текст метки кнопки или, если строка содержит :// или расширение .jpg, .jpe, .jpeg, .gif, .png, использует изображение, если расширение существует, и первый символ — /. Если первый символ не /, изображение относительно webroot/img.
- массив
$optionsнеобязательно array() - Массив параметров. Смотрите выше.
Возвращает
stringHTML-кнопку отправки
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::submittagIsInvalidsource public
tagIsInvalid( )
Возвращает false, если у указанного поля формы текущей сущности нет ошибок. В противном случае возвращает сообщение об ошибке.
Возвращает
mixedЛибо false, когда нет ошибок, либо массив строк ошибок. Строка ошибки может быть пустой.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::tagIsInvalidtextareasource public
textarea( string $fieldName , array $options array() )
Создаёт виджет textarea.
Параметры:
-
escape- Должны ли содержимое textarea быть экранированы. По умолчанию true.
Параметры
- строка
$fieldName - Имя поля в формате "НазваниеМодели.ИмяПоля"
- массив
$optionsнеобязательно array() - Массив HTML-атрибутов и дополнительных параметров, указанных выше.
Возвращает
stringСгенерированный HTML-элемент текстового поля
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::textareaunlockFieldsource public
unlockField( string $name null )
Добавляет или получает список полей, которые в данный момент не заблокированы. Разблокированные поля не включены в хэш полей, используемый SecurityComponent. Разблокировка поля после его добавления в список защищённых полей удалит его из списка.
Параметры
- строка
$nameнеобязательно null - Имя поля, разделённое точками.
Возвращает
mixedЛибо null, либо список полей.
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::unlockFieldyearsource public
year( string $fieldName , integer $minYear null , integer $maxYear null , array $attributes array() )
Возвращает элемент SELECT для годов
Атрибуты:
-
empty- Если значение true, то пустой вариант в списке отображается. Если строка, то эта строка отображается как пустой элемент. -
orderYear- Порядок значений года в опциях списка. Возможные значения 'asc', 'desc'. По умолчанию 'desc' -
valueВыбранное значение поля ввода.
Параметры
- строка
$fieldName - Префиксное имя для элемента SELECT
- целое число
$minYearнеобязательно null - Первый год в последовательности
- целое число
$maxYearнеобязательно null - Последний год в последовательности
- массив
$attributesнеобязательно array() - Массив атрибутов для элементов списка.
Возвращает
stringЗаполненный элемент ввода списка годов
Ссылка
http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::yearМетоды, унаследованные от Helper
__getsource public
__get( string $name )
Ленично загружает помощники. Также обеспечивает доступ к устаревшим свойствам запроса.
Устарело
3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в версии 3.0.Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
Возвращает
mixedПомощник или свойство, найденное в $name
__setsource public
__set( string $name , mixed $value )
Обеспечивает обратную совместимость для установки значений в объект запроса.
Устарело
3.0.0 Этот метод будет удален в версии 3.0Параметры
- строка
$name - Имя свойства, к которому осуществляется доступ.
- смешанный тип
$value - Значение для установки.
_confirmsource protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.
Параметры
- строка
$message - Сообщение, которое должно быть отображено
- строка
$okCode - Код, который должен быть выполнен после того, как пользователь выбрал 'OK'
- строка
$okCodeнеобязательно '' - Код, который должен быть выполнен после того, как пользователь выбрал 'Отмена'
- массив
$optionsнеобязательно array() - Массив опций
Возвращает
stringJS-код onclick
_encodeUrlsource protected
_encodeUrl( string $url )
Кодирует URL для использования в атрибутах HTML.
Параметры
- строка
$url - URL для кодирования.
Возвращает
stringURL, закодированный для использования как в URL, так и в HTML контекстах.
_formatAttributesource protected
_formatAttribute( string $key , string $value , boolean $escape true )
Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с минималистичными атрибутами, имеющими такое же значение, как и их имя, такие как 'disabled' и 'checked'
Устарело
3.0.0 Этот метод будет перенесен в HtmlHelper в версии 3.0Параметры
- строка
$key - Имя атрибута для создания
- строка
$value - Значение атрибута для создания.
- логическое
$escapeнеобязательно true - Определяет, нужно ли экранировать значение.
Возвращает
stringСоставленный атрибут.
_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Параметры
- массив
$options - Массив параметров.
- массив
$excludeнеобязательно null - Массив параметров, которые будут исключены; эти параметры не будут частью возвращаемого значения.
- строка
$insertBeforeнеобязательно ' ' - Строка, которая будет вставлена перед параметрами.
- строка
$insertAfterнеобязательно null - Строка, которая будет вставлена после параметров.
Возвращает
stringСоставленные атрибуты.
_resetsource protected
_reset( )
Сбрасывает переменные, используемые в Helper::clean(), в значение null
_selectedArraysource protected
_selectedArray( string|array $data , string $key 'id' )
Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных параметров для элемента множественного выбора.
Параметры
- строка|массив
$data - Массив данных или имя модели.
- строка
$keyнеобязательно 'id' - Имя поля.
Возвращает
arrayмассив
addClasssource public
addClass( array $options array() , string $class null , string $key 'class' )
Добавляет указанный класс к параметрам элемента.
Параметры
- массив
$optionsнеобязательно array() - Массив параметров/атрибутов, к которым необходимо добавить класс.
- строка
$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необязательно array() - Массив опций. Возможные ключи:
fullBaseВозвратить полный URL с именем доменаpathPrefixПрефикс пути для относительных URLextРасширение актива для добавленияpluginЗначение false предотвратит разбор пути как плагина
Возвращаемое значение
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 - Имя поля, например, "ИмяМодели.ИмяПоля" или "ИмяМодели.ID.ИмяПоля"
- логическое значение
$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/en/views/helpers.htmlvaluesource public
value( array|string $options array() , string $field null , string $key 'value' )
Получает данные для текущего тега
Параметры
- массив|строка
$optionsнеобязательно array() - Если массив, должен содержать массив атрибутов, к которому нужно добавить $key. Если строка или null, будет использоваться в качестве сущности View.
- строка
$fieldнеобязательно null - Имя поля.
- строка
$keyнеобязательно 'value' - Имя атрибута, подлежащего установке, по умолчанию 'value'
Возвращает
mixedЕсли для $options был передан массив, возвращается массив с установленным $key. Если была передана строка, возвращается строка.
webrootsource public
webroot( string $file )
Проверяет существование файла при использовании темы, если файл не найден, возвращается расположение по умолчанию.
Параметры
- строка
$file - Файл, для которого необходимо получить путь webroot.
Возвращает
stringВеб-доступный путь к файлу.
Методы, унаследованные от Объект
_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Имя этого класса
Краткое описание констант
string | SECURE_SKIP Константа, используемая внутри для пропуска процесса шифрования, и не добавляющая поле ни в хеш, ни в неразблокированные поля. | 'skip' |
Краткое описание свойств
Свойства, унаследованные от Helper
$_associationsource
protected string
Имя текущей модели ассоциации, в рамках которой существуют сущности.
См. также
Helper::setEntity()$_entityPathsource
protected string
Список элементов, разделённых точками, для которых предназначена текущая сущность поля.
См. также
Helper::setEntity()$_fieldSuffixessource
protected array
Список строк, которые должны обрабатываться как суффиксы или подвходные данные для родительского входа. В основном используется для ввода даты/времени.
array( 'year', 'month', 'day', 'hour', 'min', 'second', 'meridian' )
$_helperMapsource
protected array
Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
array() $_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()$fieldsetsource
public array
Массив полей ('имя_поля' => массив('тип' => 'строка', 'длина' => 100), primaryKey и validates массив('имя_поля'))
array() Краткое описание магических свойств
$Htmlsource
public HtmlHelper
© 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-FormHelper.html