Interface InvalidPropertyInterface

Describes the methods that any class representing a data storage should comply with.

Namespace: Cake\Datasource

Method Summary

Method Detail

getInvalid() public 

getInvalid()

getInvalidField() public 

getInvalidField(mixed $field)

Parameters

mixed $field

invalid() public 

invalid(mixed $field, mixed $value, mixed $overwrite)

Sets a field as invalid and not patchable into the entity.

This is useful for batch operations when one needs to get the original value for an error message after patching. This value could not be patched into the entity and is simply copied into the _invalid property for debugging purposes or to be able to log it away.

Parameters

string|array|null $field optional

The field to get invalid value for, or the value to set.

mixed|null $value optional

The invalid value to be set for $field.

bool $overwrite optional

Whether or not to overwrite pre-existing values for $field.

Returns

$this|mixed

setInvalid() public 

setInvalid(mixed $field, mixed $value, mixed $overwrite)

Parameters

mixed $field
mixed $value
mixed $overwrite

setInvalidField() public 

setInvalidField(mixed $field, mixed $value, mixed $overwrite)

Parameters

mixed $field
mixed $value
mixed $overwrite

© 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/interface-Cake.Datasource.InvalidPropertyInterface.html