CaMykS  1.0-20181201
 All Classes Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
MLDatabaseItem Class Reference
Inheritance diagram for MLDatabaseItem:
Inheritance graph
[legend]
Collaboration diagram for MLDatabaseItem:
Collaboration graph
[legend]

Public Member Functions

 __construct ($name, $datatype, $desc, $desc2='', $default=null)
 
 initialise ()
 
 get_fromHeader ($prefix='')
 
 get_fromArray ($data)
 
 get_databaseDescription ()
 
 get_databaseValue ($language=null)
 
 get_defaultValue ()
 
 get_exportedValue ()
 
 check_value ($type=null, $default=null)
 
- Public Member Functions inherited from ModuleLibraryItem
 get_fromArray ($data)
 
 get_valueFromHeader ($name)
 
 get_dateFromHeader ($name)
 
 parse_PHPTags ($value)
 

Public Attributes

 $datatype
 Item data type, can be text / etext / int / float / date / password / list. More...
 
 $datadesc
 Item data description (database type compatible with MySQL). More...
 
 $datadesc2
 Secondary information of item data description. More...
 
- Public Attributes inherited from ModuleLibraryItem
 $name
 Item name. More...
 
 $default
 Item default value. More...
 
 $value
 Item current value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ModuleLibraryItem
 compile_listValue ($value)
 
 uncompile_listValue ($value)
 

Detailed Description

MLDatabaseItem class.

Author
CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Constructor & Destructor Documentation

MLDatabaseItem::__construct (   $name,
  $datatype,
  $desc,
  $desc2 = '',
  $default = null 
)

Class constructor.

Parameters
string$name
string$datatype
string$desc
mixed$desc2
mixed$default
Returns
void

Member Function Documentation

MLDatabaseItem::check_value (   $type = null,
  $default = null 
)

Check value case of given type.

Parameters
string$type
mixed$default
Returns
void
MLDatabaseItem::get_databaseDescription ( )

Return database description.

Returns
mixed
MLDatabaseItem::get_databaseValue (   $language = null)

Return value optimised for database.

Returns
mixed
MLDatabaseItem::get_defaultValue ( )

Return default value.

Returns
mixed
MLDatabaseItem::get_exportedValue ( )

Return value as structured array name => value.

Returns
array
MLDatabaseItem::get_fromArray (   $data)

Load object value from an array.

Returns
void
MLDatabaseItem::get_fromHeader (   $prefix = '')

Load object value from header.

Parameters
string$prefix
Returns
void
MLDatabaseItem::initialise ( )

Initialise object with default value.

Returns
void

Member Data Documentation

string MLDatabaseItem::$datadesc

Item data description (database type compatible with MySQL).

string MLDatabaseItem::$datadesc2

Secondary information of item data description.

string MLDatabaseItem::$datatype

Item data type, can be text / etext / int / float / date / password / list.


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