CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.0 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.0
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
    • Cache
      • Engine
    • Collection
      • Iterator
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
      • Formatter
      • Parser
    • Log
      • Engine
    • Network
      • Email
      • Exception
      • Http
        • Adapter
        • Auth
        • FormData
      • Session
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Rule
    • Routing
      • Exception
      • Filter
      • Route
    • Shell
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • BinaryType
  • DateTimeType
  • DateType
  • FloatType
  • IntegerType
  • TimeType
  • UuidType

Class BinaryType

Binary type converter.

Use to convert binary data between PHP and the database types.

Cake\Database\Type
Extended by Cake\Database\Type\BinaryType
Namespace: Cake\Database\Type
Location: Database/Type/BinaryType.php

Inherited Properties

  • _basicTypes, _builtTypes, _name, _types

Method Summary

  • toDatabase() public
    Convert binary data into the database format.
  • toPHP() public
    Convert binary into resource handles
  • toStatement() public
    Get the correct PDO binding type for Binary data.

Method Detail

toDatabase() public ¶

toDatabase( string|resource $value , Cake\Database\Driver $driver )

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.

Parameters
string|resource $value
The value to convert.
Cake\Database\Driver $driver
The driver instance to convert with.
Returns
string|resource
Overrides
Cake\Database\Type::toDatabase()

toPHP() public ¶

toPHP( null|string|resource $value , Cake\Database\Driver $driver )

Convert binary into resource handles

Parameters
null|string|resource $value
The value to convert.
Cake\Database\Driver $driver
The driver instance to convert with.
Returns
resource|null
Throws
Cake\Core\Exception\Exception
Overrides
Cake\Database\Type::toPHP()

toStatement() public ¶

toStatement( mixed $value , Cake\Database\Driver $driver )

Get the correct PDO binding type for Binary data.

Parameters
mixed $value
The value being bound.
Cake\Database\Driver $driver
The driver.
Returns
integer
Overrides
Cake\Database\Type::toStatement()

Methods inherited from Cake\Database\Type

__construct() public ¶

__construct( string $name null )

Constructor

Parameters
string $name optional null
The name identifying this type

_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
boolean

build() 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\Type
Throws
InvalidArgumentException
If type identifier is unknown

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

getName() public ¶

getName( )

Returns type identifier name for this object

Returns
string

map() public static ¶

map( string|array|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|null $type optional null
if string name of type to map, if array list of arrays to be mapped
string|null $className optional null
The classname 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 )

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.

Parameters
mixed $value
The value to convert.
Returns
mixed
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
Cake\Database\Type\UuidType

set() 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() 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
boolean
Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs