Класс 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.8/class-Cake.ORM.SaveOptionsBuilder.html