Class TimeType

Properties 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
  \Cake\Database\Type[]

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

• $_className protected
  string

  The classname to use when creating objects.

• $_datetimeInstance protected
  \DateTime

  An instance of the configured dateTimeClass, used to quickly generate new instances without calling the constructor.

• $_format protected
  string|array

  Time format for DateTime object

• $_localeFormat protected
  string|array|int

  The date format to use for parsing incoming dates for marshalling.

• $_name protected
  string|null

  Identifier name for this type.

• $_types protected static
  string[]|\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.

• $_useLocaleParser protected
  bool

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

• $dateTimeClass public static
  string

  The class to use for representing date objects

• $dbTimezone protected
  \DateTimeZone|null

  Timezone instance.

• $setToDateStart protected
  bool

  Whether or not we want to override the time of the converted Time objects so it points to the start of the day.

Method Summary

• __construct() public

  Constructor

• __debugInfo() public

  Returns an array that can be used to describe the internal state of this object.

• _basicTypeCast() protected

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

• _compare() protected
• _parseValue() protected

  Converts a string into a DateTime object after parsing it using the locale aware parser with the specified format.

• _setClassName() protected

  Set the classname to use when building objects.

• boolval() public static

  Type converter for boolean values.

• build() public static

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

• buildAll() public static

  Returns an arrays with all the mapped type objects, indexed 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.

• getDateTimeClassName() public

  Get the classname used for building objects.

• getMap() public static

  Get mapped class name or instance for type(s).

• 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.

• 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

  Convert request data into a datetime object.

• 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

• setLocaleFormat() public

  Sets the format string to use for parsing dates in this class. The formats that are accepted are documented in the Cake\I18n\Time::parseDateTime() function.

• setMap() public static

  Set type to classname mapping.

• setTimezone() public

  Set database timezone.

• strval() public static

  Type converter for string values.

• toDatabase() public

  Convert DateTime instance into strings.

• toPHP() public

  Convert strings into DateTime instances.

• toStatement() public

  Casts given value to Statement equivalent

• useImmutable() public

  Change the preferred class name to the FrozenTime implementation.

• useLocaleParser() public

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

• useMutable() public

  Change the preferred class name to the mutable Time implementation.

Method Detail

__construct(mixed $name)

__debugInfo()

_basicTypeCast(mixed $value)

_compare(mixed $date, mixed $value)

_parseValue(mixed $value)

_setClassName(mixed $class, mixed $fallback)

boolval(mixed $value)

build(mixed $name)

buildAll()

clear()

getBaseType()

getDateTimeClassName()

getMap(mixed $type)

getName()

manyToPHP(array $values, array $fields, \Cake\Database\Driver $driver)

map(mixed $type, mixed $className)

marshal(mixed $value)

newId()

set(mixed $name, \Cake\Database\Type $instance)

setLocaleFormat(mixed $format)

setMap(array $map)

setTimezone(mixed $timezone)

strval(mixed $value)

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

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

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

useImmutable()

useLocaleParser(mixed $enable)

useMutable()

Property Detail