Trait TypeMapTrait
Trait TypeMapTrait
Property Summary
-
$_typeMap protected
Cake\Database\TypeMap
Method Summary
-
defaultTypes() public deprecated
Allows setting default types when chaining query
-
getDefaultTypes() public
Gets default types of current type map.
-
getTypeMap() public
Returns the existing type map.
-
setDefaultTypes() public
Overwrite the default type mappings for fields in the implementing object.
-
setTypeMap() public
Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
-
typeMap() public deprecated
Creates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
Method Detail
defaultTypes() ¶ public
defaultTypes(array|null $types = null): $this|arrayAllows setting default types when chaining query
Parameters
-
array|null$types optional The array of types to set.
Returns
$this|arraygetDefaultTypes() ¶ public
getDefaultTypes(): arrayGets default types of current type map.
Returns
arraygetTypeMap() ¶ public
getTypeMap(): Cake\Database\TypeMapReturns the existing type map.
Returns
Cake\Database\TypeMapsetDefaultTypes() ¶ public
setDefaultTypes(array $types): $thisOverwrite the default type mappings for fields in the implementing object.
This method is useful if you need to set type mappings that are shared across multiple functions/expressions in a query.
To add a default without overwriting existing ones
use getTypeMap()->addDefaults()
Parameters
-
array$types The array of types to set.
Returns
$thisSee Also
setTypeMap() ¶ public
setTypeMap(array|Cake\Database\TypeMap $typeMap): $thisCreates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
Parameters
-
array|Cake\Database\TypeMap$typeMap Creates a TypeMap if array, otherwise sets the given TypeMap
Returns
$thistypeMap() ¶ public
typeMap(array|Cake\Database\TypeMap|null $typeMap = null): $this|Cake\Database\TypeMapCreates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
Parameters
-
array|Cake\Database\TypeMap|null$typeMap optional Creates a TypeMap if array, otherwise sets the given TypeMap
Returns
$this|Cake\Database\TypeMap