W3cubDocs

/CakePHP 3.8

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()source 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()source public

getInvalid( )

Returns

array

getInvalidField()source public

getInvalidField( $field )

Parameters

$field

Returns

mixed

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