Class SaveOptionsBuilder

OOP style Save Option Builder.

This allows you to build options to save entities in a OOP style and helps you to avoid mistakes by validating the options as you build them.

Namespace: Cake\ORM

Properties summary

  • $_options protected
    array

    Options

  • $_table protected
    \Cake\ORM\Table

    Table object.

Method Summary

Method Detail

__construct() public 

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

Constructor.

Parameters

\Cake\ORM\Table $table

A table instance.

array $options optional

Options to parse when instantiating.

_associated() protected 

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

Checks that the associations exists recursively.

Parameters

\Cake\ORM\Table $table

Table object.

array $associations

An associations array.

_checkAssociation() protected 

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

Checks if an association exists.

Parameters

\Cake\ORM\Table $table

Table object.

string $association

Association name.

Throws

RuntimeException
If no such association exists for the given table.

_normalizeAssociations() protected 

_normalizeAssociations(mixed $associations)

Returns an array out of the original passed associations list where dot notation is transformed into nested arrays so that they can be parsed by other routines

Parameters

array|string $associations

The array of included associations.

Returns

array

An array having dot notation transformed into nested arrays

associated() public 

associated(mixed $associated)

Set associated options.

Parameters

string|array $associated

String or array of associations.

Returns

\Cake\ORM\SaveOptionsBuilder

atomic() public 

atomic(mixed $atomic)

Sets the atomic option.

Parameters

bool $atomic

Atomic or not.

Returns

\Cake\ORM\SaveOptionsBuilder

checkExisting() public 

checkExisting(mixed $checkExisting)

Set check existing option.

Parameters

bool $checkExisting

Guard the properties or not.

Returns

\Cake\ORM\SaveOptionsBuilder

checkRules() public 

checkRules(mixed $checkRules)

Option to check the rules.

Parameters

bool $checkRules

Check the rules or not.

Returns

\Cake\ORM\SaveOptionsBuilder

guard() public 

guard(mixed $guard)

Set the guard option.

Parameters

bool $guard

Guard the properties or not.

Returns

\Cake\ORM\SaveOptionsBuilder

parseArrayOptions() public 

parseArrayOptions(mixed $array)

Takes an options array and populates the option object with the data.

This can be used to turn an options array into the object.

Parameters

array $array

Options array.

Returns

\Cake\ORM\SaveOptionsBuilder

Throws

InvalidArgumentException
If a given option key does not exist.

set() public 

set(mixed $option, mixed $value)

Setting custom options.

Parameters

string $option

Option key.

mixed $value

Option value.

Returns

\Cake\ORM\SaveOptionsBuilder

toArray() public 

toArray()

Returns

array

validate() public 

validate(mixed $validate)

Set the validation rule set to use.

Parameters

string $validate

Name of the validation rule set to use.

Returns

\Cake\ORM\SaveOptionsBuilder

Property Detail

$_options protected

Options

Type

array

$_table protected

Table object.

Type

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