API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsConfigItem Class Reference
Inheritance diagram for XoopsConfigItem:
Collaboration diagram for XoopsConfigItem:

Public Member Functions

 __construct ()
 
 id ($format='N')
 
 conf_id ($format='')
 
 conf_modid ($format='')
 
 conf_catid ($format='')
 
 conf_name ($format='')
 
 conf_title ($format='')
 
 conf_value ($format='')
 
 conf_desc ($format='')
 
 conf_formtype ($format='')
 
 conf_valuetype ($format='')
 
 conf_order ($format='')
 
 getConfValueForOutput ()
 
 setConfValueForInput (&$value, $force_slash=false)
 
 setConfOptions ($option)
 
getConfOptions ()
 
 clearConfOptions ()
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 XoopsObject ()
 
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 destroyVars ($var)
 
 destoryVars ($var)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
 getValues ($keys=null, $format='s', $maxDepth=1)
 
 getVar ($key, $format=null)
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
 loadFilters ($method)
 
 xoopsClone ()
 
 __clone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
 toArray ()
 

Data Fields

 $_confOptions = array()
 
- Data Fields inherited from XoopsObject
 $vars = array()
 
 $cleanVars = array()
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = array()
 
 $_filters = array()
 

Detailed Description

#-

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

Reimplemented from XoopsObject.

Here is the call graph for this function:

Member Function Documentation

◆ clearConfOptions()

clearConfOptions ( )

Clear options from this item

Returns
void

◆ conf_catid()

conf_catid (   $format = '')

Returns Class Base Variable conf_catid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_desc()

conf_desc (   $format = '')

Returns Class Base Variable conf_desc

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_formtype()

conf_formtype (   $format = '')

Returns Class Base Variable conf_formtype

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_id()

conf_id (   $format = '')

Returns Class Base Variable conf_id

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_modid()

conf_modid (   $format = '')

Returns Class Base Variable conf_modid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_name()

conf_name (   $format = '')

Returns Class Base Variable conf_name

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_order()

conf_order (   $format = '')

Returns Class Base Variable conf_order

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_title()

conf_title (   $format = '')

Returns Class Base Variable conf_title

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_value()

conf_value (   $format = '')

Returns Class Base Variable conf_value

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ conf_valuetype()

conf_valuetype (   $format = '')

Returns Class Base Variable conf_valuetype

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ getConfOptions()

& getConfOptions ( )

Get the XoopsConfigItemOptions of this Config

Returns
array array of XoopsConfigItemOption

◆ getConfValueForOutput()

getConfValueForOutput ( )

Get a config value in a format ready for output

Returns
string
Here is the call graph for this function:

◆ id()

id (   $format = 'N')

Returns Class Base Variable conf_id

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ setConfOptions()

setConfOptions (   $option)

Assign one or more XoopsConfigItemOptions

Parameters
mixed$optioneither a XoopsConfigItemOption object or an array of them
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setConfValueForInput()

setConfValueForInput ( $value,
  $force_slash = false 
)

Set a config value

Parameters
mixed&$valueValue
bool$force_slash
Here is the call graph for this function:

Field Documentation

◆ $_confOptions

$_confOptions = array()

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