ilComponent Class Reference

Inheritance diagram for ilComponent:

Collaboration diagram for ilComponent:

Public Member Functions
	getVersion ()
	Get Version Number of Component.
	isCore ()
	getName ()
	Get Name.
	__construct ()
	setId ($a_id)
	Set Id.
	getId ()
	Get Id.
	setPluginSlots ($a_pluginslots)
	Set Plugin Slots.
	getPluginSlots ()
	Get Plugin Slots.
	setSubDirectory ($a_subdirectory)
	Set Sub Directory.
	getSubDirectory ()
	Get Sub Directory.
	getPluginSlotName ($a_id)
	Get name of plugin slot.
	getPluginSlotDirectory ($a_id)
	Get directory of plugin slot.
	getPluginSlotLanguagePrefix ($a_id)
	Get language prefix for plugin slot.

Static Public Member Functions
static	getComponentType ()
static	getComponentObject ($a_ctype, $a_cname)
	Get component object.
static	lookupPluginSlots ($a_type, $a_name)
	Lookup all plugin slots of a component.
static	lookupId ($a_type, $a_name)
	Lookup ID of a component.
static	checkVersionNumber ($a_ver)
	Check version number.
static	isVersionGreaterString ($a_ver1, $a_ver2)
static	isVersionGreater ($a_ver1, $a_ver2)
	Check whether version number is greater than another version number.

Detailed Description

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

Constructor & Destructor Documentation

ilComponent::__construct

(

)

Reimplemented in ilModule, ilSurveyQuestionPoolModule, ilTestQuestionPoolModule, ilCOPageService, and ilEventHandlingService.

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

References DB_FETCHMODE_ASSOC, getComponentType(), getName(), lookupPluginSlots(), setId(), and setPluginSlots().

        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT * FROM il_component WHERE type = ".
                        $ilDB->quote($this->getComponentType())." AND name = ".
                        $ilDB->quote($this->getName()));
                        
                $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);

                $this->setId($rec["id"]);
                $this->setPluginSlots(ilComponent::lookupPluginSlots(
                        $this->getComponentType(), $this->getName()));
        }

Here is the call graph for this function:

Member Function Documentation

static ilComponent::checkVersionNumber (   $a_ver )

staticfinal

Check version number.

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

References $lng.

Referenced by isVersionGreaterString().

        {
                global $lng;
                
                $lng->loadLanguageModule("cmps");
                
                $parts = explode(".", $a_ver);
                
                if (count($parts) != 3)
                {
                        return $lng->txt("cmps_version_nr_format_error");
                }
                
                if (!is_numeric($parts[0]) || !is_numeric($parts[1]) || !is_numeric($parts[2]))
                {
                        return $lng->txt("cmps_version_nr_parts_not_numeric");
                }
                
                return $parts;
        }

Here is the caller graph for this function:

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 133 of file class.ilComponent.php.

References IL_COMP_MODULE, and IL_COMP_SERVICE.

Referenced by ilObjComponentSettingsGUI\showPluginSlot().

        {
                global $ilDB;
                
                // this check is done due to security reasons
                $set = $ilDB->query("SELECT * FROM il_component WHERE type = ".
                        $ilDB->quote($a_ctype)." AND name = ".$ilDB->quote($a_cname));
                if ($set->numRows() == 0)
                {
                        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;
        }

Here is the caller graph for this function:

static ilComponent::getComponentType ( )

staticabstract

Reimplemented in ilModule, and ilService.

Referenced by __construct().

Here is the caller graph for this function:

ilComponent::getId ( )

final

Get Id.

Returns

string Id

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

Referenced by getPluginSlotLanguagePrefix().

        {
                return $this->id;
        }

Here is the caller graph for this function:

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:

ilComponent::getPluginSlotDirectory

(

$a_id

)

Get directory of plugin slot.

Parameters

string

$a_id

Plugin Slot ID

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

References getName(), and getPluginSlots().

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

Here is the call graph for this function:

ilComponent::getPluginSlotLanguagePrefix

(

$a_id

)

Get language prefix for plugin slot.

Parameters

string

$a_id

Plugin Slot ID

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

References getId(), and getPluginSlots().

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

Here is the call graph for this function:

ilComponent::getPluginSlotName

(

$a_id

)

Get name of plugin slot.

Parameters

string

$a_id

Plugin Slot ID

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

References getPluginSlots().

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

Here is the call graph for this function:

ilComponent::getPluginSlots ( )

final

Get Plugin Slots.

Returns

array Plugin Slots

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

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

        {
                return $this->pluginslots;
        }

Here is the caller graph for this function:

ilComponent::getSubDirectory

(

)

Get Sub Directory.

Returns

string Sub Directory

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

        {
                return $this->subdirectory;
        }

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 ilSurveyQuestionPoolModule, ilTestQuestionPoolModule, ilCOPageService, and ilEventHandlingService.

ilComponent::isCore ( )

abstract

Reimplemented in ilSurveyQuestionPoolModule, ilTestQuestionPoolModule, ilCOPageService, and ilEventHandlingService.

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

staticfinal

Check whether version number is greater than another version number.

Parameters

$a_ver1	array version number as array as returned by checkVersionNumber()
$a_ver2	array version number as array as returned by checkVersionNumber()

$return boolean true, if $a_ver1 is greater than $a_ver2

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

Referenced by isVersionGreaterString().

        {
                if ($a_ver1[0] > $a_ver2[0])
                {
                        return true;
                }
                else if ($a_ver1[0] < $a_ver2[0])
                {
                        return false;
                }
                else if ($a_ver1[1] > $a_ver2[1])
                {
                        return true;
                }
                else if ($a_ver1[1] < $a_ver2[1])
                {
                        return false;
                }
                else if ($a_ver1[2] > $a_ver2[2])
                {
                        return true;
                }

                return false;
        }

Here is the caller graph for this function:

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

staticfinal

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

References checkVersionNumber(), and isVersionGreater().

Referenced by ilPluginAdmin\getPluginData().

        {
                $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_arr1, $a_arr2);
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

static

Lookup ID of a component.

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

References DB_FETCHMODE_ASSOC.

Referenced by ilPluginSlot\getPrefix(), and lookupPluginSlots().

        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT * FROM il_component WHERE type = ".
                        $ilDB->quote($a_type)." AND name = ".$ilDB->quote($a_name));
                $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);
                
                return $rec["id"];
        }

Here is the caller graph for this function:

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

static

Lookup all plugin slots of a component.

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

References DB_FETCHMODE_ASSOC, and lookupId().

Referenced by __construct(), and ilComponentsTableGUI\fillRow().

        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT * FROM il_pluginslot WHERE component = ".
                        $ilDB->quote($a_type."/".$a_name));
                $ps = array();
//echo "<br>".$a_type."/".$a_name;
                while($rec = $set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilComponent::setId (   $a_id )

final

Set Id.

Parameters

string

$a_id

Id

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

Referenced by __construct().

        {
                $this->id = $a_id;
        }

Here is the caller graph for this function:

ilComponent::setPluginSlots (   $a_pluginslots )

final

Set Plugin Slots.

Parameters

array

$a_pluginslots

Plugin Slots

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

Referenced by __construct().

        {
                $this->pluginslots = $a_pluginslots;
        }

Here is the caller graph for this function:

ilComponent::setSubDirectory

(

$a_subdirectory

)

Set Sub Directory.

Parameters

string

$a_subdirectory

Sub Directory

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

        {
                $this->subdirectory = $a_subdirectory;
        }

---

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

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