XoopsModuleHandler Class Reference

Inheritance diagram for XoopsModuleHandler:

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

Data Fields
	$_tmp
	$_cachedModule_mid = []
	$_cachedModule_dirname = []
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 333 of file module.php.

Member Function Documentation

create()

& create

(

$isNew = true

)

Create a new XoopsModule object

Parameters

bool

$isNew

Flag the new object as "new"

Returns

object

Definition at line 359 of file module.php.

delete()

delete

(

&

$module

)

Delete a module from the database

Parameters

object

&$module

Returns

bool

Reimplemented from XoopsObjectHandler.

Definition at line 509 of file module.php.

get()

& get

(

$id

)

Load a module from the database

Parameters

int

$id

ID of the module

Returns

object FALSE on fail

Reimplemented from XoopsObjectHandler.

Definition at line 375 of file module.php.

getByDirname()

& getByDirname

(

$dirname

)

Load a module by its dirname

Parameters

string

$dirname

Returns

object FALSE on fail

Definition at line 407 of file module.php.

getCount()

getCount

(

$criteria = null

)

Count some modules

Parameters

object

$criteria

CriteriaElement

Returns

int

Definition at line 623 of file module.php.

getList()

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

returns an array of module names

Parameters

bool	$criteria
bool	$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 645 of file module.php.

getObjects()

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

Load some modules

Parameters

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

Returns

array

Definition at line 575 of file module.php.

insert()

insert

(

&

$module

)

Write a module to the database

Remarks

This method unsets cache of the module, and re-contruct the cache. But this mechanism may break the reference to the previous cache.... Maybe that's no problem. But, we should notice it.

Parameters

object

&$module

reference to a XoopsModule

Returns

bool

Reimplemented from XoopsObjectHandler.

Definition at line 442 of file module.php.

Field Documentation

$_cachedModule_dirname

$_cachedModule_dirname = []

Definition at line 351 of file module.php.

$_cachedModule_mid

$_cachedModule_mid = []

Definition at line 343 of file module.php.

$_tmp

$_tmp

Definition at line 335 of file module.php.

---

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

• html/kernel/module.php