Spec-Zone.ru › CakePHP 2.8

Класс FormHelper

Библиотека для работы с формами.

Автоматическое создание HTML-форм из заданных данных.

Объект
Extended by Помощник
Extended by AppHelper
Extended by FormHelper
Пакет: Cake\View\Helper
Ссылка: http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/FormHelper.php

Краткое описание констант

  • string

    SECURE_SKIP
    'skip'

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

  • $_domIdSuffixes protected
    array
    Содержит уже использованные суффиксы ID DOM для предотвращения коллизий с несколькими элементами формы.
  • $_inputDefaults protected
    array
    Постоянные значения по умолчанию, используемые методом input(). Устанавливаются методом FormHelper::create().
  • $_lastAction protected
    string

    Значение атрибута action последней созданной формы. Используется для создания хешей, специфичных для формы/запроса, для SecurityComponent.

  • $_models protected
    array

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

  • $_options protected
    array
    Опции, используемые для полей DateTime.
  • $_unlockedFields protected
    array

    Массив имён полей, исключенных из хеша токенов, используемого методом validatePost компонента SecurityComponent.

  • $defaultModel public
    string
    Модель по умолчанию, используемая для текущей формы.
  • $fields public
    array
    Список созданных полей, используется для защищенных форм.
  • $helpers public
    array
    Другие помощники, используемые FormHelper.
  • $requestType public
    string
    Определяет тип создаваемой формы. Устанавливается методом FormHelper::create().
  • $validationErrors public
    array

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

Краткое описание магических свойств

  • $Html public
    HtmlHelper

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

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

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

  • __call() public

    Обработчик отсутствующего метода - реализует различные простые типы ввода. Используется для создания элементов ввода различных типов. Например, $this->Form->text(); создаст <input type="text" />, в то время как $this->Form->range(); создаст <input type="range" />

  • __construct() public
    Копирует переменную validationErrors из объекта View в этот экземпляр
  • _csrfField() protected

    Возвращает элемент CSRF ввода, если _Token присутствует. Используется для защиты форм в сочетании с SecurityComponent

  • _dateTimeSelected() protected
    Выбирает значения для элементов выбора даты и времени.
  • _divOptions() protected
    Генерирует элементы div для ввода
  • _extractOption() protected
    Извлекает один элемент из массива опций.
  • _generateOptions() protected
    Генерирует списки опций для общих меню
  • _getDateTimeValue() protected
    Парсит значение для выбранного значения даты и времени
  • _getFormat() protected
    Генерирует опции формата
  • _getInput() protected
    Генерирует элемент ввода
  • _getLabel() protected
    Генерирует метку для ввода
  • _getModel() protected

    Определяет местоположение модели на основе ее имени и пытается создать новый экземпляр или получить уже созданный экземпляр модели

  • _initInputField() protected

    Устанавливает значения по умолчанию для поля и добавляет поле в хеш безопасности формы. Также добавит класс "form-error", если поле содержит ошибки валидации.

  • _inputLabel() protected
    Генерирует метку для вызова input().
  • _introspectModel() protected

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

  • _isRequiredField() protected
    Возвращает значение, является ли поле обязательным для заполнения, на основе свойств валидации из объекта валидации.
  • _lastAction() protected
    Устанавливает последнее созданное действие формы.
  • _magicOptions() protected
    Магически устанавливает тип опции и соответствующие опции
  • _maxLength() protected
    Вычисляет максимальную длину
  • _name() protected
    Получает имя поля ввода для текущего тега
  • _optionsOptions() protected
    Генерирует список опций для множественного выбора
  • _parseOptions() protected
    Генерирует массив опций ввода
  • _secure() protected

    Определяет, какие поля формы следует использовать для хеширования. Заполняет $this->fields

  • _secureFieldName() protected
    Получает имя поля для использования с _secure().
  • _selectOptions() protected
    Возвращает массив отформатированных элементов OPTION/OPTGROUP
  • button() public

    Создает тег <button>. Атрибут type по умолчанию равен type="submit". Можно изменить его на другое значение, используя $options['type']

  • checkbox() public
    Создает элемент ввода типа checkbox.
  • create() public
    Возвращает элемент HTML FORM.
  • dateTime() public
    Возвращает набор элементов SELECT для полного набора дат и времени: день, месяц и год, а затем время.
  • day() public
    Возвращает элемент SELECT для дней.
  • domIdSuffix() public

    Генерирует корректный суффикс ID DOM из строки. Также избегает конфликтов, когда несколько значений преобразуются в один и тот же суффикс, добавляя числовое значение.

  • end() public

    Закрывает форму HTML, очищает значения, установленные FormHelper::create(), и записывает скрытые поля ввода, где это необходимо.

  • error() public
    Возвращает отформатированное сообщение об ошибке для данного поля FORM, NULL, если ошибок нет.
  • file() public
    Создаёт элемент ввода типа файл.
  • hidden() public
    Создает скрытое поле ввода.
  • hour() public
    Возвращает элемент SELECT для часов.
  • input() public
    Генерирует элемент ввода формы, включая метку и обертывающую div
  • inputDefaults() public
    Устанавливает/получает inputDefaults для элементов формы
  • inputs() public

    Генерирует набор элементов ввода для $fields. Если $fields равно null, будут использоваться поля текущей модели.

  • isFieldError() public
    Возвращает true, если для данного поля есть ошибка, иначе false
  • label() public

    Возвращает отформатированный элемент LABEL для HTML-форм. Автоматически сгенерирует атрибут for, если он не указан.

  • meridian() public
    Возвращает элемент SELECT для AM или PM.
  • minute() public
    Возвращает элемент SELECT для минут.
  • month() public
    Возвращает элемент SELECT для месяцев.
  • postButton() public
    Создает тег <button> с окружающим <form>, который отправляет данные по POST.
  • postLink() public

    Создает HTML-ссылку, но получает URL с помощью указанного метода (по умолчанию POST). Требуется включенный JavaScript в браузере.

  • radio() public

    Создает набор элементов радио. По умолчанию создает легенду и набор полей. Используйте $options для управления этим

  • secure() public

    Генерирует скрытое поле с хешем безопасности, основанным на полях, используемых в форме.

  • select() public
    Возвращает отформатированный элемент SELECT.
  • submit() public

    Создает элемент кнопки отправки. Этот метод сгенерирует элементы <input />, которые могут использоваться для отправки и сброса форм, используя $options. Кнопки с изображением могут быть созданы путем предоставления пути к изображению для $caption.

  • tagIsInvalid() public

    Возвращает false, если у данного поля формы, описанного текущим объектом, нет ошибок. В противном случае возвращает сообщение об ошибке валидации

  • textarea() public
    Создаёт элемент textarea.
  • unlockField() public

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

  • year() public
    Возвращает элемент SELECT для годов

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

