XoopsModuleHandler Class Reference

Inheritance diagram for XoopsModuleHandler:

Collaboration diagram for XoopsModuleHandler:

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

Data Fields
	$_cachedModule_mid = array()
	$_cachedModule_dirname = array()
Data Fields inherited from XoopsObjectHandler
	$db

Member Function Documentation

create()

create

(

$isNew = true

)

Create a new XoopsModule object

Parameters

boolean

$isNew

Flag the new object as "new"

Returns

XoopsModule

delete()

delete

(

XoopsObject

$module

)

Delete a module from the database

Parameters

XoopsObject | XoopsModule

$module

a XoopsModule object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

get()

get

(

$id

)

Load a module from the database

Parameters

int

$id

ID of the module

Returns

object FALSE on fail

Reimplemented from XoopsObjectHandler.

getByDirname()

getByDirname

(

$dirname

)

Load a module by its dirname

Parameters

string

$dirname

Returns

XoopsModule|FALSE on fail

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count some modules

Parameters

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Returns

int

getList()

getList	(	CriteriaElement	$criteria = null,
			$dirname_as_key = false
	)

returns an array of module names

Parameters

CriteriaElement	$criteria
boolean	$dirname_as_key	if true, array keys will be module directory names if false, array keys will be module id

Returns

array

Here is the call graph for this function:

getObjects()

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

Load some modules

Parameters

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement
boolean	$id_as_key	Use the ID as key into the array

Returns

array

Here is the caller graph for this function:

insert()

insert

(

XoopsObject

$module

)

Write a module to the database

Parameters

XoopsObject | XoopsModule

$module

a XoopsModule object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

Field Documentation

$_cachedModule_dirname

$_cachedModule_dirname = array()

$_cachedModule_mid

$_cachedModule_mid = array()

---

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

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