Класс 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: Путь с точкой для проверки ошибок.

Возвращает

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

Реализация

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

isCreate()source public

isCreate( )

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

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

Возвращает

boolean

Реализация

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

isPrimaryKey()source public

isPrimaryKey( string $field )

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

Параметры

строка $field: Путь с точкой к полю, для которого нужно значение.

Возвращает

boolean

Реализация

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

isRequired()source public

isRequired( string $field )

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

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

Параметры

строка $field: Путь с точкой для проверки обязательности.

Возвращает

boolean

Реализация

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: Логическое значение, указывающее, использовать ли значение по умолчанию из схемы контекста, если оно не указано явно.

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

mixed

Реализация

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

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

$_contextsource

protected массив

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

$_requestsource

protected Cake\Http\ServerRequest

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

© 2005–present 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.6/class-Cake.View.Form.ArrayContext.html