.
Gyro-PHP > Documentation

IDBField Interface Reference
[Interfaces]

Interface for DB Field. More...

Inheritance diagram for IDBField:
IPolicyHolder DBField DBFieldBool DBFieldDateTime DBFieldEnum DBFieldFloat DBFieldInt DBFieldText DBFieldDate DBFieldTime DBFieldEnumStati DBFieldSet DBFieldBlob DBFieldSerialized

List of all members.

Public Member Functions
  convert_result ($value)
  Transform result from SELECT to native.
  format ($value)
  Reformat passed value to DB format.
  format_select ()
  Allow replacements for field in select from clause.
  format_where ($value)
  Format for use in WHERE clause.
  get_field_default ()
  Returns the default value for this field.
  get_field_name ()
  Returns name.
  get_null_allowed ()
  Returns true, if null values are allowed.
  has_default_value ()
  Returns true, if field has default value.
  read_from_array ($arr)
  Reads value from array (e.g $_POST) and converts it into something meaningfull.
  set_connection ($connection)
  Set connection of field.
  set_table ($table)
  Set table field belongs to.
  validate ($value)
  Returns true, if the value passed fits the fields restrictions.

Detailed Description

Interface for DB Field.

Author:
Gerd Riesselmann

Definition at line 9 of file idbfield.cls.php.

Member Function Documentation

IDBField::convert_result ( $  value  ) 

Transform result from SELECT to native.

Parameters:
mixed  $value
Returns:
mixed

Implemented in DBField, DBFieldBool, DBFieldDateTime, DBFieldSerialized, and DBFieldSet.

IDBField::format ( $  value  ) 

Reformat passed value to DB format.

Parameters:
mixed  $value
Returns:
string

Implemented in DBField, and DBFieldDateTime.

IDBField::format_select (  ) 

Allow replacements for field in select from clause.

Implemented in DBField, DBFieldBool, DBFieldDateTime, DBFieldSet, and DBFieldTime.

IDBField::format_where ( $  value  ) 

Format for use in WHERE clause.

Parameters:
mixed  $value
Returns:
string

Implemented in DBField, and DBFieldDateTime.

IDBField::get_field_default (  ) 

Returns the default value for this field.

Returns:
mixed

Implemented in DBField, DBFieldDateTime, DBFieldInt, and DBFieldSerialized.

IDBField::get_field_name (  ) 

Returns name.

Returns:
string

Implemented in DBField.

IDBField::get_null_allowed (  ) 

Returns true, if null values are allowed.

Returns:
bool

Implemented in DBField.

IDBField::has_default_value (  ) 

Returns true, if field has default value.

Implemented in DBField, and DBFieldInt.

IDBField::read_from_array ( $  arr  ) 

Reads value from array (e.g $_POST) and converts it into something meaningfull.

Implemented in DBField, DBFieldBool, and DBFieldFloat.

IDBField::set_connection ( $  connection  ) 

Set connection of field.

Parameters:
string|IDBDriver  $connection
Returns:
void

Implemented in DBField.

IDBField::set_table ( $  table  ) 

Set table field belongs to.

Attention:
The table may not be set, fields must be aware of this!
Parameters:
IDBTable  $table
Returns:
void

Implemented in DBField.

IDBField::validate ( $  value  ) 

Returns true, if the value passed fits the fields restrictions.

Parameters:
mixed  $value
Returns:
Status

Implemented in DBField, DBFieldBlob, DBFieldDateTime, DBFieldEnum, DBFieldFloat, DBFieldInt, DBFieldSerialized, DBFieldSet, and DBFieldText.

The documentation for this interface was generated from the following file: