Class: ModulService

Source Location: /CORE/system/classes/modul/ModulService.php

Class ModulService

Class Overview

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

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

Located in /CORE/system/classes/modul/ModulService.php [line 56]



		
				Author(s):
		
  • Kevin Papst
Information Tags:
Version:  $Id: ModulService.php,v 1.12 2008/11/27 22:51:43 kpapst Exp $
Copyright:  Copyright (C) Kevin Papst
License:  GNU Public License

Methods

[ Top ]
Method Summary
ModulService   ModulService()  
void   activateModul()   Activates the Modul for the given Consumer.
void   createModul()  
void   deactivateModul()   Deactivates the Modul for the given Consumer.
ModulEnumeration   getModulEnumeration()  
array   getModulProperties()   Get an Array with all configured Properties (which can be set by the ModulAdmin Application), mentioned in the Moduls Ini File.

[ Top ]
Methods
Constructor ModulService  [line 59]

  ModulService ModulService( )



[ Top ]
activateModul  [line 84]

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

Activates the Modul for the given Consumer.

Parameters:
   $modulID: 
   $cid: 


[ Top ]
createModul  [line 109]

  void createModul( $name  )

Parameters:
   $name: 


[ Top ]
deactivateModul  [line 98]

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

Deactivates the Modul for the given Consumer.

Parameters:
   $modulID: 
   $cid: 


[ Top ]
getModulEnumeration  [line 65]

  ModulEnumeration getModulEnumeration( )


API Tags:
Return:  a ModuleEnumeration above all existing Modules


[ Top ]
getModulProperties  [line 180]

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

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!

Parameters:
   $menu: 
   $modul: 
   $props: 

API Tags:
Return:  the Modul Configuration with all intialized keys


[ Top ]