CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 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

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Retry
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Interface TypeInterface

Encapsulates all conversion functions for values coming from a database into PHP and going from PHP into a database.

Namespace: Cake\Database

Method Summary

  • getBaseType() public

    Returns the base type name that this class is inheriting.

  • getName() public

    Returns type identifier name for this object.

  • marshal() public

    Marshals flat data into PHP objects.

  • newId() public

    Generate a new primary key value for a given type.

  • toDatabase() public

    Casts given value from a PHP type to one acceptable by a database.

  • toPHP() public

    Casts given value from a database type to a PHP equivalent.

  • toStatement() public

    Casts given value to its Statement equivalent.

Method Detail

getBaseType() ¶ public

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.

Returns
string

getName() ¶ public

getName(): string

Returns type identifier name for this object.

Returns
string

marshal() ¶ public

marshal(mixed $value): mixed

Marshals 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

newId() ¶ public

newId(): mixed

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
See Also
\Cake\Database\Type\UuidType

toDatabase() ¶ public

toDatabase(mixed $value, Cake\Database\Driver $driver): mixed

Casts given value from a PHP type to one acceptable by a database.

Parameters
mixed $value

Value to be converted to a database equivalent.

Cake\Database\Driver $driver

Object from which database preferences and configuration will be extracted.

Returns
mixed

toPHP() ¶ public

toPHP(mixed $value, Cake\Database\Driver $driver): mixed

Casts given value from a database type to a PHP equivalent.

Parameters
mixed $value

Value to be converted to PHP equivalent

Cake\Database\Driver $driver

Object from which database preferences and configuration will be extracted

Returns
mixed

toStatement() ¶ public

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

Casts given value to its Statement equivalent.

Parameters
mixed $value

Value to be converted to PDO statement.

Cake\Database\Driver $driver

Object from which database preferences and configuration will be extracted.

Returns
mixed
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs