Класс ArrayContext
Предоставляет базовый контекст поставщика на основе массива для FormHelper.
Этот адаптер полезен при тестировании или когда у вас есть формы, основанные на простых структурах данных массивов.
Важные ключи:
-
defaultsЗначения по умолчанию для полей. Эти значения будут использованы, когда данные запроса не заданы. Данные должны быть вложены, следуя путям с разделителями точек, которые вы используете для доступа к своим полям. -
requiredВложенный массив полей, отношений и логических флагов, указывающих, является ли поле обязательным. -
schemaМассив данных, имитирующих структуры столбцов, которые использует Cake\Database\Schema\Schema. Этот массив позволяет управлять выведенным типом для полей и позволяет автоматически генерировать атрибуты, такие как maxlength, step и другие атрибуты HTML. Если вы хотите, чтобы работало распознавание первичного ключа/id, убедитесь, что вы предоставили массив_constraints, содержащийprimary. Смотрите пример ниже. -
errorsМассив ошибок валидации. Ошибки должны быть вложены, следуя путям с разделителями точек, которые вы используете для доступа к своим полям.Пример
$data = [ 'schema' => [ 'id' => ['type' => 'integer'], 'title' => ['type' => 'string', 'length' => 255], '_constraints' => [ 'primary' => ['type' => 'primary', 'columns' => ['id']] ] ], 'defaults' => [ 'id' => 1, 'title' => 'First post!', ] ];
- Cake\View\Form\ArrayContext реализует Cake\View\Form\ContextInterface
Краткое описание свойств
Краткое описание методов
- __construct() publicКонструктор.
- attributes() publicПолучить ассоциативный массив дополнительных атрибутов для имени поля.
- error() publicПолучить ошибки для заданного поля
- fieldNames() publicПолучить имена полей верхнего уровня в этом контексте.
- hasError() publicПроверить, есть ли у поля ошибка
- isCreate() publicВозвращает, является ли эта форма для операции создания.
- isPrimaryKey() publicВозвращает true, если переданное имя поля является частью первичного ключа для этого контекста
- isRequired() publicПроверить, является ли заданное поле 'обязательным'.
- primaryKey() publicПолучить поля, используемые в контексте в качестве первичного ключа.
- stripNesting() protectedУдаляет любое числовое вложение
- type() publicПолучить абстрактный тип поля для заданного имени поля.
- val() publicПолучить текущее значение для заданного поля.
Подробное описание методов
__construct()source public
__construct( Cake\Http\ServerRequest $request , array $context )
Конструктор.
Параметры
-
Cake\Http\ServerRequest$request - Объект запроса.
- массив
$context - Информация о контексте.
attributes()source public
attributes( string $field )
Получить ассоциативный массив дополнительных атрибутов для имени поля.
Параметры
- строка
$field - Путь с разделителями точек для получения дополнительных данных.
Возвращает
массивМассив данных, описывающих дополнительные атрибуты поля.
Реализация
Cake\View\Form\ContextInterface::attributes() error()source public
error( string $field )
Получить ошибки для заданного поля
Параметры
- строка
$field - Путь с разделителями точек для проверки ошибок.
Возвращает
массивМассив ошибок, пустой массив будет возвращен, когда контекст не содержит ошибок.
Реализация
Cake\View\Form\ContextInterface::error() fieldNames()source public
fieldNames( )
Получить имена полей верхнего уровня в этом контексте.
Возвращает
массивСписок имен полей в контексте.
Реализация
Cake\View\Form\ContextInterface::fieldNames() hasError()source public
hasError( string $field )
Проверить, есть ли у поля ошибка
Параметры
- строка
$field - Путь с разделителями точек для проверки ошибок.
Возвращает
булевоВозвращает true, если массив ошибок для поля не пуст.
Реализация
Cake\View\Form\ContextInterface::hasError() isCreate()source public
isCreate( )
Возвращает, является ли эта форма для операции создания.
Для того, чтобы этот метод возвращал true, ограничение первичного ключа должно быть определено в данных 'schema', а данные 'defaults' должны содержать значение для всех полей в ключе.
Возвращает
булевоРеализация
Cake\View\Form\ContextInterface::isCreate() isPrimaryKey()source public
isPrimaryKey( string $field )
Возвращает true, если переданное имя поля является частью первичного ключа для этого контекста
Параметры
- строка
$field Путь с разделителями точек к полю, для которого нужно значение.
Возвращает
булевоРеализация
Cake\View\Form\ContextInterface::isPrimaryKey() isRequired()source public
isRequired( string $field )
Проверить, является ли заданное поле 'обязательным'.
В этом классе контекста это определяется массивом 'required'.
Параметры
- строка
$field - Путь с разделителями точек для проверки обязательности.
Возвращает
булевоРеализация
Cake\View\Form\ContextInterface::isRequired() primaryKey()source public
primaryKey( )
Получить поля, используемые в контексте в качестве первичного ключа.
Возвращает
массивРеализация
Cake\View\Form\ContextInterface::primaryKey() stripNesting()source protected
stripNesting( string $field )
Удаляет любое числовое вложение
Например, users.0.age выведет как users.age
Параметры
- строка
$field - Путь с разделителями точек
Возвращает
строкаСтрока со удалённым числовым вложением
type()source public
type( string $field )
Получить абстрактный тип поля для заданного имени поля.
Параметры
- строка
$field - Путь с разделителями точек для получения типа схемы.
Возвращает
null|строкаАбстрактный тип данных или null.
См.
Cake\Database\TypeРеализация
Cake\View\Form\ContextInterface::type() val()source public
val( string $field , array $options [] )
Получить текущее значение для заданного поля.
Этот метод объединит текущие данные запроса и массив 'defaults'.
Параметры
- строка
$field Путь к полю, для которого требуется значение, разделенный точками.
- массив
$optionsнеобязательно [] Опции: -
default: Значение по умолчанию, которое будет возвращено, если значение не найдено в данных запроса или записи контекста. -schemaDefault: Логическое значение, указывающее, следует ли использовать значение по умолчанию из схемы контекста, если оно не указано явно.
Возвращает
смешанный типРеализация
Cake\View\Form\ContextInterface::val() Подробное описание свойств
© 2005–2018 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.5/class-Cake.View.Form.ArrayContext.html