Interface InvalidPropertyInterface
Describes the methods that any class representing a data storage should comply with.
Method Summary
-
getInvalid() public
Get a list of invalid fields and their data for errors upon validation/patching
-
getInvalidField() public
Get a single value of an invalid field. Returns null if not set.
-
setInvalid() public
Set fields as invalid and not patchable into the entity.
-
setInvalidField() public
Sets a field as invalid and not patchable into the entity.
Method Detail
getInvalid() ¶ public
getInvalid(): arrayGet a list of invalid fields and their data for errors upon validation/patching
Returns
arraygetInvalidField() ¶ public
getInvalidField(string $field): mixed|nullGet a single value of an invalid field. Returns null if not set.
Parameters
-
string$field The name of the field.
Returns
mixed|nullsetInvalid() ¶ public
setInvalid(array $fields, bool $overwrite = false): $thisSet fields 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
-
array$fields The values to set.
-
bool$overwrite optional Whether or not to overwrite pre-existing values for $field.
Returns
$thissetInvalidField() ¶ public
setInvalidField(string $field, mixed $value): $thisSets a field as invalid and not patchable into the entity.
Parameters
-
string$field The value to set.
-
mixed$value The invalid value to be set for $field.
Returns
$this