__call()source 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
Параметры для вызова метода.

Возвращает

строка
Отформатированный метод элемента ввода.

Исключение

CakeException
Если нет параметров для вызова метода.

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

Helper::__call()

__construct()source public

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

Копирует переменную validationErrors из объекта View в этот экземпляр

Параметры

View $View
Объект View, к которому прикреплен помощник.
массив $settings необязательный массив()
Настройки конфигурации помощника.

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

Helper::__construct()

_csrfField()source protected

_csrfField( )

Возвращает элемент CSRF, если _Token присутствует. Используется для защиты форм в сочетании с SecurityComponent

Возвращает

строка

_dateTimeSelected()source protected

_dateTimeSelected( string $select , string $fieldName , array $attributes )

Выбирает значения для элементов выбора dateTime.

Параметры

строка $select
Имя поля элемента. Например, 'day'
строка $fieldName
Имя генерируемого имени поля, например, Model.created
массив $attributes
Массив атрибутов, должен содержать ключ 'empty'.

Возвращает

массив
Массив атрибутов с текущим выбранным значением.

_divOptions()source protected

_divOptions( array $options )

Генерирует div-варианты для элемента ввода.

Параметры

массив $options
Список вариантов.

Возвращает

массив

_extractOption()source protected

_extractOption( string $name , array $options , mixed $default null )

Извлекает один вариант из массива вариантов.

Параметры

строка $name
Имя варианта для извлечения.
массив $options
Массив вариантов, из которого нужно извлечь.
смешанное $default необязательный null
Значение варианта по умолчанию.

Возвращает

смешанное
Содержимое варианта или значение по умолчанию

_generateOptions()source protected

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

Генерирует списки вариантов для общих меню.

Параметры

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

Возвращает

массив

_getDateTimeValue()source protected

_getDateTimeValue( string|array $value , integer $timeFormat )

Разбирает значение для выбранного значения даты и времени.

Параметры

строка|массив $value
Выбранное значение.
целое число $timeFormat
Формат времени.

Возвращает

массив
Массив выбранного значения.

_getFormat()source protected

_getFormat( array $options )

Генерирует параметры формата.

Параметры

массив $options
Список вариантов.

Возвращает

массив

_getInput()source protected

_getInput( array $args )

Генерирует элемент ввода.

Параметры

массив $args
Параметры для элемента ввода.

Возвращает

строка
Сгенерированный элемент ввода

_getLabel()source protected

_getLabel( string $fieldName , array $options )

Генерирует метку для вызова input().

$options может содержать хэш переопределений id. Эти переопределения будут использоваться вместо сгенерированных значений, если они присутствуют.

Параметры

строка $fieldName
Имя поля.
строка|массив $options
Текст метки или массив с текстом и параметрами.
массив $options

Параметры элемента метки. Параметр 'NONE' устарел и будет удален в версии 3.0

Возвращает

строка
Сгенерированный элемент метки

_getModel()source protected

_getModel( string $model )

Определяет расположение модели на основе ее имени и пытается создать новый экземпляр или получить уже созданный экземпляр модели.

Параметры

строка $model
Имя модели.

Возвращает

Model|null
Экземпляр модели

_initInputField()source protected

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

Устанавливает значения по умолчанию для поля и добавляет поле в хэш безопасности формы. Также добавит класс 'form-error', если поле содержит ошибки валидации.

Параметры

  • secure - логическое значение, определяющее, следует ли добавлять поле в поля безопасности. Отключение поля с помощью параметра disabled, также исключит поле из хэшированного ключа.

Этот метод преобразует числовой индексированный 'disabled' в ассоциативное значение. Внутренности FormHelper ожидают ассоциативные параметры.

Параметры

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

Возвращает

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

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

Helper::_initInputField()

_inputLabel()source protected

_inputLabel( string $fieldName , string|array $label , array $options )

Генерирует метку для вызова input().

$options может содержать хэш переопределений id. Эти переопределения будут использоваться вместо сгенерированных значений, если они присутствуют.

Параметры

строка $fieldName
Имя поля.
строка|массив $label
Текст метки или массив с текстом и параметрами.
массив $options

Параметры элемента метки. Параметр 'NONE' устарел и будет удален в версии 3.0

Возвращает

строка
Сгенерированный элемент метки

_introspectModel()source 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
Имя поля модели, из которого необходимо получить информацию

Возвращает

смешанное
Информация, извлеченная для специального ключа и поля в модели
END_OF_DOCUMENT_MARKER

_isRequiredField()source protected

_isRequiredField( CakeValidationSet $validationRules )

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

Параметры

CakeValidationSet $validationRules
Правила валидации.

Возвращает

boolean
true, если поле требуется заполнить, иначе false

_lastAction()source protected

_lastAction( string|array $url )

Устанавливает последний созданный action формы.

Параметры

string|array $url
URL.

_magicOptions()source protected

_magicOptions( array $options )

Магически устанавливает тип параметра и соответствующие параметры

Параметры

array $options
Список параметров.

Возвращает

array

_maxLength()source protected

_maxLength( array $options )

Вычисляет параметр maxlength

Параметры

array $options
Список параметров.

Возвращает

array

_name()source protected

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

Получает имя поля ввода для текущего тега

Параметры

array $options необязательно array()
Список параметров.
string $field необязательно null
Имя поля.
string $key необязательно 'name'
Имя ключа.

Возвращает

array

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

Helper::_name()

_optionsOptions()source protected

_optionsOptions( array $options )

Генерирует список параметров для множественного выбора

Параметры

array $options
Список параметров.

Возвращает

array

_parseOptions()source protected

_parseOptions( array $options )

Генерирует массив параметров для ввода

Параметры

array $options
Список параметров.

Возвращает

array
Параметры

_secure()source protected

_secure( boolean $lock , string|array $field null , mixed $value null )

Определяет, какие поля формы должны быть использованы для хэша. Заполняет $this->fields

Параметры

boolean $lock

Включать ли это поле в валидацию или исключить как часть unlockedFields.

string|array $field необязательно null
Ссылка на поле, которое нужно защитить. Должно быть разделено точками для указания вложенности.
mixed $value необязательно null
Значение поля, если значение не должно быть изменено.

_secureFieldName()source protected

_secureFieldName( array $options )

Получает имя поля для использования с _secure().

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

Параметры

array $options
Массив параметров, возможно содержащий ключ name.

Возвращает

string|null

_selectOptions()source 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.

Возвращает

