Documentation

DatetimeField extends Field

in package

• Application

Represents a table's field in a database. Contains information about the table the field belongs to, the name of the field and if it is (or not) a primary key or auto-increment field.

Table of Contents

TYPE_BOOLEAN  = 'boolean'

TYPE_BRIDGED  = 'bridged'

TYPE_CHILDREN  = 'children'

TYPE_DATETIME  = 'datetime'

TYPE_FILE  = 'file'

TYPE_FLOAT  = 'float'

TYPE_INTEGER  = 'int'

This constants represent the list of basic data types that spitfire supports. This should be supported by the DBMS to be used.

TYPE_LONG  = 'long'

TYPE_REFERENCE  = 'reference'

TYPE_STRING  = 'string'

TYPE_TEXT  = 'txt'

$auto_increment  : bool

Indicates whether the field is to be incremented everytime a new record is inserted into the DBMS. This task is handled by the DBMS and Spitfire therefore does not guarantee nor enforce that the task of incrementing the field is handled correctly.

$default  : mixed

Contains the default value for this field. In the event of this field being null but the field not-nullable, the driver should define a proper "empty" value for it's data type.

$name  : string

Contains the name of the field inside of the model. This name should be unique and is recommended not to conatin any underscores or hyphens other than those generated by Spitfire itself to indicate it's relation with other fields and models.

$nullable  : bool

Defines whether the field's value can be set to null or not. In case this happens the database will allow null values for this field.

$physical  : Field|array<string|int, Field>

Contains the physical (DB) fields that are used to store the data this Field generates. For most data types Spitfire will just generate one physical field for each logical one.

$primary  : bool

This property indicates whether the field belongs or not to the model 's primary Key. This key is the one used to identify records uniquely.

$schema  : Schema

Contains a reference to the parent model. This allows this field to interact with it and to retrieve information about the model, the table it is in and even the DB engine that holds them.

$unique  : bool

This indicates whether the content of this field needs to be enforced to be unique. This restriction is handled by the DBMS and Spitfire does not guarantee that this is respected.

__toString()  : string

Returns the name of the Field, this is purely a conveiencce method to shorten code writing and make it easier to read.

getAdapter()  : AdapterInterface

Returns the adapter this field wants to use for the database interaction, usually this will be a BaseAdapter that allows the most basic interaction with the most basic kinds of fields.

getBeanField()  : Field|null

Returns the field the bean should use to render this. In case it returns null it means the field has no suggestions and the Bean should choose the way to render it

getConnectorQueries()  : mixed

getDataType()  : mixed

This method informs the system what primary datatype the overriding Field class uses. You can define custom classes that store data into any DBMS by defining which primary data they use.

getDefault()  : mixed

getModel()  : Schema

Gets the parent model for this field. This allows the field to deliver data about which fields it's a sibling to and which fields it refers too.

getName()  : string

Returns the name of this field. The name identifies this field among the rest of the fields of the same model / table.

getNullable()  : mixed

getPhysical()  : array<string|int, Field>

This method returns an array of Fields. Even if the field has only one db equivalent the return value will be an array, for consistency with fields which return several ones.

getSchema()  : mixed

getTable()  : Table

Returns the table this field belongs to. This is just a shortcut method provided to allow making logical fields and DBFields compatible.

isAutoIncrement()  : bool

Returns whether the field is autoincrement. This means, everytime a new record of this kind is created the auto_increment field is increased by 1.

isIndexed()  : bool

The return value of this method indicates whether the DBMS SHOULD create an index on this field. This depends on the kind of content and the settings of this field.

isPrimary()  : bool

Returns true if the field belongs to the table's primary key. Keep in mind that a primary key can cover several fields.

isUnique()  : bool

Returns true if the field has a unique flag, alas it's content cannot be repeated among several records.

makePhysical()  : mixed

This method initializes the Physical equivalent(s) of the Field, this is done in a separate method from the contructor to ease overriding of this logic.

setAutoIncrement()  : self

Defines whether the field is used as autoincrement field. This setting will have no effect on any field that is not an integer field.

setDefault()  : mixed

setModel()  : mixed

Defines which model this field belongs to. This data basically is redundant but quickens development and makes it more efficient to find the model for the field.

setName()  : Field

Sets the name of this field. The name identifies this field among the rest of the fields of the same model / table.

setNullable()  : mixed

setPhysical()  : mixed

Sets the physical equivalent of this field. This needs to be a instance of DBField or an array of those.

setPrimary()  : self

Defines whether this belongs to the primary key or not. This will also automatically set the unique flag to true.

setSchema()  : mixed

Defines which model this field belongs to. This data basically is redundant but quickens development and makes it more efficient to find the model for the field.

setUnique()  : self

Allows you to define whether the current field only allows unique (non repeated) values. When using data that only should allow unique values setting this flag to true will consistently increase the speed of database queries.

validate()  : bool|ValidationError