Класс 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 массив

Опции

[]

END_OF_DOCUMENT_MARKER

$_tablesource

protected Cake\ORM\Table

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

© 2005–2018 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.5/class-Cake.ORM.SaveOptionsBuilder.html