Inheritance diagram for ilComponent:

Collaboration diagram for ilComponent:

Public Member Functions
	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	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 @global type $ilDB More...

static	getAll ()
	Get all. More...

Protected Attributes
	$global_cache

Detailed Description

Definition at line 23 of file class.ilComponent.php.

Constructor & Destructor Documentation

◆ __construct()

ilComponent::__construct ( )

Reimplemented in ilCloudModule, ilTestModule, ilTestQuestionPoolModule, ilAuthShibbolethService, ilModule, ilCOPageService, ilEventHandlingService, ilPreviewService, ilRepositoryService, and ilUIComponentService.

Definition at line 62 of file class.ilComponent.php.

    {
        $this->global_cache = ilCachedComponentData::getInstance();
 
        $this->setId($this->global_cache->lookCompId($this->getComponentType(), $this->getName()));
        $this->setPluginSlots(ilComponent::lookupPluginSlots(
            $this->getComponentType(),
            $this->getName()
        ));
    }

References getComponentType(), ilCachedComponentData\getInstance(), getName(), lookupPluginSlots(), setId(), and setPluginSlots().

Here is the call graph for this function:

Member Function Documentation

◆ checkVersionNumber()

static ilComponent::checkVersionNumber ( $a_ver )

staticfinal

Check version number.

Definition at line 257 of file class.ilComponent.php.

    {
        $parts = explode(".", $a_ver);
 
        if (count($parts) < 2 || count($parts) > 3) {
            return "Version number does not conform to format a.b or a.b.c";
        }
        
        if (!is_numeric($parts[0]) || !is_numeric($parts[1])) {
            return "Not all version number parts a.b or a.b.c are numeric.";
        }
 
        if (isset($parts[2]) && !is_numeric($parts[2])) {
            return "Not all version number parts a.b.c are numeric.";    
        }
 
        return $parts;
    }

Referenced by isVersionGreaterString().

Here is the caller graph for this function:

◆ getAll()

static ilComponent::getAll ( )

static

Get all.

Returns: array

Definition at line 322 of file class.ilComponent.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT * FROM il_component");
        $comps = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            $comps[$rec["id"]] = $rec;
        }
        return $comps;
    }

References $DIC, and $ilDB.

Referenced by ilObjAdvancedEditingGUI\initGeneralPageSettingsForm().

Here is the caller graph for this function:

◆ getComponentInfo()

static ilComponent::getComponentInfo	(	$a_type,
		$a_name
	)

static

Parameters

$a_type
$a_name

Returns: mixed

Definition at line 247 of file class.ilComponent.php.

    {
        $global_cache = ilCachedComponentData::getInstance();
 
        return $global_cache->lookupCompInfo($a_type, $a_name);
    }

References $global_cache, and ilCachedComponentData\getInstance().

Referenced by ilCtrl\callBaseClass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentObject()

static ilComponent::getComponentObject	(	$a_ctype,
		$a_cname
	)

staticfinal

Get component object.

Parameters

string	$a_ctype	IL_COMP_MODULE \| IL_COMP_SERVICE
string	$a_cname	component name

Definition at line 119 of file class.ilComponent.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->queryF(
            "SELECT * FROM il_component WHERE type = %s " .
            " AND name = %s",
            array("text", "text"),
            array($a_ctype, $a_cname)
        );
        if (!$ilDB->fetchAssoc($set)) {
            return null;
        }
        
        switch ($a_ctype) {
            case IL_COMP_MODULE:
                if (is_file("./Modules/" . $a_cname . "/classes/class.il" . $a_cname . "Module.php")) {
                    include_once("./Modules/" . $a_cname . "/classes/class.il" . $a_cname . "Module.php");
                    $class = "il" . $a_cname . "Module";
                    $comp = new $class();
                    return $comp;
                }
                break;
                
            case IL_COMP_SERVICE:
                if (is_file("./Services/" . $a_cname . "/classes/class.il" . $a_cname . "Service.php")) {
                    include_once("./Services/" . $a_cname . "/classes/class.il" . $a_cname . "Service.php");
                    $class = "il" . $a_cname . "Service";
                    $comp = new $class();
                    return $comp;
                }
                break;
        }
        
        return null;
    }

References $DIC, $ilDB, IL_COMP_MODULE, and IL_COMP_SERVICE.

Referenced by ilObjComponentSettingsGUI\showPluginSlotInfo().

Here is the caller graph for this function:

◆ getComponentType()

ilComponent::getComponentType ( )

abstract

Returns: string

