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

Public Member Functions

 __construct ($name, $type, $default=null)
 
 initialise ()
 
 check_value ($value)
 
 get_fromHeader ()
 
 get_default ()
 
 update_type ($value)
 

Public Attributes

 $_name
 Item name. More...
 
 $_type
 Item type. More...
 
 $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...
 

Private Attributes

 $_default
 Item default value. More...
 

Detailed Description

PushNotification 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

◆ __construct()

PluginConfigItem::__construct (   $name,
  $type,
  $default = null 
)

Class constructor.

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

Member Function Documentation

◆ initialise()

PluginConfigItem::initialise ( )

Initialise object with default value.

Returns
void

◆ check_value()

PluginConfigItem::check_value (   $value)

Return checked value case of object type.

Parameters
mixed$value
Returns
mixed

◆ get_fromHeader()

PluginConfigItem::get_fromHeader ( )

Load object value from header.

Returns
mixed

◆ get_default()

PluginConfigItem::get_default ( )

Load default value case of object type

Returns
mixed

◆ update_type()

PluginConfigItem::update_type (   $value)

Update value type

Parameters
mixed$value
Returns
mixed

Member Data Documentation

◆ $_name

string PluginConfigItem::$_name

Item name.

◆ $_type

string PluginConfigItem::$_type

Item type.

◆ $_default

string PluginConfigItem::$_default
private

Item default value.

◆ $datatype

string PluginConfigItem::$datatype

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

◆ $datadesc

string PluginConfigItem::$datadesc

Item data description (database type compatible with MySQL).

◆ $datadesc2

string PluginConfigItem::$datadesc2

Secondary information of item data description.


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