XoopsModuleHandler Class Reference

Inheritance diagram for XoopsModuleHandler:

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

Public Attributes
	$_cachedModule_dirname = array()
	$_cachedModule_mid = array()
Public Attributes inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 505 of file module.php.

Member Function Documentation

& XoopsModuleHandler::create

(

$isNew = true

)

Create a new XoopsModule object

Parameters

boolean

$isNew

Flag the new object as "new"

Returns

object

Definition at line 529 of file module.php.

References $module.

XoopsModuleHandler::delete

(

&

$module

)

Delete a module from the database

Parameters

object

$ &$module

Returns

bool

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 659 of file module.php.

References $i, $module, $result, and $sql.

& XoopsModuleHandler::get

(

$id

)

Load a module from the database

Parameters

int

$id

ID of the module

Returns

object FALSE on fail

Definition at line 544 of file module.php.

References $_cachedModule_dirname, $_cachedModule_mid, $module, $result, and $sql.

& XoopsModuleHandler::getByDirname

(

$dirname

)

Load a module by its dirname

Parameters

string

$dirname

Returns

object FALSE on fail

Definition at line 578 of file module.php.

References $_cachedModule_dirname, $_cachedModule_mid, $dirname, $module, $result, and $sql.

XoopsModuleHandler::getCount

(

$criteria = null

)

Count some modules

Parameters

object

$criteria

CriteriaElement

Returns

int

Definition at line 756 of file module.php.

References $criteria, $result, and $sql.

XoopsModuleHandler::getList	(		$criteria = null,
			$dirname_as_key = false
	)

returns an array of module names

Parameters

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

Returns

array

Definition at line 777 of file module.php.

References $criteria, $i, $ret, and getObjects().

Here is the call graph for this function:

XoopsModuleHandler::getObjects	(		$criteria = null,
			$id_as_key = false
	)

Load some modules

Parameters

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

Returns

array

Definition at line 722 of file module.php.

References $criteria, $limit, $module, $result, $ret, $sql, and $start.

Referenced by getList().

Here is the caller graph for this function:

XoopsModuleHandler::insert

(

&

$module

)

Write a module to the database

Parameters

object

$ &$module reference to a XoopsModule

Returns

bool

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 613 of file module.php.

References $dirname, $mid, $module, $result, and $sql.

Member Data Documentation

XoopsModuleHandler::$_cachedModule_dirname = array()

Definition at line 521 of file module.php.

Referenced by get(), and getByDirname().

XoopsModuleHandler::$_cachedModule_mid = array()

Definition at line 513 of file module.php.

Referenced by get(), and getByDirname().

---

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

• L:/0xoops/xoops-2.5.6/htdocs/kernel/module.php