array

button()source 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/en/core-libraries/helpers/form.html#FormHelper::button

checkbox()source public

checkbox( string $fieldName , array $options array() )

Создает виджет поля checkbox.

Параметры:

  • value - значение checkbox
  • checked - boolean, указывает, что этот checkbox выбран.
  • hiddenField - boolean, указывает, нужно ли включать скрытый ввод со значением ''.
  • disabled - создать отключенное поле.
  • default - установить значение по умолчанию для checkbox. Это позволяет начать с выбранных checkbox, без необходимости проверки данных POST. Соответствующее значение POST перезапишет значение по умолчанию.

Параметры

string $fieldName
Имя поля, например "Modelname.fieldname"
array $options необязательно array()
Массив атрибутов HTML.

Возвращает

string
Элемент HTML текстового поля.

Ссылка

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

create()source public

create( mixed|null $model null , array $options array() )

Возвращает элемент HTML FORM.

Параметры:

  • type Метод формы по умолчанию POST
  • action Действие контроллера, к которому отправляется форма (необязательно). Устарело с версии 2.8, используйте url.
  • url URL, к которому отправляется форма. Может быть строкой или массивом 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|null $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-create
END_OF_DOCUMENT_MARKER

dateTime()source 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().

Параметры

строка $fieldName
Префикс имени для элемента SELECT
строка $dateFormat необязательно 'DMY'
DMY, MDY, YMD или null, чтобы не генерировать вводы даты.
строка $timeFormat необязательно '12'
12, 24 или null, чтобы не генерировать вводы времени.
массив $attributes необязательно array()
Массив атрибутов

Возвращает

строка
Сгенерированный набор выпадающих списков для выбранных форматов даты и времени.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::dateTime

day()source public

day( string $fieldName null , array $attributes array() )

Возвращает элемент SELECT для дней.

Атрибуты:

  • empty - Если true, пустой элемент выбора отображается. Если строка, эта строка отображается как пустой элемент.
  • value Выбранное значение ввода.

Параметры

строка $fieldName необязательно null
Префикс имени для элемента SELECT
массив $attributes необязательно array()
Атрибуты HTML для элемента select

Возвращает

строка
Сгенерированный выпадающий список дня.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::day

domIdSuffix()source public

domIdSuffix( string $value , string $type 'html4' )

Генерирует допустимый суффикс ID DOM из строки. Также избегает коллизий, когда несколько значений преобразуются в один и тот же суффикс, добавляя числовое значение.

Для идентификаторов до HTML5 допустимы только символы a-z 0-9 - _ . HTML5 не имеет такого ограничения, но для предотвращения проблем с макетом все равно отфильтровывает некоторые чувствительные символы.

Параметры

строка $value
Значение, которое должно быть передано в суффикс ID DOM.
строка $type необязательно 'html4'
Тип документа, который нужно использовать. По умолчанию html4.

Возвращает

строка
ID DOM

end()source 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, таких как «форма»

Параметры

строка|массив $options необязательно null
в качестве строки будет использовать $options как значение кнопки,
массив $secureAttributes необязательно array()

будет передан как атрибут html в скрытые элементы ввода, сгенерированные для компонента Security.

Возвращает

строка
закрывающий тег FORM, необязательная кнопка отправки.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#closing-the-form

error()source public

error( string $field , string|array $text null , array $options array() )

Возвращает отформатированное сообщение об ошибке для указанного поля формы, NULL, если ошибок нет.

Параметры:

  • escape boolean - Нужно ли экранировать содержимое сообщения об ошибке.
  • wrap mixed - Нужно ли обернуть сообщение об ошибке в div. Если строка, будет использоваться как HTML-тег.
  • class строка - Имя класса для сообщения об ошибке.

Параметры

строка $field
Имя поля, например "Modelname.fieldname"
строка|массив $text необязательно null

Сообщение об ошибке в виде строки или массива сообщений. Если массив содержит attributes ключ, он будет использован как параметры для контейнера ошибки.

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

Параметры рендеринга для

тега-контейнера

Возвращает

строка|null
Если есть ошибки, этот метод возвращает сообщение об ошибке, иначе null.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::error

file()source public

file( string $fieldName , array $options array() )

Создает виджет ввода файла.

Параметры

строка $fieldName
Имя поля в формате "Modelname.fieldname"
массив $options необязательно array()
Массив атрибутов HTML.

Возвращает

строка
Сгенерированный ввод файла.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::file

hidden()source public

