On this page
Class StringType
String type converter.
Use to convert string data between PHP and the database types.
- Cake\Database\Type implements Cake\Database\TypeInterface
 
 Cake\Database\Type\StringType implements Cake\Database\Type\OptionalConvertInterface, Cake\Database\TypeInterface
   
Direct Subclasses
Inherited Properties
Method Summary
- 
    marshal() publicMarshalls request data into PHP strings.
 - 
    requiresToPhpCast() public
Returns whether the cast to PHP is required to be invoked, since it is not a identity function.
 - 
    toDatabase() publicConvert string data into the database format.
 - 
    toPHP() publicConvert string values to PHP strings.
 - 
    toStatement() publicGet the correct PDO binding type for string data.
 
Method Detail
marshal()source public
marshal( mixed $value )
   Marshalls request data into PHP strings.
Parameters
- 
     mixed 
$value - The value to convert.
 
Returns
string|nullConverted value.
Overrides
Cake\Database\Type::marshal()
   Implementation of
Cake\Database\TypeInterface::marshal()
  requiresToPhpCast()source public
requiresToPhpCast( )
   Returns whether the cast to PHP is required to be invoked, since it is not a identity function.
Returns
booleanFalse as database results are returned already as strings
Implementation of
Cake\Database\Type\OptionalConvertInterface::requiresToPhpCast()
  toDatabase()source 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|nullOverrides
Cake\Database\Type::toDatabase()
   Implementation of
Cake\Database\TypeInterface::toDatabase()
  toPHP()source 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|nullOverrides
Cake\Database\Type::toPHP()
   Implementation of
Cake\Database\TypeInterface::toPHP()
  toStatement()source 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
integerOverrides
Cake\Database\Type::toStatement()
   Implementation of
Cake\Database\TypeInterface::toStatement()
  Methods inherited from Cake\Database\Type
__construct()source public
__construct( string|null $name null )
   Constructor
Parameters
- 
     string|null 
$nameoptional null - The name identifying this type
 
_basicTypeCast()source 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
Deprecated
3.1 All types should now be a specific classParameters
- 
     mixed 
$value - value to be converted to PHP equivalent
 
Returns
mixedboolval()source public static
boolval( mixed $value )
   Type converter for boolean values.
Will convert string true/false into booleans.
Deprecated
3.1.8 This method is now unused.Parameters
- 
     mixed 
$value - The value to convert to a boolean.
 
Returns
booleanbuild()source public static
build( string $name )
   Returns a Type object capable of converting a type identified by $name
Parameters
- 
     string 
$name - type identifier
 
Returns
Cake\Database\TypeThrows
InvalidArgumentExceptionIf type identifier is unknown
buildAll()source public static
buildAll( )
   Returns an arrays with all the mapped type objects, indexed by name
Returns
arrayclear()source public static
clear( )
   Clears out all created instances and mapped types classes, useful for testing
getBaseType()source public
getBaseType( )
   Returns the base type name that this class is inheriting.
Returns
stringThe base type name that this class is inheriting.
Implementation of
Cake\Database\TypeInterface::getBaseType()
  getName()source public
getName( )
   Returns type identifier name for this object.
Returns
stringThe type identifier name for this object.
Implementation of
Cake\Database\TypeInterface::getName()
  map()source public static
map( string|array|Cake\Database\Type|null $type null , string|null $className null )
   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
Parameters
- 
     string|array|
Cake\Database\Type|null$typeoptional null - if string name of type to map, if array list of arrays to be mapped
 - 
     string|null 
$classNameoptional null - The classname to register.
 
Returns
array|string|nullif $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
newId()source public
newId( )
   Generate a new primary key value for a given type.
Returns
mixedA new primary key value.
Implementation of
Cake\Database\TypeInterface::newId()
  set()source public static
set( string $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.
 
strval()source public static
strval( mixed $value )
   Type converter for string values.
Will convert values into strings
Deprecated
3.1.8 This method is now unused.Parameters
- 
     mixed 
$value - The value to convert to a string.
 
Returns
boolean© 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.3/class-Cake.Database.Type.StringType.html