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.
Deprecated: 4.4.0 Use a normal array for options instead.
See: \Cake\Datasource\RulesChecker
Property Summary
Method Summary
-
__construct() public
Constructor.
-
_associated() protected
Checks that the associations exists recursively.
-
_checkAssociation() protected
Checks if an association exists.
-
_normalizeAssociations() protected
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
-
associated() public
Set associated options.
-
atomic() public
Sets the atomic option.
-
checkExisting() public
Set check existing option.
-
checkRules() public
Option to check the rules.
-
guard() public
Set the guard option.
-
parseArrayOptions() public
Takes an options array and populates the option object with the data.
-
set() public
Setting custom options.
-
toArray() public
-
validate() public
Set the validation rule set to use.
Method Detail
__construct() ¶ public
__construct(Cake\ORM\Table $table, array<string, mixed> $options = [])Constructor.
Parameters
-
Cake\ORM\Table$table A table instance.
-
array<string, mixed>$options optional Options to parse when instantiating.
_associated() ¶ protected
_associated(Cake\ORM\Table $table, array $associations): voidChecks that the associations exists recursively.
Parameters
-
Cake\ORM\Table$table Table object.
-
array$associations An associations array.
Returns
void_checkAssociation() ¶ protected
_checkAssociation(Cake\ORM\Table $table, string $association): voidChecks if an association exists.
Parameters
-
Cake\ORM\Table$table Table object.
-
string$association Association name.
Returns
voidThrows
RuntimeExceptionIf no such association exists for the given table.
_normalizeAssociations() ¶ protected
_normalizeAssociations(array|string $associations): arrayReturns 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
arrayassociated() ¶ public
associated(array|string $associated): $thisSet associated options.
Parameters
-
array|string$associated String or array of associations.
Returns
$thisatomic() ¶ public
atomic(bool $atomic): $thisSets the atomic option.
Parameters
-
bool$atomic Atomic or not.
Returns
$thischeckExisting() ¶ public
checkExisting(bool $checkExisting): $thisSet check existing option.
Parameters
-
bool$checkExisting Guard the properties or not.
Returns
$thischeckRules() ¶ public
checkRules(bool $checkRules): $thisOption to check the rules.
Parameters
-
bool$checkRules Check the rules or not.
Returns
$thisguard() ¶ public
guard(bool $guard): $thisSet the guard option.
Parameters
-
bool$guard Guard the properties or not.
Returns
$thisparseArrayOptions() ¶ public
parseArrayOptions(array<string, mixed> $array): $thisTakes 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<string, mixed>$array Options array.
Returns
$thisThrows
InvalidArgumentExceptionIf a given option key does not exist.
set() ¶ public
set(string $option, mixed $value): $thisSetting custom options.
Parameters
-
string$option Option key.
-
mixed$value Option value.
Returns
$thisvalidate() ¶ public
validate(string $validate): $thisSet the validation rule set to use.
Parameters
-
string$validate Name of the validation rule set to use.
Returns
$this