Class StringType
String type converter.
Use to convert string data between PHP and the database types.
Properties summary
- $_basicTypes protected static
array
List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these.
- $_builtTypes protected static
\Cake\Database\Type[]
Contains a map of type object instances to be reused if needed.
- $_name protected
string|null
Identifier name for this type
- $_types protected static
string[]|\Cake\Database\Type[]
List of supported database types. A human readable identifier is used as key and a complete namespaced class name as value representing the class that will do actual type conversions.
Method Summary
- __debugInfo() public
Returns an array that can be used to describe the internal state of this object.
- _basicTypeCast() protected
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
- map() public static
Registers a new type identifier and maps it to a fully namespaced classname, If called with no arguments it will return current types map array If $className is omitted it will return mapped class for $type
- requiresToPhpCast() public
Returns whether the cast to PHP is required to be invoked, since it is not a identity function.
Method Detail
__construct() public
__construct(mixed $name)
Constructor
Parameters
-
string|null
$name optional The name identifying this type
__debugInfo() public
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
Returns
array
_basicTypeCast() protected
_basicTypeCast(mixed $value)
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
Parameters
-
mixed
$value Value to be converted to PHP equivalent
Returns
mixed
boolval() public static
boolval(mixed $value)
Type converter for boolean values.
Will convert string true/false into booleans.
Parameters
-
mixed
$value The value to convert to a boolean.
Returns
bool
build() public static
build(mixed $name)
Returns a Type object capable of converting a type identified by name.
Parameters
-
string
$name type identifier
Returns
\Cake\Database\Type
Throws
InvalidArgumentException
If type identifier is unknown
buildAll() public static
buildAll()
Returns an arrays with all the mapped type objects, indexed by name.
Returns
array
clear() public static
clear()
Clears out all created instances and mapped types classes, useful for testing
getBaseType() public
getBaseType()
Returns the base type name that this class is inheriting.
This is useful when extending base type for adding extra functionality, but still want the rest of the framework to use the same assumptions it would do about the base type it inherits from.
Returns
string
The base type name that this class is inheriting.
getMap() public static
getMap(mixed $type)
Get mapped class name or instance for type(s).
Parameters
-
string|null
$type optional Type name to get mapped class for or null to get map array.
Returns
array|string|\Cake\Database\TypeInterface|null
Configured class name or instance for give $type or map array.
getName() public
getName()
Returns type identifier name for this object.
Returns
string
The type identifier name for this object.
map() public static
map(mixed $type, mixed $className)
Registers a new type identifier and maps it to a fully namespaced classname, If called with no arguments it will return current types map array If $className is omitted it will return mapped class for $type
Deprecated 3.6.2:
- The usage of $type as string[]|\Cake\Database\Type[] is deprecated. Use Type::setMap() with string[] instead.
- Passing $className as \Cake\Database\Type instance is deprecated, use class name string only.
- Using this method as getter is deprecated. Use Type::getMap() instead.
Parameters
-
string|string[]|\Cake\Database\Type[]|null
$type optional If string name of type to map, if array list of arrays to be mapped
-
string|\Cake\Database\Type|null
$className optional The classname or object instance of it to register.
Returns
array|string|null
If $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
marshal() public
marshal(mixed $value)
Marshals request data into PHP strings.
Parameters
-
mixed
$value The value to convert.
Returns
string|null
Converted value.
newId() public
newId()
Generate a new primary key value for a given type.
This method can be used by types to create new primary key values when entities are inserted.
Returns
mixed
A new primary key value.
See Also
requiresToPhpCast() public
requiresToPhpCast()
Returns whether the cast to PHP is required to be invoked, since it is not a identity function.
Returns
bool
False as database results are returned already as strings
set() public static
set(mixed $name, \Cake\Database\Type $instance)
Returns a Type object capable of converting a type identified by $name
Parameters
-
string
$name The type identifier you want to set.
-
\Cake\Database\Type
$instance The type instance you want to set.
setMap() public static
setMap(array $map)
Set type to classname mapping.
Parameters
-
string[]
$map List of types to be mapped.
strval() public static
strval(mixed $value)
Type converter for string values.
Will convert values into strings
Parameters
-
mixed
$value The value to convert to a string.
Returns
string
toDatabase() public
toDatabase(mixed $value, \Cake\Database\Driver $driver)
Convert string data into the database format.
Parameters
-
mixed
$value The value to convert.
-
\Cake\Database\Driver
$driver The driver instance to convert with.
Returns
string|null
toPHP() public
toPHP(mixed $value, \Cake\Database\Driver $driver)
Convert string values to PHP strings.
Parameters
-
mixed
$value The value to convert.
-
\Cake\Database\Driver
$driver The driver instance to convert with.
Returns
string|null
toStatement() public
toStatement(mixed $value, \Cake\Database\Driver $driver)
Get the correct PDO binding type for string data.
Parameters
-
mixed
$value The value being bound.
-
\Cake\Database\Driver
$driver The driver.
Returns
int
Property Detail
$_basicTypes protected static
List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these.
Type
array
$_builtTypes protected static
Contains a map of type object instances to be reused if needed.
Type
\Cake\Database\Type[]
$_name protected
Identifier name for this type
Type
string|null
$_types protected static
List of supported database types. A human readable identifier is used as key and a complete namespaced class name as value representing the class that will do actual type conversions.
Type
string[]|\Cake\Database\Type[]
© 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.9/class-Cake.Database.Type.StringType.html