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.0 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.0
      • 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
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class FloatType

Float type converter.

Use to convert float/decimal data between PHP and the database types.

Namespace: Cake\Database\Type

Property Summary

  • $_basicTypes protected static
    array

    List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these

  • $_builtTypes protected static
    array

    Contains a map of type object instances to be reused if needed

  • $_name protected
    string

    Identifier name for this type

  • $_types protected static
    array

    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.

  • $_useLocaleParser protected
    bool

    Whether numbers should be parsed using a locale aware parser when marshalling string inputs.

  • $numberClass public static
    string

    The class to use for representing number objects

Method Summary

  • __construct() public

    Constructor

  • _basicTypeCast() protected

    Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value

  • _parseValue() protected

    Converts a string into a float point after parseing it using the locale aware parser.

  • boolval() public static

    Type converter for boolean values.

  • build() public static

    Returns a Type object capable of converting a type identified by $name

  • clear() public static

    Clears out all created instances and mapped types classes, useful for testing

  • getBaseType() public

    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.

  • getName() public

    Returns type identifier name for this object

  • map() public static

    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

  • marshal() public

    Marshalls request data into PHP floats.

  • newId() public

    Generate a new primary key value for a given type.

  • set() public static

    Returns a Type object capable of converting a type identified by $name

  • strval() public static

    Type converter for string values.

  • toDatabase() public

    Convert integer data into the database format.

  • toPHP() public

    Convert float values to PHP integers

  • toStatement() public

    Get the correct PDO binding type for integer data.

  • useLocaleParser() public

    Sets whether or not to parse numbers passed to the marshal() function by using a locale aware parser.

Method Detail

__construct() ¶ public

__construct(string $name = null)

Constructor

Parameters
string $name optional

The name identifying this type

_basicTypeCast() ¶ protected

_basicTypeCast(mixed $value): mixed

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

_parseValue() ¶ protected

_parseValue(string $value): float

Converts a string into a float point after parseing it using the locale aware parser.

Parameters
string $value

The value to parse and convert to an float.

Returns
float

boolval() ¶ public static

boolval(mixed $value): bool

Type converter for boolean values.

Will convert string true/false into booleans.

Parameters
mixed $value

The value to convert to a boolean.

Returns
bool

build() ¶ public static

build(string $name): Type

Returns a Type object capable of converting a type identified by $name

Parameters
string $name

type identifier

Returns
Type
Throws
InvalidArgumentException
If type identifier is unknown

clear() ¶ public static

clear(): void

Clears out all created instances and mapped types classes, useful for testing

Returns
void

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

map() ¶ public static

map(string|array|null $type = null, string|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

Parameters
string|array|null $type optional

if string name of type to map, if array list of arrays to be mapped

string|null $className optional

The classname to register.

Returns
array|string|null

marshal() ¶ public

marshal(mixed $value): mixed

Marshalls request data into PHP floats.

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

set() ¶ public static

set(string $name, Cake\Database\Type $instance): void

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.

Returns
void

strval() ¶ public static

strval(mixed $value): bool

Type converter for string values.

Will convert values into strings

Parameters
mixed $value

The value to convert to a string.

Returns
bool

toDatabase() ¶ public

toDatabase(mixed $value, Driver $driver): string|resource

Convert integer data into the database format.

Parameters
mixed $value

The value to convert.

Driver $driver

The driver instance to convert with.

Returns
string|resource

toPHP() ¶ public

toPHP(mixed $value, Driver $driver): resource

Convert float values to PHP integers

Parameters
mixed $value

The value to convert.

Driver $driver

The driver instance to convert with.

Returns
resource
Throws
Cake\Core\Exception\Exception

toStatement() ¶ public

toStatement(mixed $value, Driver $driver): int

Get the correct PDO binding type for integer data.

Parameters
mixed $value

The value being bound.

Driver $driver

The driver.

Returns
int

useLocaleParser() ¶ public

useLocaleParser(bool $enable = true): $this

Sets whether or not to parse numbers passed to the marshal() function by using a locale aware parser.

Parameters
bool $enable optional

Whether or not to enable

Returns
$this

Property Detail

$_basicTypes ¶ protected static

List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these

Type
array

$_builtTypes ¶ protected static

Contains a map of type object instances to be reused if needed

Type
array

$_name ¶ protected

Identifier name for this type

Type
string

$_types ¶ protected static

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.

Type
array

$_useLocaleParser ¶ protected

Whether numbers should be parsed using a locale aware parser when marshalling string inputs.

Type
bool

$numberClass ¶ public static

The class to use for representing number objects

Type
string
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