MLDatabaseItem Class Reference

Database item of Module Library item. More...

Inheritance diagram for MLDatabaseItem:

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_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...
	$type
	Item type. More...
	$datadesc
	Item data description. More...
	$datadesc2
	Item data description. More...

Additional Inherited Members
Protected Member Functions inherited from ModuleLibraryItem
	compile_listValue ($value)
	uncompile_listValue ($value)

Detailed Description

Database item of Module Library item.

Engine / Object Library

Author

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

Version

1.0.3.1

Date

Creation: Apr 2007

Modification: Jul 2025

Copyright

2007 - 2025 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. MLDatabaseItem class.

Constructor & Destructor Documentation

__construct()

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

Class constructor.

Parameters

string	$name
string	$datatype
string	$desc
mixed	$desc2
mixed	$default

Reimplemented in MLDatabaseLocalizedItem.

Member Function Documentation

initialise()

MLDatabaseItem::initialise

(

)

Initialise object with default value.

Returns

void

Reimplemented in MLDatabaseLocalizedItem.

get_fromHeader()

MLDatabaseItem::get_fromHeader

(

$prefix = ''

)

Load object value from header.

Parameters

string

$prefix

Returns

void

Reimplemented in MLDatabaseLocalizedItem.

get_fromArray()

MLDatabaseItem::get_fromArray

(

$data

)

Load object value from an array.

Returns

void

Reimplemented from ModuleLibraryItem.

Reimplemented in MLDatabaseLocalizedItem.

get_databaseDescription()

MLDatabaseItem::get_databaseDescription

(

)

Return database description.

Returns

mixed

get_databaseValue()

MLDatabaseItem::get_databaseValue

(

$language = null

)

Return value optimised for database.

Returns

mixed

Reimplemented in MLDatabaseLocalizedItem.

get_defaultValue()

MLDatabaseItem::get_defaultValue

(

)

Return default value.

Returns

mixed

get_exportedValue()

MLDatabaseItem::get_exportedValue

(

)

Return value as structured array name => value.

Returns

array

Reimplemented in MLDatabaseLocalizedItem.

check_value()

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

Check value case of given type.

Parameters

string	$type
mixed	$default

Returns

void

Member Data Documentation

$datatype

string MLDatabaseItem::$datatype

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

$datadesc

string MLDatabaseItem::$datadesc

Item data description (database type compatible with MySQL).

$datadesc2

string MLDatabaseItem::$datadesc2

Secondary information of item data description.

---

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

• CaMykS/engine/lib/object/MLDatabaseItem.php.inc