CaMykS  1.0-20231201
Public Member Functions | Public Attributes | List of all members
MLTemporaryItem Class Reference

Temporary item of Module Library Item. More...

Inheritance diagram for MLTemporaryItem:
ModuleLibraryItem

Public Member Functions

 __construct ($name, $type='', $default='')
 
 initialise ()
 
 get ()
 
 get_fromHeader ($prefix='')
 
 get_exportedValue ()
 
 get_fromArray ($data)
 
- Public Member Functions inherited from ModuleLibraryItem
 get_valueFromHeader ($name)
 
 get_dateFromHeader ($name)
 
 parse_PHPTags ($value)
 

Public Attributes

 $type
 Item type. 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

Temporary 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.0.1
Date
Creation: May 2007
Modification: Mar 2023
Note
This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. MLTemporaryItem class.

Constructor & Destructor Documentation

◆ __construct()

MLTemporaryItem::__construct (   $name,
  $type = '',
  $default = '' 
)

Class constructor.

Parameters
string$name
string$type
mixed$default
Returns
void

Member Function Documentation

◆ initialise()

MLTemporaryItem::initialise ( )

Initialise object with default value.

Returns
void

◆ get()

MLTemporaryItem::get ( )

Load object.

Returns
void

◆ get_fromHeader()

MLTemporaryItem::get_fromHeader (   $prefix = '')

Load object value from header.

Parameters
string$prefix
Returns
void

◆ get_exportedValue()

MLTemporaryItem::get_exportedValue ( )

Return values as structured array $name => $value

Returns
array

◆ get_fromArray()

MLTemporaryItem::get_fromArray (   $data)

Load object value from given array.

Parameters
array$data
Returns
void

Reimplemented from ModuleLibraryItem.

Member Data Documentation

◆ $type

string MLTemporaryItem::$type

Item type.


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