Reimplemented in ilModule, and ilService.

Referenced by __construct(), and getPluginSlotDirectory().

Here is the caller graph for this function:

◆ getId()

ilComponent::getId ( )

final

Get Id.

Returns: string Id

Definition at line 88 of file class.ilComponent.php.

    {
        return $this->id;
    }

Referenced by getPluginSlotLanguagePrefix().

Here is the caller graph for this function:

◆ getName()

ilComponent::getName ( )

abstract

Get Name.

Returns: string Name

Reimplemented in ilModule, and ilService.

Referenced by __construct(), and getPluginSlotDirectory().

Here is the caller graph for this function:

◆ getPluginSlotDirectory()

ilComponent::getPluginSlotDirectory ( $a_id )

Get directory of plugin slot.

Parameters

string $a_id Plugin Slot ID

Definition at line 212 of file class.ilComponent.php.

    {
        $slots = $this->getPluginSlots();
        
        return "Customizing/global/plugins/" . $this->getComponentType() . "/" .
            $this->getName() . "/" . $slots[$a_id]["name"];
    }

References getComponentType(), getName(), and getPluginSlots().

Here is the call graph for this function:

◆ getPluginSlotLanguagePrefix()

ilComponent::getPluginSlotLanguagePrefix ( $a_id )

Get language prefix for plugin slot.

Parameters

string $a_id Plugin Slot ID

Definition at line 225 of file class.ilComponent.php.

    {
        $slots = $this->getPluginSlots();
        return $this->getId() . "_" . $slots[$a_id]["id"] . "_";
    }

References getId(), and getPluginSlots().

Here is the call graph for this function:

◆ getPluginSlotName()

ilComponent::getPluginSlotName ( $a_id )

Get name of plugin slot.

Parameters

string $a_id Plugin Slot ID

Definition at line 200 of file class.ilComponent.php.

    {
        $slots = $this->getPluginSlots();
        
        return $slots[$a_id]["name"];
    }

References getPluginSlots().

Here is the call graph for this function:

◆ getPluginSlots()

ilComponent::getPluginSlots ( )

final

Get Plugin Slots.

Returns: array Plugin Slots

Definition at line 108 of file class.ilComponent.php.

    {
        return $this->pluginslots;
    }

Referenced by getPluginSlotDirectory(), getPluginSlotLanguagePrefix(), and getPluginSlotName().

Here is the caller graph for this function:

◆ getSubDirectory()

ilComponent::getSubDirectory ( )

Get Sub Directory.

Returns: string Sub Directory

Definition at line 172 of file class.ilComponent.php.

    {
        return $this->subdirectory;
    }

◆ getVersion()

ilComponent::getVersion ( )

abstract

Get Version Number of Component.

The number should be changed if anything in the code is changed. Otherwise ILIAS will not be able to recognize any change in the module.

The format must be: <major number>.<minor number>.<bugfix number> <bugfix number> should be increased for bugfixes <minor number> should be increased for behavioural changes (and new functionalities) <major number> should be increased for major revisions

The number should be returned directly as string, e.g. return "1.0.2";

Returns: string version number

Reimplemented in ilCloudModule, ilSurveyQuestionPoolModule, ilTestModule, ilTestQuestionPoolModule, ilAdvancedMetaDataService, ilAuthenticationService, ilAuthShibbolethService, ilCalendarService, ilCOPageService, ilCronService, ilDashboardService, ilEventHandlingService, ilLDAPService, ilPDFGenerationService, ilPreviewService, ilRepositoryService, ilUIComponentService, and ilUserService.

◆ isCore()

ilComponent::isCore ( )

abstract

Reimplemented in ilCloudModule, ilSurveyQuestionPoolModule, ilTestModule, ilTestQuestionPoolModule, ilAdvancedMetaDataService, ilAuthenticationService, ilAuthShibbolethService, ilCalendarService, ilCOPageService, ilCronService, ilDashboardService, ilEventHandlingService, ilLDAPService, ilPDFGenerationService, ilPreviewService, ilRepositoryService, ilUIComponentService, and ilUserService.

◆ isVersionGreater()

static ilComponent::isVersionGreater	(	string	$version1,
		string	$version2
	)

staticfinal

Parameters

string	$version1
string	$version2

Returns: bool

Definition at line 293 of file class.ilComponent.php.

                                                                                      : bool
    {
        return version_compare($version1, $version2, '>');
    }

Referenced by isVersionGreaterString().

Here is the caller graph for this function:

◆ isVersionGreaterString()

