ilPluginSlotInfo Class Reference

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

Collaboration diagram for ilPluginSlotInfo:

Public Member Functions
	__construct (ilComponentInfo $component, string $id, string $name, array &$plugins)
	getComponent ()
	getId ()
	getName ()
	getQualifiedName ()
	getPath ()
	getPlugins ()
	hasPluginId (string $id)
	getPluginById (string $id)
	hasPluginName (string $name)
	getPluginByName (string $name)
	getActivePlugins ()
	hasActivePlugins ()

Protected Attributes
ilComponentInfo	$component
string	$id
string	$name
array	$plugins

Detailed Description

Simple value class for basic information about a pluginslot.

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

Constructor & Destructor Documentation

__construct()

ilPluginSlotInfo::__construct	(	ilComponentInfo	$component,
		string	$id,
		string	$name,
		array &	$plugins
	)

Definition at line 34 of file class.ilPluginSlotInfo.php.

      {
        $this->component = $component;
        $this->id = $id;
        $this->name = $name;
        $this->plugins = &$plugins;
    }

References $component, $id, $name, and $plugins.

Member Function Documentation

getActivePlugins()

ilPluginSlotInfo::getActivePlugins

(

)

Returns

Iterator <ilPluginInfo>

Definition at line 127 of file class.ilPluginSlotInfo.php.

                                      : Iterator
    {
        foreach ($this->getPlugins() as $id => $plugin) {
            if ($plugin->isActive()) {
                yield $id => $plugin;
            }
        }
    }

References $id, XapiProxy\$plugin, and getPlugins().

Referenced by hasActivePlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

getComponent()

ilPluginSlotInfo::getComponent

(

)

Definition at line 46 of file class.ilPluginSlotInfo.php.

                                  : ilComponentInfo
    {
        return $this->component;
    }

References $component.

getId()

ilPluginSlotInfo::getId

(

)

Definition at line 51 of file class.ilPluginSlotInfo.php.

                           : string
    {
        return $this->id;
    }

References $id.

getName()

ilPluginSlotInfo::getName

(

)

Definition at line 56 of file class.ilPluginSlotInfo.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by getQualifiedName().

Here is the caller graph for this function:

getPath()

ilPluginSlotInfo::getPath

(

)

Definition at line 66 of file class.ilPluginSlotInfo.php.

                             : string
    {
        return ilComponentRepository::PLUGIN_BASE_PATH . "/" . $this->getQualifiedName();
    }

References getQualifiedName(), and ilComponentRepository\PLUGIN_BASE_PATH.

Here is the call graph for this function:

getPluginById()

ilPluginSlotInfo::getPluginById

(

string

$id

)

Exceptions

InvalidArgumentException if plugin does not exist

Definition at line 89 of file class.ilPluginSlotInfo.php.

                                             : \ilPluginInfo
    {
        if (!$this->hasPluginId($id)) {
            throw new \InvalidArgumentException(
                "No plugin $id in slot {$this->getQualifiedName()}."
            );
        }
        return $this->plugins[$id];
    }

References $id, and hasPluginId().

Here is the call graph for this function:

getPluginByName()

ilPluginSlotInfo::getPluginByName

(

string

$name

)

Exceptions

InvalidArgumentException if plugin does not exist

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

                                                 : \ilPluginInfo
    {
        foreach ($this->getPlugins() as $plugin) {
            if ($plugin->getName() === $name) {
                return $plugin;
            }
        }
        throw new \InvalidArgumentException(
            "No plugin with name $name in slot {$this->getQualifiedName()}."
        );
    }

References $name, XapiProxy\$plugin, and getPlugins().

Here is the call graph for this function:

getPlugins()

ilPluginSlotInfo::getPlugins

(

)

Returns

Iterator <ilPluginInfo>

Definition at line 74 of file class.ilPluginSlotInfo.php.

                                : Iterator
    {
        foreach ($this->plugins as $id => $plugin) {
            yield $id => $plugin;
        }
    }

References $id, and XapiProxy\$plugin.

Referenced by getActivePlugins(), getPluginByName(), and hasPluginName().

Here is the caller graph for this function:

getQualifiedName()

ilPluginSlotInfo::getQualifiedName

(

)

Definition at line 61 of file class.ilPluginSlotInfo.php.

                                      : string
    {
        return $this->component->getQualifiedName() . "/" . $this->getName();
    }

References getName().

Referenced by getPath().

Here is the call graph for this function:

Here is the caller graph for this function:

hasActivePlugins()

ilPluginSlotInfo::hasActivePlugins

(

)

Definition at line 136 of file class.ilPluginSlotInfo.php.

                                      : bool
    {
        foreach ($this->getActivePlugins() as $_) {
            return true;
        }
        return false;
    }

References getActivePlugins().

Here is the call graph for this function:

hasPluginId()

ilPluginSlotInfo::hasPluginId

(

string

$id

)

Definition at line 81 of file class.ilPluginSlotInfo.php.

                                           : bool
    {
        return isset($this->plugins[$id]);
    }

References $id.

Referenced by getPluginById().

Here is the caller graph for this function:

hasPluginName()

ilPluginSlotInfo::hasPluginName

(

string

$name

)

Definition at line 99 of file class.ilPluginSlotInfo.php.

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

References $name, XapiProxy\$plugin, and getPlugins().

Here is the call graph for this function:

Field Documentation

$component

ilComponentInfo ilPluginSlotInfo::$component

protected

Definition at line 26 of file class.ilPluginSlotInfo.php.

Referenced by __construct(), and getComponent().

$id

string ilPluginSlotInfo::$id

protected

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

Referenced by __construct(), getActivePlugins(), getId(), getPluginById(), getPlugins(), and hasPluginId().

$name

string ilPluginSlotInfo::$name

protected

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

Referenced by __construct(), getName(), getPluginByName(), and hasPluginName().

$plugins

array ilPluginSlotInfo::$plugins

protected

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

Referenced by __construct().

---

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

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