hidden( string $fieldName , array $options array() )

Создает скрытое поле ввода.

Параметры

строка $fieldName
Имя поля в формате "Modelname.fieldname"
массив $options необязательно array()
Массив атрибутов HTML.

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::hidden

hour()source public

hour( string $fieldName , boolean $format24Hours false , array $attributes array() )

Возвращает элемент SELECT для часов.

Атрибуты:

  • empty - Если true, пустой элемент выбора отображается. Если строка, эта строка отображается как пустой элемент.
  • value Выбранное значение ввода.

Параметры

строка $fieldName
Префикс имени для элемента SELECT
boolean $format24Hours необязательно false
True для 24-часового формата
массив $attributes необязательно array()
Список атрибутов HTML

Возвращает

строка
Заполненный элемент выбора часов

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::hour

input()source public

input( string $fieldName , array $options array() )

Генерирует элемент ввода формы, включая метку и обертывающую div

Параметры

См. каждый метод типа поля для получения дополнительной информации. Любые параметры, являющиеся частью $attributes или $options для различных методов type, могут быть включены в $options для input(). Кроме того, любые неизвестные ключи, которые не находятся в списке ниже или не являются частью параметров выбранного типа, будут обрабатываться как обычные атрибуты html для сгенерированного input.

  • type - Принудительно устанавливает тип виджета. Например, type => 'select'
  • label - Либо строка метки, либо массив параметров для метки. См. FormHelper::label().
  • div - Либо false для отключения div, либо массив параметров для div. См. HtmlHelper::div() для получения дополнительных параметров.
  • options - Для виджетов, которые принимают параметры (например, radio, select).
  • error - Управление сообщением об ошибке. Установите значение false для отключения любого вида отчётов об ошибках (ошибки поля и сообщения об ошибках).
  • errorMessage - Логическое значение для управления рендерингом сообщений об ошибках (ошибка поля всё равно произойдёт).
  • empty - Строка или логическое значение для включения пустых опций выпадающего списка.
  • before - Содержимое, которое должно быть расположено перед меткой + вводом.
  • after - Содержимое, которое должно быть расположено после метки + ввода.
  • between - Содержимое, которое должно быть расположено между меткой + вводом.
  • format - Шаблон форматирования порядка элементов. Любой элемент, который не находится в массиве, не будет находиться в выводе.
  • Порядок элементов по умолчанию для input: массив ('before', 'label', 'between', 'input', 'after', 'error')
  • Порядок элементов по умолчанию для checkbox: массив ('before', 'input', 'between', 'label', 'after', 'error')
  • Формат скрытых input не будет форматироваться
  • У радиокнопок нельзя управлять порядком элементов input и label с помощью этих настроек.

Параметры

строка $fieldName
Должно быть "Modelname.fieldname"
массив $options необязательный array()
Каждый тип input принимает разные параметры.

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

строка
Завершенный виджет формы.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#creating-form-elements

inputDefaults()source public

inputDefaults( array $defaults null , boolean $merge false )

Установить/получить inputDefaults для элементов формы

Параметры

массив $defaults необязательный null
Новые значения по умолчанию
логическое значение $merge необязательный false
Объединить со значениями по умолчанию

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

массив
inputDefaults

inputs()source 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 можно использовать для управления рендерингом легенды и области. $this->Form->inputs('My legend'); сгенерирует набор вводов со специальной легендой. Передача fieldset и legend ключей в массив $fields устарела начиная с версии 2.3. Для более точного контроля используйте ключи fieldset и legend в параметре $options.

Параметры

массив $fields необязательный null
Массив полей для генерации вводов, или null.
массив $blacklist необязательный null
Простой массив полей, для которых не должны создаваться вводы.
массив $options необязательный array()

Массив параметров. Допустимые ключи: - fieldset Установите в false для отключения области. Если указана строка, она будет использоваться в качестве имени класса для элемента области. - legend Установите в false для отключения легенды для сгенерированного набора вводов. Или укажите строку для настройки текста легенды.

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

строка
Завершенные вводы формы.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::inputs

isFieldError()source public

isFieldError( string $field )

Возвращает true, если для данного поля есть ошибка, в противном случае false

Параметры

строка $field
Должно быть "Modelname.fieldname"

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

логическое значение
Если есть ошибки, этот метод возвращает true, иначе false.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::isFieldError

label()source 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
Должно быть "Modelname.fieldname"
строка $text необязательный null

