Simple value class for information about a plugin. More...

Collaboration diagram for ilPluginInfo:

Public Member Functions
	__construct (Version $actual_ilias_version, ilPluginSlotInfo $pluginslot, string $id, string $name, string $type, bool $activated, ?Version $current_version, ?int $current_db_version, Version $available_version, Version $minimum_ilias_version, Version $maximum_ilias_version, string $responsible, string $responsible_mail, bool $supports_learning_progress, bool $supports_export, bool $supports_cli_setup)

	getPluginSlot ()

	getComponent ()

	getId ()

	getName ()

	getType ()

	getPath ()

	getClassName ()

	getConfigGUIClassName ()

	isActivated ()
	"activated" tells if the administrator of the installation wants the plugin to be effective. More...

	getCurrentVersion ()

	getCurrentDBVersion ()

	getAvailableVersion ()

	getMinimumILIASVersion ()

	getMaximumILIASVersion ()

	getResponsible ()

	getResponsibleMail ()

	supportsLearningProgress ()

	supportsExport ()

	supportsCLISetup ()

	isInstalled ()
	"Installed" tells if the plugin has some installed version. More...

	isUpdateRequired ()
	"Update required" tells if the plugin needs an update. More...

	isVersionToOld ()
	"Version to old" tells if the plugin code has a version that is below the version that was updated last. More...

	isCompliantToILIAS ()
	"ILIAS Version compliance" tells if the plugin can be operated with the given ILIAS version. More...

	isActivationPossible ()
	Can this plugin be activated right now. More...

	isActive ()
	Is this plugin active right now? More...

	getReasonForInactivity ()
	Which is the reason for the inactivity? More...

Protected Member Functions
	normalizePath (string $path)
	Resolves "." and ".." segments without touching the file system, so it also works for plugins which are not installed (yet). More...

Protected Attributes
Version	$actual_ilias_version

ilPluginSlotInfo	$pluginslot

string	$id

string	$name

string	$type

bool	$activated

Version	$current_version

int	$current_db_version

Version	$available_version

Version	$minimum_ilias_version

Version	$maximum_ilias_version

string	$responsible

string	$responsible_mail

bool	$supports_learning_progress

bool	$supports_export

bool	$supports_cli_setup

Detailed Description

Simple value class for information about a plugin.

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

Constructor & Destructor Documentation

◆ __construct()

ilPluginInfo::__construct	(	Version	$actual_ilias_version,
		ilPluginSlotInfo	$pluginslot,
		string	$id,
		string	$name,
		string	$type,
		bool	$activated,
		?Version	$current_version,
		?int	$current_db_version,
		Version	$available_version,
		Version	$minimum_ilias_version,
		Version	$maximum_ilias_version,
		string	$responsible,
		string	$responsible_mail,
		bool	$supports_learning_progress,
		bool	$supports_export,
		bool	$supports_cli_setup
	)

Definition at line 45 of file class.ilPluginInfo.php.

      {
        if ($current_version === null && $current_db_version !== null) {
            throw new \InvalidArgumentException(
                "If there is no current version for the plugin, we also should not " .
                "have a db-version."
            );
        }
        $this->actual_ilias_version = $actual_ilias_version;
        $this->pluginslot = $pluginslot;
        $this->id = $id;
        $this->name = $name;
        $this->type = $type;
        $this->activated = $activated;
        $this->current_version = $current_version;
        $this->current_db_version = $current_db_version;
        $this->available_version = $available_version;
        $this->minimum_ilias_version = $minimum_ilias_version;
        $this->maximum_ilias_version = $maximum_ilias_version;
        $this->responsible = $responsible;
        $this->responsible_mail = $responsible_mail;
        $this->supports_learning_progress = $supports_learning_progress;
        $this->supports_export = $supports_export;
        $this->supports_cli_setup = $supports_cli_setup;
    }

References $activated, $actual_ilias_version, $available_version, $current_db_version, $current_version, $id, $maximum_ilias_version, $minimum_ilias_version, $name, $pluginslot, $responsible, $responsible_mail, $supports_cli_setup, $supports_export, $supports_learning_progress, and $type.

Member Function Documentation

◆ getAvailableVersion()

ilPluginInfo::getAvailableVersion ( )

Definition at line 178 of file class.ilPluginInfo.php.

                                         : Version
    {
        return $this->available_version;
    }

References $available_version.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getClassName()

ilPluginInfo::getClassName ( )

Definition at line 149 of file class.ilPluginInfo.php.

                                  : string
    {
        return "il" . $this->getName() . "Plugin";
    }

