Spec-Zone.ru › CakePHP 3.2

Класс 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
Пространство имен: Cake\View\Form
Расположение: View/Form/ArrayContext.php

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

  • $_context protected
    array
    Данные контекста для этого объекта.
  • $_request protected
    Cake\Network\Request
    Объект запроса.

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

  • __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()

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

$_contextsource

protected массив

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

$_requestsource

protected Cake\Network\Request

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

© 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

Spec-Zone.ru

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