XoopsConfigItem Class Reference

List of all members.

Public Member Functions

 XoopsConfigItem ()
 getTitle ()
 getDesc ()
 getOptionItems ()
getConfValueForOutput ()
 setConfValueForInput (&$value, $force_slash=false)
 setConfOptions ($option)
getConfOptions ()
 isEqual (&$config)

Detailed Description

Author:
Kazumi Ono <onokazu@xoops.org> copyright (c) 2000-2003 XOOPS.org


Member Function Documentation

XoopsConfigItem::XoopsConfigItem (  ) 

Constructor

XoopsConfigItem::getTitle (  ) 

Get a constract of title

XoopsConfigItem::getDesc (  ) 

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

XoopsConfigItem::getOptionItems (  ) 

Returns:
array()

& XoopsConfigItem::getConfValueForOutput (  ) 

Get a config value in a format ready for output

Returns:
string

XoopsConfigItem::setConfValueForInput ( &$  value,
force_slash = false 
)

Set a config value

Parameters:
mixed &$value Value
bool $force_slash

XoopsConfigItem::setConfOptions ( option  ) 

Assign one or more XoopsConfigItemOptions

Parameters:
mixed $option either a XoopsConfigItemOption object or an array of them

& XoopsConfigItem::getConfOptions (  ) 

Get the XoopsConfigItemOptions of this Config

Returns:
array array of XoopsConfigItemOption

XoopsConfigItem::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


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:25 2006 for XOOPS Cube Legacy by  doxygen 1.5.1