Class XoopsModuleHandler

XOOPS module handler class.

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

Xoops\Core\Kernel\XoopsObjectHandler

Xoops\Core\Kernel\XoopsPersistableObjectHandler

Xoops\Core\Kernel\Handlers\XoopsModuleHandler

Direct known subclasses

XoopsModuleHandler

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\XoopsModuleHandler
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsModuleHandler.php

Methods summary
`public`	# `__construct( Xoops\Core\Database\Connection $db = null )` Constructor Constructor Parameters `$db` database Overrides `Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()`
`public Xoops\Core\Kernel\Handlers\XoopsModule\|boolean`	# `getById( integer $id = null )` Load a module from the database Load a module from the database Parameters `$id` ID of the module Returns `Xoops\Core\Kernel\Handlers\XoopsModule`\|boolean on fail
`public Xoops\Core\Kernel\Handlers\XoopsModule\|boolean`	# `getByDirname( string $dirname )` Load a module by its dirname Load a module by its dirname Parameters `$dirname` module directory name Returns `Xoops\Core\Kernel\Handlers\XoopsModule`\|boolean FALSE on fail
`public boolean`	# `insertModule( Xoops\Core\Kernel\Handlers\XoopsModule $module )` Write a module to the database Write a module to the database Parameters `$module` module to insert Returns boolean
`public boolean`	# `deleteModule( Xoops\Core\Kernel\Handlers\XoopsModule $module )` Delete a module from the database Delete a module from the database Parameters `$module` module to delete Returns boolean
`public array`	# `getObjectsArray( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` Load some modules Load some modules Parameters `$criteria` criteria to match `$id_as_key` Use the ID as key into the array Returns array
`public array`	# `getNameList( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $dirname_as_key = false )` returns an array of module names returns an array of module names Parameters `$criteria` criteria `$dirname_as_key` true = array key is module directory false = array key is module id Returns array

Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()`

Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link`

Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
`$db2`

Namespaces

Classes

Class XoopsModuleHandler

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns