Класс ArrayContext
Предоставляет базовый контекст поставщик на основе массива для FormHelper.
Этот адаптер полезен при тестировании или когда у вас есть формы, основанные на простых структурах данных массива.
Важные ключи:
-
defaultsЗначения по умолчанию для полей. Эти значения будут использоваться, когда данные запроса не заданы. Данные должны быть вложены, следуя путям с разделителями точек, с которыми вы обращаетесь к своим полям. -
requiredВложенный массив полей, отношений и логических флагов, указывающих, является ли поле обязательным. -
schemaМассив данных, эмулирующих структуры столбцов, которые использует Cake\Database\Schema\Table. Этот массив позволяет контролировать тип, определяемый для полей, и позволяет автоматически генерировать атрибуты, такие как 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Получение полей, используемых в контексте, как первичный ключ.
- type() publicПолучение абстрактного типа поля для заданного имени поля.
- val() publicПолучение текущего значения для заданного поля.
Подробное описание методов
__construct()source public
__construct( Cake\Network\Request $request , array $context )
Конструктор.
Параметры
-
Cake\Network\Request$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() type()source public
type( string $field )
Получение абстрактного типа поля для заданного имени поля.
Параметры
- строка
$field - Путь с разделителями точек для получения типа схемы.
Возвращаемое значение
null|строкаАбстрактный тип данных или null.
См. также
Cake\Database\TypeРеализация
Cake\View\Form\ContextInterface::type() val()source public
val( string $field )
Получение текущего значения для заданного поля.
Этот метод объединит текущие данные запроса и массив 'defaults'.
Параметры
- строка
$field Путь с разделителями точек к полю, для которого нужно получить значение.
Возвращаемое значение
смешанныйРеализация
Cake\View\Form\ContextInterface::val() Подробное описание свойств
© 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/3.2/class-Cake.View.Form.ArrayContext.html