Implements default and single-use mappings for columns to their associated types
$_defaults protected array$_types protected arrayConfigures a map of default fields and their associated types to be used as the default list of types for every function in this class with a $types param. Useful to avoid repetition when calling the same functions using the same fields and types.
Configures a map of default fields and their associated types to be used as the default list of types for every function in this class with a $types param. Useful to avoid repetition when calling the same functions using the same fields and types.
Returns the type of the given column. If there is no single use type is configured, the column type will be looked for inside the default mapping. If neither exist, null will be returned.
__construct( array $defaults [] )
Creates an instance with the given defaults
$defaults optional [] addDefaults( array $types )
Add additional default types into the type map.
If a key already exists it will not be overwritten.
$types defaults( array $defaults null )
Configures a map of default fields and their associated types to be used as the default list of types for every function in this class with a $types param. Useful to avoid repetition when calling the same functions using the same fields and types.
If called with no arguments it will return the currently configured types.
$query->defaults(['created' => 'datetime', 'is_visible' => 'boolean']);
This method will replace all the existing type maps with the ones provided.
$defaults optional null associative array where keys are field names and values are the correspondent type.
getTypes( )
Gets a map of fields and their associated types for single-use.
setDefaults( array $defaults )
Configures a map of default fields and their associated types to be used as the default list of types for every function in this class with a $types param. Useful to avoid repetition when calling the same functions using the same fields and types.
$query->setDefaults(['created' => 'datetime', 'is_visible' => 'boolean']);
This method will replace all the existing type maps with the ones provided.
$defaults Associative array where keys are field names and values are the correspondent type.
setTypes( array $types )
Sets a map of fields and their associated types for single-use.
$query->setTypes(['created' => 'time']);
This method will replace all the existing type maps with the ones provided.
$types Associative array where keys are field names and values are the correspondent type.
type( string $column )
Returns the type of the given column. If there is no single use type is configured, the column type will be looked for inside the default mapping. If neither exist, null will be returned.
$column types( array $types null )
Sets a map of fields and their associated types for single-use.
If called with no arguments it will return the currently configured types.
$query->types(['created' => 'time']);
This method will replace all the existing type maps with the ones provided.
$types optional null associative array where keys are field names and values are the correspondent type.
protected array
Associative array with the default fields and the related types this query might contain.
Used to avoid repetition when calling multiple functions inside this class that may require a custom type for a specific field.
protected array
Associative array with the fields and the related types that override defaults this query might contain
Used to avoid repetition when calling multiple functions inside this class that may require a custom type for a specific field.
[]
© 2005–2017 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.4/class-Cake.Database.TypeMap.html