Docs4dev
Docs
cakephp / 4.4 / trait-cake.database.typemaptrait.html

Trait TypeMapTrait

Trait TypeMapTrait

Namespace: Cake\Database

Property Summary

  • $_typeMap protected
    Cake\Database\TypeMap|null

Method Summary

  • 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.

Method Detail

getDefaultTypes() public

getDefaultTypes(): array<int|string, string>

Gets default types of current type map.

Returns

array<int|string, string>

getTypeMap() public

getTypeMap(): Cake\Database\TypeMap

Returns the existing type map.

Returns

Cake\Database\TypeMap

setDefaultTypes() public

setDefaultTypes(array<int|string, string> $types): $this

Overwrite 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<int|string, string> $types

The array of types to set.

Returns

$this

See Also

\Cake\Database\TypeMap::setDefaults()

setTypeMap() public

setTypeMap(Cake\Database\TypeMap|array $typeMap): $this

Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.

Parameters

Cake\Database\TypeMap|array $typeMap

Creates a TypeMap if array, otherwise sets the given TypeMap

Returns

$this

Property Detail

$_typeMap protected

Type

Cake\Database\TypeMap|null

© 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/4.4/trait-Cake.Database.TypeMapTrait.html