Текст, который будет отображаться в поле метки. Если $text не определен, текст будет инфлектирован из имени поля.

массив|строка $options необязательный array()
Массив HTML-атрибутов или строка, используемая в качестве имени класса.

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

строка
Отформатированный элемент LABEL.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::label

meridian()source public

meridian( string $fieldName , array $attributes array() )

Возвращает элемент SELECT для AM или PM.

Атрибуты:

  • empty - Если true, пустая опция select показана. Если строка, эта строка отображается как пустой элемент.
  • value Выбранное значение ввода.

Параметры

строка $fieldName
Префикс имени для элемента SELECT
массив $attributes необязательный array()
Массив атрибутов

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

строка
Завершенный select ввода meridian

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::meridian

minute()source public

minute( string $fieldName , array $attributes array() )

Возвращает элемент SELECT для минут.

Атрибуты:

  • empty - Если true, пустая опция select показана. Если строка, эта строка отображается как пустой элемент.
  • value Выбранное значение ввода.

Параметры

строка $fieldName
Префикс имени для элемента SELECT
массив $attributes необязательный array()
Массив атрибутов

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

строка
Завершенный select ввода минут.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::minute

month()source public

month( string $fieldName , array $attributes array() )

Возвращает элемент SELECT для месяцев.

Атрибуты:

  • monthNames — Если false, будут использоваться двузначные числа вместо текста. Если массив, будет использован переданный массив.
  • empty — Если true, отображается пустой элемент выбора. Если строка, эта строка отображается как пустой элемент.
  • value — Выбранное значение поля ввода.

Параметры

строка $fieldName
Префикс имени для элемента SELECT
массив $attributes необязательно массив()
Атрибуты для элемента select

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

строка
Сгенерированный выпадающий список выбора месяца.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::month

postButton()source 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 атрибутов.

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

строка
Тег HTML кнопки.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::postButton

postLink()source 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', чтобы смоделировать запрос DELETE HTTP/1.1. По умолчанию 'post'.
  • confirm — Может быть использован вместо $confirmMessage.
  • inline — Включить или отключить отображение тега формы inline. Установите в false, чтобы добавить тег формы в блок представления 'postLink'. По умолчанию true.
  • block — Выберите пользовательский блок для добавления тега формы. Использование этой опции переопределит опцию inline.
  • Другие опции такие же, как и в методе HtmlHelper::link().
  • Опция onclick будет заменена.

Параметры

