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

Public Member Functions

 __construct ($name, &$plugin)
 
 install ()
 
 uninstall ()
 
 init_config ()
 
 add_newItem ($name, $type, $default=null)
 
 initialise ()
 
 get ()
 
 save ()
 
 delete ()
 
 reset ()
 
 check_data ()
 
 get_fromHeader ()
 
 get_value ($param='', $default=false)
 
 get_translation ($str, $args=null)
 

Public Attributes

 $object_type = 'PluginConfig'
 Object type description. More...
 
 $_libName
 PluginConfig name. More...
 
 $_libParent
 Object parent plugin. More...
 
 $_libItems = array()
 Object item list. More...
 
 $_libDesc
 Object description. More...
 
 $_libError = ''
 Object last error. More...
 
 $name
 Object name. More...
 
 $vars = null
 Object values. More...
 

Private Attributes

 $_libFolder
 Folder where object are stored. More...
 
 $_libFile
 Stored file for object. More...
 

Detailed Description

PluginConfig 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

PluginConfig::__construct (   $name,
$plugin 
)

Class constructor.

Parameters
string$name
Plugin$plugin

Member Function Documentation

PluginConfig::add_newItem (   $name,
  $type,
  $default = null 
)
PluginConfig::check_data ( )

Check object items values.

Returns
boolean
PluginConfig::delete ( )

Delete object file.

Returns
boolean
PluginConfig::get ( )

Load object from file.

Returns
boolean
PluginConfig::get_fromHeader ( )

Load object items values from header.

Returns
void
PluginConfig::get_translation (   $str,
  $args = null 
)

Return locale

Parameters
string$str
mixed$args
Returns
string
PluginConfig::get_value (   $param = '',
  $default = false 
)

Return value.

Parameters
string$param
mixed$default
Returns
mixed
PluginConfig::init_config ( )
PluginConfig::initialise ( )

Initialise object with default values.

Returns
boolean
PluginConfig::install ( )

Install object.

Returns
boolean
PluginConfig::reset ( )

Reset object into file.

Returns
boolean success
PluginConfig::save ( )

Save object to file.

Returns
boolean
PluginConfig::uninstall ( )

Uninstall object.

Returns
boolean

Member Data Documentation

string PluginConfig::$_libDesc

Object description.

string PluginConfig::$_libError = ''

Object last error.

string PluginConfig::$_libFile
private

Stored file for object.

string PluginConfig::$_libFolder
private

Folder where object are stored.

array PluginConfig::$_libItems = array()

Object item list.

string PluginConfig::$_libName

PluginConfig name.

Object PluginConfig::$_libParent

Object parent plugin.

string PluginConfig::$name

Object name.

string PluginConfig::$object_type = 'PluginConfig'

Object type description.

array PluginConfig::$vars = null

Object values.


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