XOOPS Docs - XOOPS
[ class tree: XOOPS ] [ index: XOOPS ] [ all elements ]

Class: XoopsConfigHandler

Source Location: /kernel/config.php

Class Overview


XOOPS configuration handling class.


Author(s):

Methods



Class Details

[line 59]
XOOPS configuration handling class.

This class acts as an interface for handling general configurations of XOOPS and its modules.




Tags:

author:  Kazumi Ono <webmaster@myweb.ne.jp>
todo:  Tests that need to be made:
  • error handling
access:  public


[ Top ]


Class Methods


constructor XoopsConfigHandler [line 92]

XoopsConfigHandler XoopsConfigHandler( object &$db)

Constructor



Parameters:

object   &$db   reference to database object

[ Top ]

method createConfig [line 104]

object reference &createConfig( )

Create a config



Tags:

return:  to the new XoopsConfigItem
see:  XoopsConfigItem


[ Top ]

method createConfigOption [line 239]

object {@link &createConfigOption( )

Make a new XoopsConfigOption



Tags:

return:  XoopsConfigOption}


[ Top ]

method deleteConfig [line 158]

void deleteConfig( object &$config)

Delete a config from the database



Parameters:

object   &$config   reference to a XoopsConfigItem

[ Top ]

method getConfig [line 117]

object reference &getConfig( int $id, [bool $withoptions = false])

Get a config



Tags:

return:  to the XoopsConfig


Parameters:

int   $id   ID of the config
bool   $withoptions   load the config's options now?

[ Top ]

method getConfigCount [line 199]

void getConfigCount( [object $criteria = null])

Count some configs



Parameters:

object   $criteria   CriteriaElement

[ Top ]

method getConfigList [line 289]

array getConfigList( int $conf_modid, [int $conf_catid = 0])

Get a list of configs



Tags:

return:  Associative array of name=>value pairs.


Parameters:

int   $conf_modid   ID of the modules
int   $conf_catid   ID of the category

[ Top ]

method getConfigOption [line 251]

object {@link &getConfigOption( int $id)

Get a XoopsConfigOption



Tags:

return:  XoopsConfigOption}


Parameters:

int   $id   ID of the config option

[ Top ]

method getConfigOptions [line 264]

array getConfigOptions( [object $criteria = null], [bool $id_as_key = false])

Get one or more XoopsConfigOptions



Tags:

return:  Array of XoopsConfigOptions


Parameters:

object   $criteria   CriteriaElement
bool   $id_as_key   Use IDs as keys in the array?

[ Top ]

method getConfigOptionsCount [line 276]

int getConfigOptionsCount( [object $criteria = null])

Count some XoopsConfigOptions



Tags:

return:  Count of XoopsConfigOptions matching $criteria


Parameters:

object   $criteria   CriteriaElement

[ Top ]

method getConfigs [line 189]

array getConfigs( [object $criteria = null], [bool $id_as_key = false], [bool $with_options = false])

get one or more Configs



Tags:

return:  Array of XoopsConfigItem objects


Parameters:

object   $criteria   CriteriaElement
bool   $id_as_key   Use the configs' ID as keys?
bool   $with_options   get the options now?

[ Top ]

method getConfigsByCat [line 212]

array &getConfigsByCat( int $category, [int $module = 0])

Get configs from a certain category



Tags:

return:  array of XoopsConfigs


Parameters:

int   $category   ID of a category
int   $module   ID of a module

[ Top ]

method insertConfig [line 131]

void insertConfig( object &$config)

insert a new config in the database



Parameters:

object   &$config   reference to the XoopsConfigItem

[ Top ]


XOOPS Docs generated by phpDocumentor