Spec-Zone.ru › CakePHP 3.3

Интерфейс ContextInterface

Интерфейс для реализаций контекста FormHelper.

Прямые реализаторы

  • Cake\View\Form\ArrayContext
  • Cake\View\Form\EntityContext
  • Cake\View\Form\FormContext
  • Cake\View\Form\NullContext
Пространство имён: Cake\View\Form
Расположение: View/Form/ContextInterface.php

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

  • attributes() public
    Получить ассоциативный массив дополнительных атрибутов для имени поля.
  • error() public
    Получить ошибки для заданного поля.
  • fieldNames() public
    Получить имена полей верхнего уровня в этом контексте.
  • hasError() public
    Проверить, есть ли ошибка, связанная с полем.
  • isCreate() public
    Возвращает true, если эта форма предназначена для операции создания.
  • isPrimaryKey() public
    Возвращает true, если переданное имя поля является частью первичного ключа для данного контекста.
  • isRequired() public
    Проверить, является ли заданное поле обязательным.
  • primaryKey() public
    Получить поля, используемые в контексте в качестве первичного ключа.
  • type() public
    Получить абстрактный тип поля для заданного имени поля.
  • val() public
    Получить текущее значение для заданного поля.

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

attributes()source public

attributes( string $field )

Получить ассоциативный массив дополнительных атрибутов для имени поля.

Параметры

string $field
Путь с разделителями «.» для получения дополнительных данных.

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

array
Массив данных, описывающих дополнительные атрибуты поля.

error()source public

error( string $field )

Получить ошибки для заданного поля

Параметры

string $field
Путь с разделителями «.» для проверки ошибок.

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

array

Массив ошибок, пустой массив будет возвращён, когда в контексте нет ошибок.


fieldNames()source public

fieldNames( )

Получить имена полей верхнего уровня в этом контексте.

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

array
Список имён полей в контексте.

hasError()source public

hasError( string $field )

Проверить, есть ли ошибка, связанная с полем

Параметры

string $field
Путь с разделителями «.» для проверки ошибок.

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

boolean
Возвращает true, если массив ошибок для поля не пустой.

isCreate()source public

isCreate( )

Возвращает true, если эта форма предназначена для операции создания.

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

boolean

isPrimaryKey()source public

isPrimaryKey( string $field )

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

Параметры

string $field

Путь с разделителями «.» к полю, для которого требуется значение.

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

boolean

isRequired()source public

isRequired( string $field )

Проверить, является ли заданное поле обязательным.

В этом классе контекста это просто определяется массивом 'required'.

Параметры

string $field
Путь с разделителями «.» для проверки обязательности.

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

boolean

primaryKey()source public

primaryKey( )

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

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

array

type()source public

type( string $field )

Получить абстрактный тип поля для заданного имени поля.

Параметры

string $field
Путь с разделителями «.» для получения типа схемы.

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

null|string
Абстрактный тип данных или null.

См.

Cake\Database\Type

val()source public

val( string $field )

Получить текущее значение для заданного поля.

Классы, реализующие этот метод, могут иметь второй аргумент $options. Действительные ключи для массива $options:

  • default: Значение по умолчанию, которое будет возвращено, если значение не найдено в данных запроса или записи контекста.
  • schemaDefault: Булево значение, указывающее, следует ли использовать значение по умолчанию из схемы контекста, если оно не указано явно.

Параметры

string $field

Путь с разделителями «.» к полю, для которого требуется значение.

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

mixed

© 2005–2017 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.
https://api.cakephp.org/3.3/class-Cake.View.Form.ContextInterface.html

Spec-Zone.ru

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