References getName().

Here is the call graph for this function:

◆ getComponent()

ilPluginInfo::getComponent ( )

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

                                  : ilComponentInfo
    {
        return $this->pluginslot->getComponent();
    }

Referenced by ilPluginsOverviewTable\filterData(), and getPath().

Here is the caller graph for this function:

◆ getConfigGUIClassName()

ilPluginInfo::getConfigGUIClassName ( )

Definition at line 154 of file class.ilPluginInfo.php.

                                           : string
    {
        return "il" . $this->getName() . "ConfigGUI";
    }

References getName().

Referenced by ilPluginsOverviewTable\getActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentDBVersion()

ilPluginInfo::getCurrentDBVersion ( )

Definition at line 173 of file class.ilPluginInfo.php.

                                         : ?int
    {
        return $this->current_db_version;
    }

References $current_db_version.

Referenced by ilPluginDBUpdate\__construct(), and ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getCurrentVersion()

ilPluginInfo::getCurrentVersion ( )

Definition at line 168 of file class.ilPluginInfo.php.

                                       : ?Version
    {
        return $this->current_version;
    }

References $current_version.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getId()

ilPluginInfo::getId ( )

Definition at line 97 of file class.ilPluginInfo.php.

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by ilPluginsOverviewTable\filterData(), and ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getMaximumILIASVersion()

ilPluginInfo::getMaximumILIASVersion ( )

Definition at line 188 of file class.ilPluginInfo.php.

                                            : Version
    {
        return $this->maximum_ilias_version;
    }

References $maximum_ilias_version.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getMinimumILIASVersion()

ilPluginInfo::getMinimumILIASVersion ( )

Definition at line 183 of file class.ilPluginInfo.php.

                                            : Version
    {
        return $this->minimum_ilias_version;
    }

References $minimum_ilias_version.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getName()

ilPluginInfo::getName ( )

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

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by ilPluginsOverviewTable\filterData(), getClassName(), getConfigGUIClassName(), getPath(), and ilPluginsOverviewTable\getTable().

Here is the caller graph for this function:

◆ getPath()

ilPluginInfo::getPath ( )

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

                             : string
    {
        return $this->normalizePath(
            implode('/', [
                ilComponentRepository::PLUGIN_BASE_PATH,
                $this->getType(),
                $this->getComponent()->getName(),
                $this->getPluginSlot()->getName(),
                $this->getName()
            ])
        );
    }

References getComponent(), getName(), getPluginSlot(), getType(), normalizePath(), and ilComponentRepository\PLUGIN_BASE_PATH.

Here is the call graph for this function:

◆ getPluginSlot()

ilPluginInfo::getPluginSlot ( )

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

                                   : ilPluginSlotInfo
    {
        return $this->pluginslot;
    }

References $pluginslot.

Referenced by ilPluginsOverviewTable\filterData(), ilPluginsOverviewTable\getContent(), getPath(), and ilPluginsOverviewTable\getTable().

Here is the caller graph for this function:

◆ getReasonForInactivity()

ilPluginInfo::getReasonForInactivity ( )

Which is the reason for the inactivity?

Exceptions

LogicException if plugin is actually active.

Returns: string to be used as identifier for language service.

Definition at line 280 of file class.ilPluginInfo.php.

                                            : string
    {
        if ($this->isActive()) {
            throw new \LogicException(
                "Plugin is active, so no reason for inactivity."
            );
        }
 
        if (!$this->isCompliantToILIAS()) {
            return "cmps_needs_matching_ilias_version";
        }
 
        if (!$this->isInstalled()) {
            return "cmps_must_installed";
        }
 
        if ($this->isVersionToOld()) {
            return "cmps_needs_upgrade";
        }
 
        if ($this->isUpdateRequired()) {
            return "cmps_needs_update";
        }
 
        if (!$this->isActivated()) {
            return "cmps_not_activated";
        }
 
        throw new \LogicException(
            "Unknown reason for inactivity of the plugin."
        );
    }

References isActivated(), isActive(), isCompliantToILIAS(), isInstalled(), isUpdateRequired(), and isVersionToOld().

Here is the call graph for this function:

◆ getResponsible()

ilPluginInfo::getResponsible ( )

Definition at line 193 of file class.ilPluginInfo.php.

                                    : string
    {
        return $this->responsible;
    }

References $responsible.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getResponsibleMail()

ilPluginInfo::getResponsibleMail ( )