static ilComponent::isVersionGreaterString	(	$a_ver1,
		$a_ver2
	)

staticfinal

Definition at line 276 of file class.ilComponent.php.

    {
        $a_arr1 = ilComponent::checkVersionNumber($a_ver1);
        $a_arr2 = ilComponent::checkVersionNumber($a_ver2);
 
        if (is_array($a_arr1) && is_array($a_arr2)) {
            return ilComponent::isVersionGreater($a_ver1, $a_ver2);
        } else {
            return false;
        }
    }

References checkVersionNumber(), and isVersionGreater().

Referenced by ilPlugin\hasConfigureClass(), ilPluginAdmin\pluginSupportCurrentILIAS(), and ilPluginAdmin\updateRequired().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupComponentName()

static ilComponent::lookupComponentName ( $a_component_id )

static

lookup component name @global type $ilDB

Parameters

type $a_component_id

Returns: type

Definition at line 304 of file class.ilComponent.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $query = 'SELECT name from il_component ' .
                'WHERE id = ' . $ilDB->quote($a_component_id, 'text');
        
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->name;
        }
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilLogComponentTableGUI\parse().

Here is the caller graph for this function:

◆ lookupId()

static ilComponent::lookupId	(	$a_type,
		$a_name
	)

static

Lookup ID of a component.

Definition at line 234 of file class.ilComponent.php.

    {
        $global_cache = ilCachedComponentData::getInstance();
 
        return $global_cache->lookCompId($a_type, $a_name);
    }

References $global_cache, and ilCachedComponentData\getInstance().

Referenced by ilPlugin\_getImagePath(), ilPluginSlot\getPrefix(), ilPlugin\getStyleSheetLocation(), and lookupPluginSlots().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupPluginSlots()

static ilComponent::lookupPluginSlots	(	$a_type,
		$a_name
	)

static

Lookup all plugin slots of a component.

Definition at line 180 of file class.ilComponent.php.

    {
        $cached_component = ilCachedComponentData::getInstance();
        $recs = $cached_component->lookupPluginSlotByComponent($a_type . "/" . $a_name);
 
        $ps = array();
        foreach ($recs as $rec) {
            $rec["dir"] = "Customizing/global/plugins/" . $a_type . "/" . $a_name . "/" . $rec["name"];
            $rec["dir_pres"] = "Customizing/global/plugins/<br />" . $a_type . "/" . $a_name . "/" . $rec["name"];
            $rec["lang_prefix"] = ilComponent::lookupId($a_type, $a_name) . "_" . $rec["id"] . "_";
            $ps[$rec["id"]] = $rec;
        }
        return $ps;
    }

References ilCachedComponentData\getInstance(), and lookupId().

Referenced by __construct(), ilPluginsOverviewTableGUI\addPluginData(), ilComponentsTableGUI\getComponents(), and ilPluginAdmin\getComponentSlotsByType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilComponent::setId ( $a_id )

final

Set Id.

Parameters

string $a_id Id

Definition at line 78 of file class.ilComponent.php.

    {
        $this->id = $a_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setPluginSlots()

ilComponent::setPluginSlots ( $a_pluginslots )

final

Set Plugin Slots.

Parameters

array $a_pluginslots Plugin Slots

Definition at line 98 of file class.ilComponent.php.

    {
        $this->pluginslots = $a_pluginslots;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setSubDirectory()

ilComponent::setSubDirectory ( $a_subdirectory )

Set Sub Directory.

Parameters

string $a_subdirectory Sub Directory

Definition at line 162 of file class.ilComponent.php.

    {
        $this->subdirectory = $a_subdirectory;
    }

Field Documentation

◆ $global_cache

ilComponent::$global_cache

protected

Definition at line 60 of file class.ilComponent.php.

Referenced by getComponentInfo(), and lookupId().

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

Services/Component/classes/class.ilComponent.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkVersionNumber()

◆ getAll()

◆ getComponentInfo()

◆ getComponentObject()

◆ getComponentType()

◆ getId()

◆ getName()

◆ getPluginSlotDirectory()

◆ getPluginSlotLanguagePrefix()

◆ getPluginSlotName()

◆ getPluginSlots()

◆ getSubDirectory()

◆ getVersion()

◆ isCore()

◆ isVersionGreater()

◆ isVersionGreaterString()

◆ lookupComponentName()

◆ lookupId()

◆ lookupPluginSlots()

◆ setId()

◆ setPluginSlots()

◆ setSubDirectory()

Field Documentation

◆ $global_cache