Interface InvalidPropertyInterface
Describes the methods that any class representing a data storage should comply with.
Direct Implementers
Method Summary
-
invalid() public deprecated
Sets a field as invalid and not patchable into the entity.
Method Detail
invalid() public deprecated ¶
invalid( string|array|null $field = null , mixed|null $value = null , boolean $overwrite = false )
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.
Deprecated
3.5.0 Use getInvalid()/getInvalidField() and setInvalid()/setInvalidField() instead.
Parameters
- string|array|null $field optional null
- The field to get invalid value for, or the value to set.
- mixed|null $value optional null
- The invalid value to be set for $field.
- boolean $overwrite optional false
- Whether or not to overwrite pre-existing values for $field.
Returns
$this|mixed
Magic methods summary
getInvalid() public ¶
getInvalid( )
Returns
array
getInvalidField() public ¶
getInvalidField( $field )
Parameters
- $field
Returns
mixed