XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
XoopsConfigItem Class Reference
Inheritance diagram for XoopsConfigItem:
XoopsObject AbstractXoopsObject

Public Member Functions

 __construct ()
 
 getTitle ()
 
 getDesc ()
 
getOptionItems ()
 
 getRoledModuleList ()
 
 getConfValueForOutput ()
 
 setConfValueForInput (&$value, $force_slash=false)
 
 setConfOptions ($option)
 
getConfOptions ()
 
 isEqual (&$config)
 
 loadFromConfigInfo ($mid, &$configInfo, $order=null)
 
- Public Member Functions inherited from XoopsObject
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
getVar ($key, $format='s')
 
 getShow ($key)
 
 set ($key, $value)
 
 get ($key)
 
 getProperty ($key)
 
 getProperties ()
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
xoopsClone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
- Public Member Functions inherited from AbstractXoopsObject
 initVar ($key, $data_type, $default, $required, $size)
 

Data Fields

 $_confOptions = []
 
- Data Fields inherited from XoopsObject
 $vars = []
 
 $cleanVars = []
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = []
 
 $_filters = []
 

Detailed Description

#-

Author
Kazumi Ono onoka.nosp@m.zu@x.nosp@m.oops..nosp@m.org

Definition at line 31 of file configitem.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

Reimplemented from XoopsObject.

Definition at line 45 of file configitem.php.

Member Function Documentation

◆ getConfOptions()

& getConfOptions ( )

Get the XoopsConfigItemOptions of this Config

Returns
array array of XoopsConfigItemOption

Definition at line 184 of file configitem.php.

◆ getConfValueForOutput()

getConfValueForOutput ( )

Get a config value in a format ready for output

Returns
string

Definition at line 115 of file configitem.php.

◆ getDesc()

getDesc ( )

Get a constract of description. If it isn't defined, return null.

Definition at line 76 of file configitem.php.

◆ getOptionItems()

& getOptionItems ( )
Returns
array()

Definition at line 84 of file configitem.php.

◆ getRoledModuleList()

getRoledModuleList ( )
Returns
array()

Definition at line 95 of file configitem.php.

◆ getTitle()

getTitle ( )

Get a constract of title

Definition at line 68 of file configitem.php.

◆ isEqual()

isEqual ( & $config)

Compare with contents of $config object. If it's equal, return true. This member function doesn't use 'conf_id' & 'conf_value' & 'conf_order' to compare.

Parameters
XoopsConfigItem$config
Returns
bool

Definition at line 196 of file configitem.php.

◆ loadFromConfigInfo()

loadFromConfigInfo ( $mid,
& $configInfo,
$order = null )

Definition at line 242 of file configitem.php.

◆ setConfOptions()

setConfOptions ( $option)

Assign one or more XoopsConfigItemOptions

Parameters
mixed$optioneither a XoopsConfigItemOption object or an array of them

Definition at line 165 of file configitem.php.

◆ setConfValueForInput()

setConfValueForInput ( & $value,
$force_slash = false )

Set a config value

Parameters
mixed&$valueValue
bool$force_slash

Definition at line 139 of file configitem.php.

Field Documentation

◆ $_confOptions

$_confOptions = []

Definition at line 40 of file configitem.php.


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