Spec-Zone.ru › CakePHP 4.3

Интерфейс ContextInterface

Интерфейс для реализаций контекста FormHelper.

Пространство имён: Cake\View\Form

Константы

  • array<string>
    VALID_ATTRIBUTES
    ['length', 'precision', 'comment', 'null', 'default']

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

  • attributes() public

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

  • error() public

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

  • fieldNames() public

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

  • getMaxLength() public

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

  • getPrimaryKey() public

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

  • getRequiredMessage() public

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

  • hasError() public

    Проверить, есть ли ошибка, привязанная к полю

  • isCreate() public

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

  • isPrimaryKey() public

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

  • isRequired() public

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

    В этом классе контекста это просто определяется массивом «обязательные».

  • type() public

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

  • val() public

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

    Классы, реализующие этот метод, могут опционально иметь второй аргумент $options. Действительные ключи для массива $options:

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

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

attributes() public

attributes(string $field): array

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

Параметры

string $field

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

Возвращает

array

error() public

error(string $field): array

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

Параметры

string $field

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

Возвращает

array

fieldNames() public

fieldNames(): array<string>

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

Возвращает

array<string>

getMaxLength() public

getMaxLength(string $field): int|null

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

Параметры

string $field

Имя поля.

Возвращает

int|null

getPrimaryKey() public

getPrimaryKey(): array<string>

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

Возвращает

array<string>

getRequiredMessage() public

getRequiredMessage(string $field): string|null

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

Параметры

string $field

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

Возвращает

string|null

hasError() public

hasError(string $field): bool

Проверить, есть ли ошибка, привязанная к полю

Параметры

string $field

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

Возвращает

bool

isCreate() public

isCreate(): bool

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

Возвращает

bool

isPrimaryKey() public

isPrimaryKey(string $field): bool

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

Параметры

string $field

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

Возвращает

bool

isRequired() public

isRequired(string $field): bool|null

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

В этом классе контекста это просто определяется массивом «обязательные».

Параметры

string $field

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

Возвращает

bool|null

type() public

type(string $field): string|null

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

Параметры

string $field

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

Возвращает

string|null

См. также

\Cake\Database\TypeFactory

val() public

val(string $field, array<string, mixed> $options = []): mixed

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

Классы, реализующие этот метод, могут опционально иметь второй аргумент $options. Действительные ключи для массива $options:

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

Параметры

string $field

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

array<string, mixed> $options optional

Параметры. требуется для.

Возвращает

mixed

© 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/4.3/interface-Cake.View.Form.ContextInterface.html

Spec-Zone.ru

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