Binary type converter.
Use to convert binary data between PHP and the database types.
$_types : array<mixed,string>|array<mixed,\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.
$_builtTypes : array<mixed,\Cake\Database\Type>
Contains a map of type object instances to be reused if needed.
build(string $name) : \Cake\Database\Type
Returns a Type object capable of converting a type identified by name.
| string | $name | type identifier |
If type identifier is unknown
set(string $name, \Cake\Database\Type $instance) : void
Returns a Type object capable of converting a type identified by $name
| string | $name | The type identifier you want to set. |
| \Cake\Database\Type | $instance | The type instance you want to set. |
map(string|array<mixed,string>|array<mixed,\Cake\Database\Type>|null $type = null, string|\Cake\Database\Type|null $className = null) : array|string|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
Deprecated 3.6.2:
| string|array<mixed,string>|array<mixed,\Cake\Database\Type>|null | $type | If string name of type to map, if array list of arrays to be mapped |
| string|\Cake\Database\Type|null | $className | The classname or object instance of it to register. |
If $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
getMap(string|null $type = null) : array|string|\Cake\Database\TypeInterface|null
Get mapped class name or instance for type(s).
| string|null | $type | Type name to get mapped class for or null to get map array. |
Configured class name or instance for give $type or map array.
getBaseType() : string
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.
The base type name that this class is inheriting.
toDatabase(string|resource $value, \Cake\Database\Driver $driver) : string|resource
Convert binary data into the database format.
Binary data is not altered before being inserted into the database. As PDO will handle reading file handles.
| string|resource | $value | The value to convert. |
| \Cake\Database\Driver | $driver | The driver instance to convert with. |
toPHP(null|string|resource $value, \Cake\Database\Driver $driver) : resource|null
Convert binary into resource handles
| null|string|resource | $value | The value to convert. |
| \Cake\Database\Driver | $driver | The driver instance to convert with. |
toStatement(mixed $value, \Cake\Database\Driver $driver) : integer
Get the correct PDO binding type for Binary data.
| mixed | $value | The value being bound. |
| \Cake\Database\Driver | $driver | The driver. |
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Type;
use Cake\Core\Exception\Exception;
use Cake\Database\Driver;
use Cake\Database\Driver\Sqlserver;
use Cake\Database\Type;
use Cake\Database\TypeInterface;
use PDO;
/**
* Binary type converter.
*
* Use to convert binary data between PHP and the database types.
*/
class BinaryType extends Type implements TypeInterface
{
/**
* Identifier name for this type.
*
* (This property is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @var string|null
*/
protected $_name;
/**
* Constructor.
*
* (This method is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @param string|null $name The name identifying this type
*/
public function __construct($name = null)
{
$this->_name = $name;
}
/**
* Convert binary data into the database format.
*
* Binary data is not altered before being inserted into the database.
* As PDO will handle reading file handles.
*
* @param string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return string|resource
*/
public function toDatabase($value, Driver $driver)
{
return $value;
}
/**
* Convert binary into resource handles
*
* @param null|string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return resource|null
* @throws \Cake\Core\Exception\Exception
*/
public function toPHP($value, Driver $driver)
{
if ($value === null) {
return null;
}
if (is_string($value)
&& $driver instanceof Sqlserver
&& version_compare(PHP_VERSION, '7.0', '<')
) {
$value = pack('H*', $value);
}
if (is_string($value)) {
return fopen('data:text/plain;base64,' . base64_encode($value), 'rb');
}
if (is_resource($value)) {
return $value;
}
throw new Exception(sprintf('Unable to convert %s into binary.', gettype($value)));
}
/**
* Get the correct PDO binding type for Binary data.
*
* @param mixed $value The value being bound.
* @param \Cake\Database\Driver $driver The driver.
* @return int
*/
public function toStatement($value, Driver $driver)
{
return PDO::PARAM_LOB;
}
/**
* Marshalls flat data into PHP objects.
*
* Most useful for converting request data into PHP objects
* that make sense for the rest of the ORM/Database layers.
*
* @param mixed $value The value to convert.
*
* @return mixed Converted value.
*/
public function marshal($value)
{
return $value;
}
}