XoopsModuleHandler Class Reference

Inheritance diagram for XoopsModuleHandler:

Public Member Functions
	__construct (Connection $db=null)
	deleteModule (XoopsModule &$module)
	getByDirname ($dirname)
	getById ($id=null)
	getNameList (CriteriaElement $criteria=null, $dirname_as_key=false)
	getObjectsArray (CriteriaElement $criteria=null, $id_as_key=false)
	insertModule (XoopsModule &$module)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__call ($name, $args)
	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')
	create ($isNew=true)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria, $force=true, $asObject=false)
	deleteByLink (CriteriaElement $criteria=null)
	get ($id=null, $fields=null)
	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCount (CriteriaElement $criteria=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	getIds (CriteriaElement $criteria=null)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
	insert (XoopsObject $object, $force=true)
	loadHandler ($name, $args=null)
	setHandler ($handler=null, $args=null, $path=null)
	synchronization ($table_link= '', $field_link= '', $field_object= '')
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria, $force=false)
	updateByLink ($data, CriteriaElement $criteria=null)
Public Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	create ()
	delete (XoopsObject $object, $force=true)
	get ($int_id)
	insert (XoopsObject $object, $force=true)

Private Attributes
	$_cachedModule_dirname = array()
	$_cachedModule_mid = array()

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$className
	$field_link
	$field_object
	$identifierName
	$keyName
	$keyName_link
	$table
	$table_link
Public Attributes inherited from Xoops\Core\Kernel\XoopsObjectHandler
	$db2
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__construct (Connection $db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
Protected Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	__construct (Connection $db=null)
Protected Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$handler

Detailed Description

Definition at line 428 of file module.php.

Constructor & Destructor Documentation

XoopsModuleHandler::__construct

(

Connection

$db = null

)

Constructor

Parameters

Connection | null

$db

Connection

Definition at line 451 of file module.php.

Member Function Documentation

XoopsModuleHandler::deleteModule

(

XoopsModule &

$module

)

Delete a module from the database

Parameters

XoopsModule

&$module

Returns

bool

Definition at line 540 of file module.php.

References $count, $dirname, $i, $mid, $result, Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModuleHandler::getByDirname

(

$dirname

)

Load a module by its dirname

Parameters

string

$dirname

module directory name

Returns

XoopsModule|bool FALSE on fail

Definition at line 488 of file module.php.

References $criteria, $dirname, $module, $modules, and getObjectsArray().

Here is the call graph for this function:

XoopsModuleHandler::getById

(

$id = null

)

Load a module from the database

Parameters

int

$id

ID of the module

Returns

XoopsModule|bool on fail

Definition at line 462 of file module.php.

References $id, and $module.

XoopsModuleHandler::getNameList	(	CriteriaElement	$criteria = null,
			$dirname_as_key = false
	)

returns an array of module names

Parameters

CriteriaElement | null	$criteria	criteria
boolean	$dirname_as_key	true = array key is module directory false = array key is module id

Returns

array

Definition at line 674 of file module.php.

References $criteria, $i, $modules, and getObjectsArray().

Here is the call graph for this function:

XoopsModuleHandler::getObjectsArray	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

Load some modules

Parameters

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

Returns

array

Definition at line 635 of file module.php.

References $criteria, $module, and $result.

Referenced by getByDirname(), and getNameList().

Here is the caller graph for this function:

XoopsModuleHandler::insertModule

(

XoopsModule &

$module

)

Write a module to the database

Parameters

XoopsModule

$module

reference to a XoopsModule

Returns

bool

Definition at line 516 of file module.php.

References $dirname, $mid, and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

Member Data Documentation

XoopsModuleHandler::$_cachedModule_dirname = array()

private

Definition at line 444 of file module.php.

XoopsModuleHandler::$_cachedModule_mid = array()

private

Definition at line 436 of file module.php.

---

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

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