Класс SaveOptionsBuilder

Библиотека для построения опций сохранения сущностей в стиле ООП.

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

ArrayObject реализует IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable

Cake\ORM\SaveOptionsBuilder использует Cake\ORM\AssociationsNormalizerTrait

Пространство имён: Cake\ORM
См.: Cake\Datasource\RulesChecker
Расположение: ORM/SaveOptionsBuilder.php

Унаследованные константы

ARRAY_AS_PROPS, STD_PROP_LIST

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

$_options protected

array
Опции
$_table protected

Cake\ORM\Table
Объект таблицы.

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

__construct() public
Конструктор.
_associated() protected
Проверка наличия ассоциаций рекурсивно.
_checkAssociation() protected
Проверка существования ассоциации.
associated() public
Установить опции ассоциаций.
atomic() public
Установить атомарную опцию.
checkExisting() public
Установить опцию проверки существующих записей.
checkRules() public
Опция проверки правил.
guard() public
Установить опцию защиты.
parseArrayOptions() public
Преобразует массив опций в объект.
set() public
Установить пользовательские опции.
toArray() public
validate() public
Установить набор правил валидации.

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

__construct()source public

__construct( Cake\ORM\Table $table , array $options = [] )

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

Параметры

Cake\ORM\Table $table: Экземпляр таблицы.
массив $options опционально []: Опции для парсинга при инициализации.

Переопределяет

ArrayObject::__construct()

_associated()source protected

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

Проверяет наличие ассоциаций рекурсивно.

Параметры

Cake\ORM\Table $table: Объект таблицы.
массив $associations: Массив ассоциаций.

_checkAssociation()source protected

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

Проверяет наличие ассоциации.

Параметры

Cake\ORM\Table $table: Объект таблицы.
строка $association: Название ассоциации.

Возможные исключения

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

associated()source public

associated( string|array $associated )

Установить опции ассоциаций.

Параметры

строка|массив $associated: Строка или массив ассоциаций.

Возвращает

Cake\ORM\SaveOptionsBuilder

atomic()source public

atomic( boolean $atomic )

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

Параметры

булево $atomic: Атомарно или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

checkExisting()source public

checkExisting( boolean $checkExisting )

Установить опцию проверки существующих записей.

Параметры

булево $checkExisting: Защищать свойства или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

checkRules()source public

checkRules( boolean $checkRules )

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

Параметры

булево $checkRules: Проверять правила или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

guard()source public

guard( boolean $guard )

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

Параметры

булево $guard: Защищать свойства или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

parseArrayOptions()source public

parseArrayOptions( array $array )

Преобразует массив опций в объект.

Параметры

массив $array: Массив опций.

Возвращает

Cake\ORM\SaveOptionsBuilder

Возможные исключения

InvalidArgumentException
Если ключ опции не найден.

set()source public

set( string $option , mixed $value )

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

Параметры

строка $option: Ключ опции.
смешанный $value: Значение опции.

Возвращает

Cake\ORM\SaveOptionsBuilder

toArray()source public

toArray( )

Возвращает

массив

validate()source public

validate( string $validate )

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

Параметры

строка $validate: Название набора правил валидации.

Возвращает

Cake\ORM\SaveOptionsBuilder

Методы, используемые из Cake\ORM\AssociationsNormalizerTrait

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

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

Параметры

массив $associations: Массив включённых ассоциаций.

Возвращает

массив
Массив с преобразованием нотации точек в вложенные массивы

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

$_optionssource

protected массив

Опции

[]

$_tablesource

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