Класс EntityContext

__construct()source public

__construct( Cake\Http\ServerRequest $request , array $context )

Конструктор.

Параметры

Cake\Http\ServerRequest $request

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

массив $context

Информация о контексте.

_extractMultiple()source protected

_extractMultiple( array|Traversable $values , array $path )

Вспомогательный метод, используемый для извлечения всех значений первичного ключа из массива. Столбец первичного ключа определяется из массива $path.

Параметры

массив|Итерируемый объект $values

Список, из которого необходимо извлечь первичные ключи

массив $path

Каждый из элементов в пути к имени поля

Возвращает

массив|null

_getProp()source protected

_getProp( mixed $target , string $field )

Чтение значений свойств или обход массивов/итераторов.

Параметры

смешанный $target

Сущность/массив/коллекция, из которой извлекается $field.

строка $field

Следующее поле для извлечения.

Возвращает

смешанный

_getTable()source protected

_getTable( array $parts , boolean $fallback = true )

Получение экземпляра таблицы по пути к свойству

Параметры

массив $parts

Каждый из элементов в пути к имени поля

булево $fallback optional true

Использовать ли обратное значение к последней найденной таблице при встрече несуществующего поля/свойства.

Возвращает

Cake\ORM\Table|булево
Экземпляр таблицы или false

_getValidator()source protected

_getValidator( array $parts )

Получение валидатора, связанного с сущностью, на основе соглашений об именовании.

Параметры

массив $parts

Каждый из элементов в пути к имени поля

Возвращает

Cake\Validation\Validator

_prepare()source protected

_prepare( )

Подготовка дополнительных данных из контекста.

Если в конструктор был передан параметр table как строка, будет использован TableLocator для получения соответствующего экземпляра таблицы.

Если в качестве параметра table передан объект, он будет использован как есть.

Если параметр table не передан, имя таблицы будет определено на основе соглашений об именовании. Эта инференция будет работать с несколькими распространёнными объектами, такими как массивы, объекты Collection и ResultSets.

Исключения

RuntimeException
При невозможности найти/определить объект таблицы.

_schemaDefault()source protected

_schemaDefault( string $field , Cake\Datasource\EntityInterface $entity )

Получение значения по умолчанию из схемы таблицы для заданного поля сущности.

Параметры

строка $field

Имя поля.

Cake\Datasource\EntityInterface $entity

Сущность.

Возвращает

смешанный

attributes()source public

attributes( string $field )

Получить ассоциативный массив дополнительных атрибутов для имени поля.

Параметры

string $field

Путь с разделителями «точка» для получения дополнительных данных.

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

array
Массив данных, описывающих дополнительные атрибуты поля.

Реализация

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

entity()source public

entity( array|null $path = null )

Получить конечную сущность по заданному пути.

Этот метод пройдет по заданному пути и найдет конечную сущность. Если по пути нет конечной сущности, будет возвращено false.

Параметры

array|null $path необязательно null

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

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

Cake\Datasource\EntityInterface|Перебираемый объект|массив|boolean

Исключения

RuntimeException
При невозможности чтения свойств.

error()source public

error( string $field )

Получить ошибки для заданного поля

Параметры

string $field

Путь с разделителями «точка» для проверки ошибок.

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

array
Массив ошибок.

Реализация

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

fieldNames()source public

fieldNames( )

Получить имена полей из сущности верхнего уровня.

Если контекст предназначен для набора сущностей, будет использоваться элемент с индексом 0.

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

array
Массив имён полей в таблице/сущности.

Реализация

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

hasError()source public

hasError( string $field )

Проверить наличие ошибок для поля

Параметры

string $field

Путь с разделителями «точка» для проверки ошибок.

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

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

Реализация

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

isCreate()source public

isCreate( )

Проверить, является ли форма формой создания или редактирования.

Если контекст предназначен для единственной сущности, будет использован метод isNew() сущности. Если isNew() возвращает null, будет предположено действие создания.

Если контекст предназначен для коллекции или массива, будет использоваться первый объект в коллекции.

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

boolean

Реализация

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

isPrimaryKey()source public

isPrimaryKey( string $field )

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

Параметры

string $field

Путь с разделителями «точка» к полю, для которого требуется значение.

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

boolean

Реализация

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

isRequired()source public

isRequired( string $field )

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

Параметры

string $field

Путь с разделителями «точка» к полю, которое нужно проверить.

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

boolean

Реализация

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

primaryKey()source public

primaryKey( )

Получить данные первичного ключа для контекста.

Получает столбцы первичного ключа из схемы корневой сущности.

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

array

Реализация

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

type()source public

type( string $field )

Получить абстрактный тип поля для заданного имени поля.

Параметры

string $field

Путь с разделителями «точка» для получения типа схемы.

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

null|string
Абстрактный тип данных или null.

См. также

Cake\Database\Type

Реализация

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

val()source public

val( string $field , array $options = [] )

Получить значение для заданного пути.

Обрабатывает данные сущности и находит значение для $path.

Параметры

string $field

Путь с разделителями «точка» к значению.

array $options необязательно []

Параметры: - default: Значение по умолчанию, которое будет возвращено, если значение не найдено в данных запроса или сущности. - schemaDefault: Булево значение, указывающее, следует ли использовать значение по умолчанию из схемы таблицы, если оно явно не указано.

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

mixed
Значение поля или null при отсутствии значения.

Реализация

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

getTableLocator()source public

getTableLocator( )

Получить локатор таблиц.

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

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Установить локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

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

$this

tableLocator()source public deprecated

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Установить локатор таблиц. Если параметры не переданы, возвращается текущий локатор.

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

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

Cake\ORM\Locator\LocatorInterface

false

[]

[]