Docs For Class ModulService

Description

This should be used to handle any kind of BIGACE Module.

Receive an Enumeration of all available Modules or manipulate the existing ones.

version: $Id: ModulService.php,v 1.8 2006/11/26 22:04:16 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Method Summary

ModulService ModulService ()

void activateModul ( $modulID, [ $cid = null])

void deactivateModul ( $modulID, [ $cid = null])

ModulEnumeration getModulEnumeration ()

array getModulProperties ( $menu, [ $modul = null], [ $props = array()])

Methods

Constructor ModulService (line 55)

ModulService ModulService ()

activateModul (line 80)

Activates the Modul for the given Consumer.

void activateModul ( $modulID, [ $cid = null])

$modulID
$cid

deactivateModul (line 94)

Deactivates the Modul for the given Consumer.

void deactivateModul ( $modulID, [ $cid = null])

$modulID
$cid

getModulEnumeration (line 61)

return: a ModuleEnumeration above all existing Modules

ModulEnumeration getModulEnumeration ()

getModulProperties (line 149)

Get an Array with all configured Properties (which can be set by the ModulAdmin Application), mentioned in the Moduls Ini File.

If you pass null as Modul, the Menus configured Modul will be used!

You can set default values by passing the $props Array with correct keys. If a value does not exist, and is also not passed in the fallback Array $props, it will at least be looked-up in the Ini File. When the value can still not be found, it is defined to be null!

return: the Modul Configuration with all intialized keys

array getModulProperties ( $menu, [ $modul = null], [ $props = array()])

$menu
$modul
$props