XoopsConfigItemHandler Class Reference

Inheritance diagram for XoopsConfigItemHandler:

Collaboration diagram for XoopsConfigItemHandler:

Public Member Functions
	create ($isNew=true)
	get ($id)
	insert (XoopsObject $config)
	delete (XoopsObject $config)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
Public Member Functions inherited from XoopsObjectHandler
	__construct (XoopsDatabase $db)
	XoopsObjectHandler ($db)
	create ()
	get ($id)
	insert (XoopsObject $object)
	delete (XoopsObject $object)

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

XOOPS configuration handler class.

This class is responsible for providing data access mechanisms to the data source of XOOPS configuration class objects.

Author

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

Copyright

(c) 2000-2016 XOOPS Project (www.xoops.org)

Member Function Documentation

create()

create

(

$isNew = true

)

Create a new XoopsConfigItem

See also

XoopsConfigItem

Parameters

bool

$isNew

Flag the config as "new"?

Returns

XoopsConfigItem reference to the new config

delete()

delete

(

XoopsObject

$config

)

Delete a config from the database

Parameters

XoopsObject | XoopsConfigItem

$config

a XoopsConfigCategory object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

get()

get

(

$id

)

Load a config from the database

Parameters

int

$id

ID of the config

Returns

XoopsConfigItem reference to the config, FALSE on fail

Reimplemented from XoopsObjectHandler.

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count configs

Parameters

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Returns

int Count of configs matching $criteria

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

Get configs from the database

Parameters

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement
bool	$id_as_key	return the config's id as key?

Returns

array Array of XoopsConfigItem objects

insert()

insert

(

XoopsObject

$config

)

Write a config to the database

Parameters

XoopsObject | XoopsConfigItem

$config

a XoopsConfigCategory object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

---

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

• C:/xoops2511b2/htdocs/kernel/configitem.php