ilComponentInfo Class Reference

Simple value class for basic information about a component. More...

Collaboration diagram for ilComponentInfo:

Public Member Functions
	__construct (string $id, string $type, string $name, array &$pluginslots)
	getId ()
	getType ()
	getName ()
	getQualifiedName ()
	getPluginSlots ()
	hasPluginSlotId (string $id)
	getPluginSlotById (string $id)
	hasPluginSlotName (string $name)
	getPluginSlotByName (string $name)

Data Fields
const	TYPES = ["Modules", "Services"]
const	TYPE_MODULES = "Modules"
const	TYPE_SERVICES = "Services"

Protected Attributes
string	$id
string	$type
string	$name
array	$pluginslots

Detailed Description

Simple value class for basic information about a component.

Definition at line 24 of file class.ilComponentInfo.php.

Constructor & Destructor Documentation

__construct()

ilComponentInfo::__construct	(	string	$id,
		string	$type,
		string	$name,
		array &	$pluginslots
	)

Definition at line 39 of file class.ilComponentInfo.php.

      {
        if (!in_array($type, self::TYPES)) {
            throw new \InvalidArgumentException(
                "Invalid component type: $type"
            );
        }
 
        $this->id = $id;
        $this->type = $type;
        $this->name = $name;
        $this->pluginslots = &$pluginslots;
    }

References $id, $name, $pluginslots, and $type.

Member Function Documentation

getId()

ilComponentInfo::getId

(

)

Definition at line 57 of file class.ilComponentInfo.php.

                           : string
    {
        return $this->id;
    }

References $id.

getName()

ilComponentInfo::getName

(

)

Definition at line 67 of file class.ilComponentInfo.php.

                             : string
    {
        return $this->name;
    }

References $name.

getPluginSlotById()

ilComponentInfo::getPluginSlotById

(

string

$id

)

Exceptions

InvalidArgumentException if there is no such slot

Definition at line 100 of file class.ilComponentInfo.php.

                                                 : \ilPluginSlotInfo
    {
        foreach ($this->pluginslots as $slot) {
            if ($slot->getId() === $id) {
                return $slot;
            }
        }
        throw new \InvalidArgumentException(
            "No plugin slot $id at component {$this->getQualifiedName()}"
        );
    }

References $id.

getPluginSlotByName()

ilComponentInfo::getPluginSlotByName

(

string

$name

)

Exceptions

InvalidArgumentException if there is no such slot

Definition at line 125 of file class.ilComponentInfo.php.

                                                     : \ilPluginSlotInfo
    {
        foreach ($this->pluginslots as $slot) {
            if ($slot->getName() === $name) {
                return $slot;
            }
        }
        throw new \InvalidArgumentException(
            "No plugin slot $name at component {$this->getQualifiedName()}"
        );
    }

References $name.

getPluginSlots()

ilComponentInfo::getPluginSlots

(

)

Returns

Iterator <ilPluginSlotInfo>

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

                                    : Iterator
    {
        foreach ($this->pluginslots as $id => $slot) {
            yield $slot->getId() => $slot;
        }
    }

References $id.

getQualifiedName()

ilComponentInfo::getQualifiedName

(

)

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

                                      : string
    {
        return $this->type . "/" . $this->name;
    }

References $name.

getType()

ilComponentInfo::getType

(

)

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

                             : string
    {
        return $this->type;
    }

References $type.

hasPluginSlotId()

ilComponentInfo::hasPluginSlotId

(

string

$id

)

Definition at line 87 of file class.ilComponentInfo.php.

                                               : bool
    {
        foreach ($this->pluginslots as $slot) {
            if ($slot->getId() === $id) {
                return true;
            }
        }
        return false;
    }

References $id.

hasPluginSlotName()

ilComponentInfo::hasPluginSlotName

(

string

$name

)

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

                                                   : bool
    {
        foreach ($this->pluginslots as $slot) {
            if ($slot->getName() === $name) {
                return true;
            }
        }
        return false;
    }

References $name.

Field Documentation

$id

string ilComponentInfo::$id

protected

Definition at line 31 of file class.ilComponentInfo.php.

Referenced by __construct(), getId(), getPluginSlotById(), getPluginSlots(), and hasPluginSlotId().

$name

string ilComponentInfo::$name

protected

Definition at line 33 of file class.ilComponentInfo.php.

Referenced by __construct(), getName(), getPluginSlotByName(), getQualifiedName(), and hasPluginSlotName().

$pluginslots

array ilComponentInfo::$pluginslots

protected

Definition at line 37 of file class.ilComponentInfo.php.

Referenced by __construct().

$type

string ilComponentInfo::$type

protected

Definition at line 32 of file class.ilComponentInfo.php.

Referenced by __construct(), and getType().

TYPE_MODULES

const ilComponentInfo::TYPE_MODULES = "Modules"

Definition at line 28 of file class.ilComponentInfo.php.

Referenced by ilOrgUnitExtensionPlugin\_getIcon(), ilObjRepositorySettings\getAllObjTypes(), ilModulesTableGUI\getComponents(), ilTestRandomQuestionSetStagingPoolQuestionList\isActiveQuestionType(), ilAssQuestionList\isActiveQuestionType(), ilAssQuestionType\isImportable(), ilObjTest\isPluginActive(), and ilObjSurvey\isPluginActive().

TYPE_SERVICES

const ilComponentInfo::TYPE_SERVICES = "Services"

Definition at line 29 of file class.ilComponentInfo.php.

Referenced by ilRepositoryObjectPlugin\_getIcon(), and ilModulesTableGUI\getComponents().

TYPES

const ilComponentInfo::TYPES = ["Modules", "Services"]

Definition at line 27 of file class.ilComponentInfo.php.

Referenced by ilArtifactComponentRepository\hasComponent().

---

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

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