Orpheus Framework
\
Orpheus
Cache
Config
YAML
Controller
Core
DataType
Email
EntityDescriptor
SQLGenerator
User
Exception
File
Form
Hook
InputController
CLIController
HTTPController
Publisher
Exception
Fixture
PermanentObject
Transaction
Rendering
SQLAdapter
Exception
SQLRequest

\Orpheus\EntityDescriptorTypeTime

Entity Type Time class

Summary

Methods
Properties
Constants
parseArgs()
validate()
getHTMLAttr()
htmlInputAttr()
emptyIsNull()
getName()
isWritable()
isNullable()
getHTMLInputAttr()
preFormat()
format()
parseValue()
$format
No constants found
No protected methods found
$name
$writable
$nullable
N/A
No private methods found
No private properties found
N/A

Properties

$format

$format : string

The time format to use

Type

string — If $format is changed, don't forget that the current string limit is 5

$name

$name : string

The type's name

Type

string

$writable

$writable : boolean

Is this type writable ?

Type

boolean

$nullable

$nullable : boolean

Is this type nullable ?

Type

boolean

Methods

parseArgs()

parseArgs(array<mixed,string>  $fargs) : \Orpheus\EntityDescriptor\stdClass

Parse args from field declaration

Parameters

array<mixed,string> $fargs

Arguments

Returns

\Orpheus\EntityDescriptor\stdClass

htmlInputAttr()

htmlInputAttr(array  $args) : string

Get the html input attributes string for the given args

Parameters

array $args

Returns

string

emptyIsNull()

emptyIsNull(\Orpheus\EntityDescriptor\FieldDescriptor  $field) : boolean

Get true if we consider null an empty input string

Parameters

\Orpheus\EntityDescriptor\FieldDescriptor $field

Returns

boolean

getName()

getName() : string

Get the type name

Returns

string —

the type name

isWritable()

isWritable() : boolean

Get true if field is writable

Returns

boolean

isNullable()

isNullable() : boolean

Get true if field is nullable

Returns

boolean

getHTMLInputAttr()

getHTMLInputAttr(\Orpheus\EntityDescriptor\FieldDescriptor  $field) : array<mixed,string>

Get the html input attributes array for the given Field descriptor

Parameters

\Orpheus\EntityDescriptor\FieldDescriptor $field

Returns

array<mixed,string>

preFormat()

preFormat(\Orpheus\EntityDescriptor\FieldDescriptor  $field, string  $value, array  $input, \Orpheus\EntityDescriptor\PermanentEntity  $ref)

Format value before being validated

Parameters

\Orpheus\EntityDescriptor\FieldDescriptor $field

The field to format
string $value

The field value to format
array $input

The input to validate
\Orpheus\EntityDescriptor\PermanentEntity $ref

The object to update, may be null

format()

format(\Orpheus\EntityDescriptor\FieldDescriptor  $field, string  $value)

{@inheritDoc}

Parameters

\Orpheus\EntityDescriptor\FieldDescriptor $field

The field to parse
string $value

The field value to parse

parseValue()

parseValue(\Orpheus\EntityDescriptor\FieldDescriptor  $field, string  $value) : string

Parse the value from SQL scalar to PHP type

Parameters

\Orpheus\EntityDescriptor\FieldDescriptor $field

The field to parse
string $value

The field value to parse

Returns

string —

The parse $value