\Cake\DatasourceInvalidPropertyInterface

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

Summary

Methods
Constants
invalid()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

invalid()

invalid(string|array|null  $field = null, mixed|null  $value = null, boolean  $overwrite = false) : $this|mixed

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

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

mixed|null $value

The invalid value to be set for $field.

boolean $overwrite

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

Returns

$this|mixed