Definition at line 198 of file class.ilPluginInfo.php.

                                        : string
    {
        return $this->responsible_mail;
    }

References $responsible_mail.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ getType()

ilPluginInfo::getType ( )

Definition at line 107 of file class.ilPluginInfo.php.

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by getPath().

Here is the caller graph for this function:

◆ isActivated()

ilPluginInfo::isActivated ( )

"activated" tells if the administrator of the installation wants the plugin to be effective.

Compare to "active".

Definition at line 163 of file class.ilPluginInfo.php.

                                 : bool
    {
        return $this->activated;
    }

References $activated.

Referenced by getReasonForInactivity(), and isActive().

Here is the caller graph for this function:

◆ isActivationPossible()

ilPluginInfo::isActivationPossible ( )

Can this plugin be activated right now.

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

                                          : bool
    {
        return $this->isCompliantToILIAS()
            && $this->isInstalled()
            && !$this->isVersionToOld()
            && !$this->isUpdateRequired();
    }

References isCompliantToILIAS(), isInstalled(), isUpdateRequired(), and isVersionToOld().

Referenced by ilPluginsOverviewTable\getActions(), and isActive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActive()

ilPluginInfo::isActive ( )

Is this plugin active right now?

Definition at line 268 of file class.ilPluginInfo.php.

                              : bool
    {
        return $this->isActivationPossible()
            && $this->isActivated();
    }

References isActivated(), and isActivationPossible().

Referenced by ilPluginsOverviewTable\filterData(), ilPluginsOverviewTable\getActions(), ilPluginsOverviewTable\getContent(), ilPluginsOverviewTable\getImportantFields(), and getReasonForInactivity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCompliantToILIAS()

ilPluginInfo::isCompliantToILIAS ( )

"ILIAS Version compliance" tells if the plugin can be operated with the given ILIAS version.

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

                                        : bool
    {
        return
            $this->actual_ilias_version->isGreaterThanOrEquals($this->minimum_ilias_version)
            && $this->actual_ilias_version->isSmallerThanOrEquals($this->maximum_ilias_version);
    }

Referenced by getReasonForInactivity(), isActivationPossible(), and ilPluginInfoTest\testIsCompliantToILIAS().

Here is the caller graph for this function:

◆ isInstalled()

ilPluginInfo::isInstalled ( )

"Installed" tells if the plugin has some installed version.

Definition at line 221 of file class.ilPluginInfo.php.

                                 : bool
    {
        return $this->current_version !== null;
    }

Referenced by ilPluginsOverviewTable\getActions(), ilPluginsOverviewTable\getContent(), ilPluginsOverviewTable\getImportantFields(), getReasonForInactivity(), isActivationPossible(), and isUpdateRequired().

Here is the caller graph for this function:

◆ isUpdateRequired()

ilPluginInfo::isUpdateRequired ( )

"Update required" tells if the plugin needs an update.

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

                                      : bool
    {
        return $this->isInstalled() && !$this->current_version->equals($this->available_version);
    }

References isInstalled().

Referenced by ilPluginsOverviewTable\getActions(), ilPluginsOverviewTable\getContent(), ilPluginsOverviewTable\getImportantFields(), getReasonForInactivity(), and isActivationPossible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isVersionToOld()

ilPluginInfo::isVersionToOld ( )

"Version to old" tells if the plugin code has a version that is below the version that was updated last.

Definition at line 238 of file class.ilPluginInfo.php.

                                    : bool
    {
        return $this->current_version->isGreaterThan($this->available_version);
    }

Referenced by getReasonForInactivity(), isActivationPossible(), and ilPluginInfoTest\testIsVersionOld().

Here is the caller graph for this function:

◆ normalizePath()

ilPluginInfo::normalizePath ( string $path )

protected

Resolves "." and ".." segments without touching the file system, so it also works for plugins which are not installed (yet).

ilComponentRepository::PLUGIN_BASE_PATH is built from DIR and therefore carries a "../../../.." which would otherwise end up in every path handed out to a plugin.

Definition at line 132 of file class.ilPluginInfo.php.

                                                  : string
    {
        $segments = [];
        foreach (explode('/', $path) as $segment) {
            if ($segment === '' || $segment === '.') {
                continue;
            }
            if ($segment === '..' && $segments !== [] && end($segments) !== '..') {
                array_pop($segments);
                continue;
            }
            $segments[] = $segment;
        }
 
        return (str_starts_with($path, '/') ? '/' : '') . implode('/', $segments);
    }

Referenced by getPath().

