Class XoopsModuleHandler

XOOPS module handler class.

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

XoopsModuleHandler

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project - www.xoops.org
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/module.php

Methods summary
`public XoopsModule`	# `create( boolean $isNew = true )` Create a new `XoopsModule` object Create a new `XoopsModule` object Parameters `$isNew` Flag the new object as "new" Returns `XoopsModule` Overrides `XoopsObjectHandler::create()`
`public object`	# `get( integer $id )` Load a module from the database Load a module from the database Parameters `$id` ID of the module Returns object FALSE on fail Overrides `XoopsObjectHandler::get()`
`public XoopsModule\|false`	# `getByDirname( string $dirname )` Load a module by its dirname Load a module by its dirname Parameters `$dirname` Returns `XoopsModule`\|false on fail
`public boolean`	# `insert( XoopsObject $module )` Write a module to the database Write a module to the database Parameters `$module` a XoopsModule object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $module )` Delete a module from the database Delete a module from the database Parameters `$module` a XoopsModule object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` Load some modules Load some modules Parameters `$criteria` `CriteriaElement` `$id_as_key` Use the ID as key into the array Returns array
`public integer`	# `getCount( CriteriaElement $criteria = null )` Count some modules Count some modules Parameters `$criteria` `CriteriaElement` Returns integer
`public array`	# `getList( CriteriaElement $criteria = null, boolean $dirname_as_key = false )` returns an array of module names returns an array of module names Parameters `$criteria` `$dirname_as_key` if true, array keys will be module directory names if false, array keys will be module id Returns array

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties summary
`public array`	`$_cachedModule_mid` holds an array of cached module references, indexed by module id holds an array of cached module references, indexed by module id	# `array()`
`public array`	`$_cachedModule_dirname` holds an array of cached module references, indexed by module dirname holds an array of cached module references, indexed by module dirname	# `array()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsModuleHandler

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns