Class JsonType
JSON type converter.
Use to convert JSON data between PHP and the database types.
Property Summary
-
$_encodingOptions protected
int -
$_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.
-
manyToPHP() public
Returns an array of the values converted to the PHP representation of this type.
-
marshal() public
Marshals request data into a JSON compatible structure.
-
newId() public
Generate a new primary key value for a given type.
-
setEncodingOptions() public
Set json_encode options.
-
toDatabase() public
Convert a value data into a JSON string
-
toPHP() public
Casts given value from a database type to a PHP equivalent.
-
toStatement() public
Get the correct PDO binding type for string data.
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|nullmanyToPHP() ¶ public
manyToPHP(array $values, array<string> $fields, Cake\Database\DriverInterface $driver): array<string, mixed>Returns an array of the values converted to the PHP representation of this type.
Parameters
-
array$values -
array<string>$fields -
Cake\Database\DriverInterface$driver
Returns
array<string, mixed>marshal() ¶ public
marshal(mixed $value): mixedMarshals request data into a JSON compatible structure.
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
mixednewId() ¶ 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
mixedsetEncodingOptions() ¶ public
setEncodingOptions(int $options): $thisSet json_encode options.
Parameters
-
int$options Encoding flags. Use JSON_* flags. Set
0to reset.
Returns
$thisSee Also
toDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|nullConvert a value data into a JSON string
Parameters
-
mixed$value The value to convert.
-
Cake\Database\DriverInterface$driver The driver instance to convert with.
Returns
string|nullThrows
InvalidArgumentExceptiontoPHP() ¶ public
toPHP(mixed $value, Cake\Database\DriverInterface $driver): array|string|nullCasts given value from a database type to a PHP equivalent.
Parameters
-
mixed$value The value to convert.
-
Cake\Database\DriverInterface$driver The driver instance to convert with.
Returns
array|string|nulltoStatement() ¶ public
toStatement(mixed $value, Cake\Database\DriverInterface $driver): intGet the correct PDO binding type for string data.
Parameters
-
mixed$value The value being bound.
-
Cake\Database\DriverInterface$driver The driver.
Returns
int