Here is the caller graph for this function:

◆ supportsCLISetup()

ilPluginInfo::supportsCLISetup ( )

Definition at line 213 of file class.ilPluginInfo.php.

                                      : bool
    {
        return $this->supports_cli_setup;
    }

References $supports_cli_setup.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ supportsExport()

ilPluginInfo::supportsExport ( )

Definition at line 208 of file class.ilPluginInfo.php.

                                    : bool
    {
        return $this->supports_export;
    }

References $supports_export.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

◆ supportsLearningProgress()

ilPluginInfo::supportsLearningProgress ( )

Definition at line 203 of file class.ilPluginInfo.php.

                                              : bool
    {
        return $this->supports_learning_progress;
    }

References $supports_learning_progress.

Referenced by ilPluginsOverviewTable\getContent().

Here is the caller graph for this function:

Field Documentation

◆ $activated

bool ilPluginInfo::$activated

protected

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

Referenced by __construct(), and isActivated().

◆ $actual_ilias_version

Version ilPluginInfo::$actual_ilias_version

protected

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

Referenced by __construct().

◆ $available_version

Version ilPluginInfo::$available_version

protected

Definition at line 36 of file class.ilPluginInfo.php.

Referenced by __construct(), and getAvailableVersion().

◆ $current_db_version

int ilPluginInfo::$current_db_version

protected

Definition at line 35 of file class.ilPluginInfo.php.

Referenced by __construct(), and getCurrentDBVersion().

◆ $current_version

Version ilPluginInfo::$current_version

protected

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

Referenced by __construct(), and getCurrentVersion().

◆ $id

string ilPluginInfo::$id

protected

Definition at line 30 of file class.ilPluginInfo.php.

Referenced by __construct(), and getId().

◆ $maximum_ilias_version

Version ilPluginInfo::$maximum_ilias_version

protected

Definition at line 38 of file class.ilPluginInfo.php.

Referenced by __construct(), and getMaximumILIASVersion().

◆ $minimum_ilias_version

Version ilPluginInfo::$minimum_ilias_version

protected

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

Referenced by __construct(), and getMinimumILIASVersion().

◆ $name

string ilPluginInfo::$name

protected

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

Referenced by __construct(), and getName().

◆ $pluginslot

ilPluginSlotInfo ilPluginInfo::$pluginslot

protected

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

Referenced by __construct(), and getPluginSlot().

◆ $responsible

string ilPluginInfo::$responsible

protected

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

Referenced by __construct(), and getResponsible().

◆ $responsible_mail

string ilPluginInfo::$responsible_mail

protected

Definition at line 40 of file class.ilPluginInfo.php.

Referenced by __construct(), and getResponsibleMail().

◆ $supports_cli_setup

bool ilPluginInfo::$supports_cli_setup

protected

Definition at line 43 of file class.ilPluginInfo.php.

Referenced by __construct(), and supportsCLISetup().

◆ $supports_export

bool ilPluginInfo::$supports_export

protected

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

Referenced by __construct(), and supportsExport().

◆ $supports_learning_progress

bool ilPluginInfo::$supports_learning_progress

protected

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

Referenced by __construct(), and supportsLearningProgress().

◆ $type

string ilPluginInfo::$type

protected

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

Referenced by __construct(), and getType().

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

components/ILIAS/Component/classes/class.ilPluginInfo.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAvailableVersion()

◆ getClassName()

◆ getComponent()

◆ getConfigGUIClassName()

◆ getCurrentDBVersion()

◆ getCurrentVersion()

◆ getId()

◆ getMaximumILIASVersion()

◆ getMinimumILIASVersion()

◆ getName()

◆ getPath()

◆ getPluginSlot()

◆ getReasonForInactivity()

◆ getResponsible()

◆ getResponsibleMail()

◆ getType()

◆ isActivated()

◆ isActivationPossible()

◆ isActive()

◆ isCompliantToILIAS()

◆ isInstalled()

◆ isUpdateRequired()

◆ isVersionToOld()

◆ normalizePath()

◆ supportsCLISetup()

◆ supportsExport()

◆ supportsLearningProgress()

Field Documentation

◆ $activated

◆ $actual_ilias_version

◆ $available_version

◆ $current_db_version

◆ $current_version

◆ $id

◆ $maximum_ilias_version

◆ $minimum_ilias_version

◆ $name

◆ $pluginslot

◆ $responsible

◆ $responsible_mail

◆ $supports_cli_setup

◆ $supports_export

◆ $supports_learning_progress

◆ $type