Interface InvalidPropertyInterface
Describes the methods that any class representing a data storage should comply with.
Namespace: Cake\Datasource
Method Summary
-
getInvalid() public @method
-
getInvalidField() public @method
-
invalid() public deprecated
Sets a field as invalid and not patchable into the entity.
-
setInvalid() public @method
-
setInvalidField() public @method
Method Detail
getInvalidField() ¶ public @method
getInvalidField(mixed $field): mixedParameters
-
$field
Returns
mixedinvalid() ¶ public
invalid(string|array|null $field = null, mixed|null $value = null, bool $overwrite = false): $this|mixedSets 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|mixedsetInvalid() ¶ public @method
setInvalid(mixed $field, mixed $value = null, mixed $overwrite = false): $thisParameters
-
$field -
$value optional -
$overwrite optional
Returns
$thissetInvalidField() ¶ public @method
setInvalidField(mixed $field, mixed $value = null, mixed $overwrite = false): $thisParameters
-
$field -
$value optional -
$overwrite optional
Returns
$this