строка $title
Содержимое, которое будет обернуто тегами .
строка|массив $url необязательно null
Cake-относительный URL или массив параметров URL, или внешний URL (начинается с http://)
массив $options необязательно массив()
Массив HTML атрибутов.
логическое значение|строка $confirmMessage необязательно false

Сообщение подтверждения JavaScript. Этот аргумент устарел начиная с версии 2.6. Используйте ключ confirm в $options вместо него.

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

элемент <a />

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::postLink

radio()source 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 — Управление наличием области ввода (fieldset) и легенды (legend) в наборе виджетов.
  • fieldset — Устанавливает класс для области ввода. Область ввода генерируется только если задана легенда.
  • value — Указывает значение, которое должно быть отмечено.
  • label — Логическое значение, указывающее, должны ли отображаться метки для виджетов.
  • hiddenField — Логическое значение, указывающее, нужно ли включать скрытый элемент ввода со значением '' в результат radio(). Это полезно для создания наборов радио-кнопок, где значения не являются непрерывными.
  • disabled — Установите в true или disabled для отключения всех радио-кнопок.
  • empty — Установите в true для создания элемента ввода со значением '' в качестве первого варианта. Если установлено true, метка радио-кнопки будет 'пустое значение'. Задайте эту опцию строкой для управления значением метки.

Параметры

строка $fieldName
Имя поля, например "Modelname.fieldname"
массив $options необязательно массив()
Массив опций радио-кнопок.
массив $attributes необязательно массив()
Массив HTML атрибутов и специальных атрибутов, перечисленных выше.

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

завершённый набор виджетов радио-кнопок.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

secure()source public

secure( array|null $fields array() , array $secureAttributes array() )

Генерирует скрытое поле с хэшем безопасности, основанным на полях, используемых в форме.

Если задан $secureAttributes, эти HTML атрибуты будут объединены со скрытыми элементами ввода, сгенерированными для компонента Security. Это особенно полезно для установки HTML5 атрибутов, таких как 'form'.

Параметры

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

Если задан, указывает список полей, которые нужно использовать при генерации хэша. В противном случае используется $this->fields.

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

будет передан как HTML атрибуты скрытым элементам ввода, сгенерированным для компонента Security.

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

строка|null
Скрытое поле ввода с хэшем безопасности, в противном случае null.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::secure

select()source public

select( string $fieldName , array $options array() , array $attributes array() )

Возвращает отформатированный элемент SELECT.

Атрибуты:

  • showParents - Если включено в массив и установлено в true, для родителя каждой группы опций будет добавлен дополнительный элемент опции. Вы можете установить опцию с тем же именем, и её ключ будет использован в качестве значения опции.
  • multiple - отобразить многострочный элемент выбора. Если установлено в 'checkbox', будут созданы несколько флажков вместо поля выбора.
  • empty - Если true, отображается пустая опция выбора. Если строка, эта строка отображается в качестве пустого элемента.
  • escape - Если true, содержимое опций будет закодировано в HTML-сущности. По умолчанию true.
  • value - Выбранное значение поля ввода.
  • class - При использовании multiple = checkbox имя класса для применения к div. По умолчанию 'checkbox'.
  • disabled - Управление атрибутом disabled. При создании поля выбора, установите в true для отключения поля выбора. При создании флажков, true отключит все флажки. Вы также можете установить disabled в список значений, которые нужно отключить при создании флажков.

Использование опций

Простой массив создаст обычные опции:

$options = array(1 => 'one', 2 => 'two);
$this->Form->select('Model.field', $options));

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

$options = array(
 1 => 'bill',
 'fred' => array(
    2 => 'fred',
    3 => 'fred jr.'
 )
);
$this->Form->select('Model.field', $options);

В приведенном выше примере 2 => 'fred' не сгенерирует элемент опции. Вы должны включить атрибут showParents для отображения опции fred.

Если у вас есть несколько опций, которым нужно иметь одинаковый атрибут value, вы можете использовать массив массивов для выражения этого:

$options = array(
 array('name' => 'United states', 'value' => 'USA'),
 array('name' => 'USA', 'value' => 'USA'),
);

Параметры

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

Массив элементов OPTION (в виде пар 'значение'=>'Текст'), которые будут использоваться в элементе SELECT

массив $attributes необязательно массив()
Атрибуты HTML элемента select.

Возвращает

строка
Отформатированный элемент SELECT

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

submit()source public

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

Создает элемент кнопки отправки. Этот метод сгенерирует элементы <input /> которые можно использовать для отправки и сброса форм, используя $options. Кнопки с изображением можно создать, указав путь к изображению для $caption.

Опции

  • div - Включить обёртывающий div? По умолчанию true. Принимает подопции, аналогичные FormHelper::input().
  • before - Содержимое, включаемое перед полем ввода.
  • after - Содержимое, включаемое после поля ввода.
  • type - Установите в 'reset' для кнопок сброса. По умолчанию 'submit'
  • confirm - Сообщение подтверждения JavaScript.
  • Другие атрибуты будут присвоены элементу ввода.

Опции

  • div - Включить обёртывающий div? По умолчанию true. Принимает подопции, аналогичные FormHelper::input().
  • Другие атрибуты будут присвоены элементу ввода.

Параметры

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

Текст метки на кнопке ИЛИ, если строка содержит :// или расширение .jpg, .jpe, .jpeg, .gif, .png, используйте изображение, если расширение существует, и первая буква /, изображение относительно webroot, ИЛИ если первая буква не /, изображение относительно webroot/img.

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

Возвращает

строка
Элемент HTML кнопки отправки

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::submit

tagIsInvalid()source public

tagIsInvalid( )

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

Возвращает

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

Либо false, когда нет ошибок, либо массив строк об ошибках. Строка об ошибке может быть ''.


Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::tagIsInvalid

textarea()source public

textarea( string $fieldName , array $options array() )

Создает элемент текстового поля.

Опции:

  • escape - Нужно ли кодировать содержимое текстового поля. По умолчанию true.

Параметры

строка $fieldName
Имя поля в формате "ИмяМодели.ИмяПоля"
массив $options необязательно массив()
Массив атрибутов HTML и специальных опций, описанных выше.

Возвращает

строка
Сгенерированный элемент текстового поля HTML

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::textarea

unlockField()source public

unlockField( string $name null )

Добавляет или получает список полей, которые в настоящее время не заблокированы. Незаблокированные поля не включены в хеш полей, используемых SecurityComponent. Разблокировка поля, после его добавления в список защищенных полей, удалит его из списка полей.

Параметры

строка $name необязательно null
Имя поля через точку.

Возвращает

смешанный тип
Либо null, либо список полей.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::unlockField

year()source public

year( string $fieldName , integer $minYear null , integer $maxYear null , array $attributes array() )

Возвращает элемент SELECT для годов

Атрибуты:

  • empty - Если true, отображается пустая опция выбора. Если строка, эта строка отображается в качестве пустого элемента.
  • orderYear - Порядок значений года в элементах select. Возможные значения 'asc', 'desc'. По умолчанию 'desc'
  • value - Выбранное значение поля ввода.

Параметры

строка $fieldName
Префикс имени для элемента SELECT
целое число $minYear необязательно null
Первый год в последовательности
целое число $maxYear необязательно null
Последний год в последовательности
массив $attributes необязательно массив()
Массив атрибутов для элементов select.

Возвращает

строка
Заполненный элемент ввода select для года

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/form.html#FormHelper::year

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

__get()source public

__get( string $name )

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

Устарело

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

Параметры

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

Возвращает

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

__set()source public

__set( string $name , mixed $value )

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

Устарело

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
Код, выполняемый после выбора пользователем 'ОК'
строка $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
Определяет, нужно ли экранировать значение

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

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

_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 Значение False предотвратит обработку пути как плагина

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

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

beforeLayout()source public

beforeLayout( string $layoutFile )

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

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

Параметры

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

beforeRender()source public

beforeRender( string $viewFile )

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

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

Параметры

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

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

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

Параметры

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

clean()source public

clean( string|array $output )

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

Устаревший

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

Параметры

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

Возвращает

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

domId()source public

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

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

Параметры

array|string $options необязательно null

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

string $id необязательно 'id'
Имя атрибута 'id'.

Возвращает

mixed

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


entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

string

model()source public

model( )

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

Возвращает

string

output()source public

output( string $str )

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

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

Устаревший

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

Параметры

string $str
Строка, которая должна быть выведена.

Возвращает

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

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

url()source public

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

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

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

Параметры

string|array $url необязательно null

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

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

Возвращает

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

Ссылка

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

value()source public

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

Получает данные для текущего тега

Параметры

array|string $options необязательно array()

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

string $field необязательно null
Имя поля.
string $key необязательно 'value'
Имя атрибута, который нужно установить, по умолчанию 'value'

Возвращает

mixed

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


webroot()source public

webroot( string $file )

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

Параметры

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

Возвращает

string
Веб-доступный путь к файлу.

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

_mergeVars()source protected

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

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

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

Параметры

array $properties
Имя свойств для объединения.
string $class
Класс для объединения свойства с.
boolean $normalize необязательно true
Установите в true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

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

Параметры

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

dispatchMethod()source public

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

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

Параметры

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

Возвращает

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

log()source public

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

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

Параметры

string $msg
Сообщение журнала
integer $type необязательно LOG_ERR
Постоянная типа ошибки. Определена в app/Config/core.php.
null|string|array $scope необязательно null

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

Возвращает

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

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

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

Возвращает

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

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

$_domIdSuffixessource

protected массив

Содержит уже используемые суффиксы ID DOM, чтобы избежать коллизий с несколькими элементами формы.

array()

$_inputDefaultssource

protected массив

Постоянные значения по умолчанию, используемые input(). Устанавливаются FormHelper::create().

array()

$_lastActionsource

protected строка

Значение атрибута action последней созданной формы. Используется для создания хэшей, специфичных для формы/запроса, для SecurityComponent.

''

$_modelssource

protected массив

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

array()

$_optionssource

protected массив

Параметры, используемые для полей DateTime

array(
    'day' => array(), 'minute' => array(), 'hour' => array(),
    'month' => array(), 'year' => array(), 'meridian' => array()
)

$_unlockedFieldssource

protected массив

Массив имён полей, которые были исключены из хэша Token, используемого методом validatePost SecurityComponent.

См. также

FormHelper::_secure()
SecurityComponent::validatePost()
array()

$defaultModelsource

public строка

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

null

$fieldssource

public массив

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

array()

$helperssource

public массив

Другие помощники, используемые FormHelper

array('Html')

$requestTypesource

public строка

Определяет тип создаваемой формы. Устанавливается FormHelper::create().

null

$validationErrorssource

public массив

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

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.8/class-FormHelper.html

Spec-Zone.ru

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