Spec-Zone.ru › CakePHP 4.4

Класс
SaveOptionsBuilder

Построитель опций сохранения в стиле ООП.

Это позволяет вам создавать опции для сохранения сущностей в стиле ООП и помогает избежать ошибок, проверяя опции по мере их создания.

Пространство имён: Cake\ORM
Устарело: 4.4.0 Используйте обычный массив для опций вместо этого.
См.: \Cake\Datasource\RulesChecker

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

  • $_options protected
    array<string, mixed>

    Опции

  • $_table protected
    Cake\ORM\Table

    Объект таблицы.

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

  • __construct() public

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

  • _associated() protected

    Проверяет, что ассоциации существуют рекурсивно.

  • _checkAssociation() protected

    Проверяет, существует ли ассоциация.

  • _normalizeAssociations() protected

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

  • associated() public

    Устанавливает ассоциированные опции.

  • atomic() public

    Устанавливает опцию атомарности.

  • checkExisting() public

    Устанавливает опцию проверки существования.

  • checkRules() public

    Опция проверки правил.

  • guard() public

    Устанавливает опцию защиты.

  • parseArrayOptions() public

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

    Это можно использовать для преобразования массива опций в объект.

  • set() public

    Установка пользовательских опций.

  • toArray() public
  • validate() public

    Устанавливает набор правил валидации для использования.

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

__construct() public 

__construct(Cake\ORM\Table $table, array<string, mixed> $options = [])

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

Параметры

Cake\ORM\Table $table

Экземпляр таблицы.

array<string, mixed> $options optional

Опции для анализа при создании экземпляра.

_associated() protected 

_associated(Cake\ORM\Table $table, array $associations): void

Проверяет, что ассоциации существуют рекурсивно.

Параметры

Cake\ORM\Table $table

Объект таблицы.

array $associations

Массив ассоциаций.

Возвращает

void

_checkAssociation() protected 

_checkAssociation(Cake\ORM\Table $table, string $association): void

Проверяет, существует ли ассоциация.

Параметры

Cake\ORM\Table $table

Объект таблицы.

string $association

Имя ассоциации.

Возвращает

void

Выбрасывает

RuntimeException
Если для данной таблицы нет такой ассоциации.

_normalizeAssociations() protected 

_normalizeAssociations(array|string $associations): array

Возвращает массив из исходного списка ассоциаций, где обозначение точкой преобразуется в вложенные массивы, чтобы их могли анализировать другие подпрограммы

Параметры

array|string $associations

Массив включенных ассоциаций.

Возвращает

array

associated() public 

associated(array|string $associated): $this

Устанавливает ассоциированные опции.

Параметры

array|string $associated

Строка или массив ассоциаций.

Возвращает

$this

atomic() public 

atomic(bool $atomic): $this

Устанавливает опцию атомарности.

Параметры

bool $atomic

Атомарно или нет.

Возвращает

$this

checkExisting() public 

checkExisting(bool $checkExisting): $this

Устанавливает опцию проверки существования.

Параметры

bool $checkExisting

Защищать свойства или нет.

Возвращает

$this

checkRules() public 

checkRules(bool $checkRules): $this

Опция проверки правил.

Параметры

bool $checkRules

Проверять правила или нет.

Возвращает

$this

guard() public 

guard(bool $guard): $this

Устанавливает опцию защиты.

Параметры

bool $guard

Защищать свойства или нет.

Возвращает

$this

parseArrayOptions() public 

parseArrayOptions(array<string, mixed> $array): $this

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

Это можно использовать для преобразования массива опций в объект.

Параметры

array<string, mixed> $array

Массив опций.

Возвращает

$this

Выбрасывает

InvalidArgumentException
Если заданный ключ опции не существует.

set() public 

set(string $option, mixed $value): $this

Установка пользовательских опций.

Параметры

string $option

Ключ опции.

mixed $value

Значение опции.

Возвращает

$this

toArray() public 

toArray(): array<string, mixed>

Возвращает

array<string, mixed>

validate() public 

validate(string $validate): $this

Устанавливает набор правил валидации для использования.

Параметры

string $validate

Имя набора правил валидации для использования.

Возвращает

$this

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

$_options protected

Опции

Тип

array<string, mixed>

$_table protected

Объект таблицы.

Тип

Cake\ORM\Table

© 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.4/class-Cake.ORM.SaveOptionsBuilder.html

Spec-Zone.ru

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