Класс 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

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

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

$_context protected

array
Данные контекста для этого объекта.
$_request protected

Cake\Http\ServerRequest
Объект запроса.

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

__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, если данная форма предназначена для операции создания.

Для того, чтобы этот метод возвращал 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'.

Параметры

string $field: Путь к полю с точкой, для которого нужно значение.
array $options необязательно []: Параметры: - default: Значение по умолчанию, которое будет возвращено, если значение не найдено в данных запроса или записи контекста. - schemaDefault: Булево значение, указывающее, следует ли использовать значение по умолчанию из схемы контекста, если оно явно не указано.

Возвращает

mixed

Реализация

Cake\View\Form\ContextInterface::val()

Подробности свойств

$_contextsource

protected array

Данные контекста для этого объекта.

$_requestsource

protected Cake\Http\ServerRequest

Объект запроса.

© 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.4/class-Cake.View.Form.ArrayContext.html