Class StringType
String type converter.
Use to convert string data between PHP and the database types.
Property Summary
-
$_name protected
string|nullIdentifier name for this type
Method Summary
-
__construct() public
Constructor
-
getBaseType() public
Returns the base type name that this class is inheriting.
-
getName() public
Returns type identifier name for this object.
-
marshal() public
Marshals request data into PHP strings.
-
newId() public
Generate a new primary key value for a given type.
-
requiresToPhpCast() public
Returns whether the cast to PHP is required to be invoked, since it is not a identity function.
-
toDatabase() public
Convert string data into the database format.
-
toPHP() public
Convert string values to PHP strings.
-
toStatement() public
Get the binding type to use in a PDO statement.
Method Detail
__construct() ¶ public
__construct(string|null $name = null)Constructor
Parameters
-
string|null$name optional The name identifying this type
getBaseType() ¶ public
getBaseType(): string|nullReturns 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|nullgetName() ¶ public
getName(): string|nullReturns type identifier name for this object.
Returns
string|nullmarshal() ¶ public
marshal(mixed $value): string|nullMarshals request data into PHP strings.
Most useful for converting request data into PHP objects, that make sense for the rest of the ORM/Database layers.
Parameters
-
mixed$value The value to convert.
Returns
string|nullnewId() ¶ public
newId(): mixedGenerate 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
mixedrequiresToPhpCast() ¶ public
requiresToPhpCast(): boolReturns whether the cast to PHP is required to be invoked, since it is not a identity function.
Returns
booltoDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\Driver $driver): string|nullConvert 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|nulltoPHP() ¶ public
toPHP(mixed $value, Cake\Database\Driver $driver): string|nullConvert string values to PHP strings.
Parameters
-
mixed$value The value to convert.
-
Cake\Database\Driver$driver The driver instance to convert with.
Returns
string|nulltoStatement() ¶ public
toStatement(mixed $value, Cake\Database\Driver $driver): intGet the binding type to use in a PDO statement.
Parameters
-
mixed$value -
Cake\Database\Driver$driver
Returns
int