Class icms_module_Handler

Module handler class.

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

icms_module_Handler

Package: Module
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at module/Handler.php

Methods summary
`public object &`	# `create( boolean $isNew = TRUE )` Create a new `icms_module_Object` object Create a new `icms_module_Object` object Parameters `$isNew` Flag the new object as "new" Returns object `icms_module_Object`
`public object &`	# `get( integer $id, boolean $loadConfig = FALSE )` Load a module from the database Load a module from the database Parameters `$id` ID of the module `$loadConfig` set to TRUE in case you want to load the module config in addition Returns object `icms_module_Object` FALSE on fail
`public object`	# `getByDirname( string $dirname, boolean $loadConfig = FALSE )` Load a module by its dirname Load a module by its dirname Parameters `$dirname` `$loadConfig` set to TRUE in case you want to load the module config in addition Returns object `icms_module_Object` FALSE on fail
`public boolean`	# `insert( object & $module )` Inserts a module into the database Inserts a module into the database Parameters `$module` $module reference to a `icms_module_Object` Returns boolean
`public boolean`	# `delete( object & $module )` Delete a module from the database Delete a module from the database Parameters `$module` $module `icms_module_Object` Returns boolean
`public array`	# `getObjects( object $criteria = NULL, boolean $id_as_key = FALSE )` Retrieve list of installed modules from the database Retrieve list of installed modules from the database Parameters `$criteria` `icms_db_criteria_Element` `$id_as_key` Use the ID as key into the array Returns array Array of objects - installed module
`public integer`	# `getCount( object $criteria = NULL )` Count some modules Count some modules Parameters `$criteria` `icms_db_criteria_Element` Returns integer
`public array`	# `getList( boolean $criteria = NULL, boolean $dirname_as_key = FALSE )` returns an array of installed module names returns an array of installed 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
`public static array`	# `getAvailable( )` Returns an array of all available modules, based on folders in the modules directory Returns an array of all available modules, based on folders in the modules directory The getList method cannot be used for this, because uninstalled modules are not listed in the database Returns array List of folder names in the modules directory Since 1.3
`public static array`	# `getActive( )` Get a list of active modules, with the folder name as the key Get a list of active modules, with the folder name as the key This method is necessary to be able to use a static method Returns array List of active modules Since 1.3
`public static`	# `service( boolean $inAdmin = FALSE )` Finds and initializes the current module. Finds and initializes the current module. Parameters `$inAdmin` Whether we are on the admin side or not
`public static boolean`	# `checkModuleAccess( icms_module_Object $module, boolean $inAdmin = FALSE )` Checks if the current user can access the specified module Checks if the current user can access the specified module Parameters `$module` `$inAdmin` Returns boolean

Methods inherited from icms_core_ObjectHandler
`__construct()`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_module_Handler

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Since

Returns

Since

Parameters

Parameters

Returns