ilModule Class Reference

ILIAS Module. More...

Inheritance diagram for ilModule:

Collaboration diagram for ilModule:

Public Member Functions
	__construct ()
	Constructor: read information on component. More...
	getComponentType ()
	getName ()
	Get Name. More...
Public Member Functions inherited from ilComponent
	getVersion ()
	Get Version Number of Component. More...
	isCore ()
	getComponentType ()
	getName ()
	Get Name. More...
	__construct ()
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setPluginSlots ($a_pluginslots)
	Set Plugin Slots. More...
	getPluginSlots ()
	Get Plugin Slots. More...
	setSubDirectory ($a_subdirectory)
	Set Sub Directory. More...
	getSubDirectory ()
	Get Sub Directory. More...
	getPluginSlotName ($a_id)
	Get name of plugin slot. More...
	getPluginSlotDirectory ($a_id)
	Get directory of plugin slot. More...
	getPluginSlotLanguagePrefix ($a_id)
	Get language prefix for plugin slot. More...

Static Public Member Functions
static	getAvailableCoreModules ()
	Get all available core modules. More...
Static Public Member Functions inherited from ilComponent
static	getComponentObject ($a_ctype, $a_cname)
	Get component object. More...
static	lookupPluginSlots ($a_type, $a_name)
	Lookup all plugin slots of a component. More...
static	lookupId ($a_type, $a_name)
	Lookup ID of a component. More...
static	getComponentInfo ($a_type, $a_name)
static	checkVersionNumber ($a_ver)
	Check version number. More...
static	isVersionGreaterString ($a_ver1, $a_ver2)
static	isVersionGreater (string $version1, string $version2)
static	lookupComponentName ($a_component_id)
	lookup component name type $ilDB More...
static	getAll ()
	Get all. More...

Additional Inherited Members
Protected Attributes inherited from ilComponent
	$global_cache

Detailed Description

ILIAS Module.

Modules handle resource object types (one or more), that can be added to the repository, e.g. forums, glossaries, ...

Modules are ILIAS components, like services. Services can also handle resource object types, but only administrative ones.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 41 of file class.ilModule.php.

Constructor & Destructor Documentation

__construct()

ilModule::__construct

(

)

Constructor: read information on component.

Definition at line 47 of file class.ilModule.php.

    {
        parent::__construct();
    }

Member Function Documentation

getAvailableCoreModules()

static ilModule::getAvailableCoreModules ( )

staticfinal

Get all available core modules.

Core modules are located in the main ILIAS/Modules folder and provide a module.xml file that includes information about the module.

Returns

array array of module names (strings)

Definition at line 80 of file class.ilModule.php.

Referenced by ilObjRepositorySettings\getAllObjTypes(), ilComponentsTableGUI\getComponents(), ilModulesTableGUI\getComponents(), ilPluginsOverviewTableGUI\getModulesCoreItems(), ilDBUpdate\loadXMLInfo(), and ilSetupGUI\reloadControlStructure().

    {
        $modules_dir = ILIAS_ABSOLUTE_PATH . "/Modules";

        if (!@is_dir($modules_dir)) {
            return array();
        }

        // read current directory
        $dir = opendir($modules_dir);

        $modules = array();
        while ($file = readdir($dir)) {
            if ($file != "." and
                $file != "..") {
                // directories
                if (@is_dir($modules_dir . "/" . $file)) {
                    if (@is_file($modules_dir . "/" . $file . "/module.xml")) {
                        $modules[] = array("subdir" => $file);
                    }
                }
            }
        }
        return $modules;
    }

Here is the caller graph for this function:

getComponentType()

ilModule::getComponentType ( )

final

Definition at line 55 of file class.ilModule.php.

References IL_COMP_MODULE.

                                             : string
    {
        return IL_COMP_MODULE;
    }

getName()

ilModule::getName ( )

final

Get Name.

Returns

string Name

Definition at line 65 of file class.ilModule.php.

    {
        // class is always il<ModuleName>Module
        $class = get_class($this);
        
        return substr($class, 2, strlen($class) - 8);
    }

---

The documentation for this class was generated from the following file:

• Services/Component/classes/class.ilModule.php