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