ilPluginInfo Class Reference

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 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 27 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 46 of file class.ilPluginInfo.php.

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.

      {
        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;
    }

Member Function Documentation

getAvailableVersion()

ilPluginInfo::getAvailableVersion

(

)

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

References $available_version.

Referenced by ilPluginsOverviewTable\getContent().

                                         : Version
    {
        return $this->available_version;
    }

Here is the caller graph for this function:

getClassName()

ilPluginInfo::getClassName

(

)

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

References getName().

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

Here is the call graph for this function:

getComponent()

ilPluginInfo::getComponent

(

)

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

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

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

Here is the caller graph for this function:

getConfigGUIClassName()

ilPluginInfo::getConfigGUIClassName

(

)

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

References getName().

Referenced by ilPluginsOverviewTable\getActions().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentDBVersion()

ilPluginInfo::getCurrentDBVersion

(

)

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

References $current_db_version.

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

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

Here is the caller graph for this function:

getCurrentVersion()

ilPluginInfo::getCurrentVersion

(

)

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

References $current_version.

Referenced by ilPluginsOverviewTable\getContent().

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

Here is the caller graph for this function:

getId()

ilPluginInfo::getId

(

)

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

References $id.

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

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getMaximumILIASVersion()

ilPluginInfo::getMaximumILIASVersion

(

)

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

References $maximum_ilias_version.

Referenced by ilPluginsOverviewTable\getContent().

                                            : Version
    {
        return $this->maximum_ilias_version;
    }

Here is the caller graph for this function:

getMinimumILIASVersion()

ilPluginInfo::getMinimumILIASVersion

(

)

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

References $minimum_ilias_version.

Referenced by ilPluginsOverviewTable\getContent().

                                            : Version
    {
        return $this->minimum_ilias_version;
    }

Here is the caller graph for this function:

getName()

ilPluginInfo::getName

(

)

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

References $name.

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

                             : string
    {
        return $this->name;
    }

Here is the caller graph for this function:

getPath()

ilPluginInfo::getPath

(

)

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

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

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

Here is the call graph for this function:

getPluginSlot()

ilPluginInfo::getPluginSlot

(

)

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

References $pluginslot.

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

                                   : ilPluginSlotInfo
    {
        return $this->pluginslot;
    }

Here is the caller graph for this function:

getReasonForInactivity()

ilPluginInfo::getReasonForInactivity

(

)

Which is the reason for the inactivity?

Exceptions

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

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

Referenced by ilPluginInfoTest\testGetReasonForInactivity(), and ilPluginInfoTest\testGetReasonForInactivityThrowsOnActivePlugin().

                                            : 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."
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getResponsible()

ilPluginInfo::getResponsible

(

)

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

References $responsible.

Referenced by ilPluginsOverviewTable\getContent().

                                    : string
    {
        return $this->responsible;
    }

Here is the caller graph for this function:

getResponsibleMail()

ilPluginInfo::getResponsibleMail

(

)

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

References $responsible_mail.

Referenced by ilPluginsOverviewTable\getContent().

                                        : string
    {
        return $this->responsible_mail;
    }

Here is the caller graph for this function:

getType()

ilPluginInfo::getType

(

)

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

References $type.

Referenced by getPath().

                             : string
    {
        return $this->type;
    }

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 138 of file class.ilPluginInfo.php.

References $activated.

Referenced by getReasonForInactivity(), and isActive().

                                 : bool
    {
        return $this->activated;
    }

Here is the caller graph for this function:

isActivationPossible()

ilPluginInfo::isActivationPossible

(

)

Can this plugin be activated right now.

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

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

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

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

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 243 of file class.ilPluginInfo.php.

References isActivated(), and isActivationPossible().

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

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

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 222 of file class.ilPluginInfo.php.

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

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

Here is the caller graph for this function:

isInstalled()

ilPluginInfo::isInstalled

(

)

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

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

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

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

Here is the caller graph for this function:

isUpdateRequired()

ilPluginInfo::isUpdateRequired

(

)

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

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

References isInstalled().

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

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

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 213 of file class.ilPluginInfo.php.

Referenced by getReasonForInactivity(), and isActivationPossible().

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

Here is the caller graph for this function:

supportsCLISetup()

ilPluginInfo::supportsCLISetup

(

)

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

References $supports_cli_setup.

Referenced by ilPluginsOverviewTable\getContent().

                                      : bool
    {
        return $this->supports_cli_setup;
    }

Here is the caller graph for this function:

supportsExport()

ilPluginInfo::supportsExport

(

)

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

References $supports_export.

Referenced by ilPluginsOverviewTable\getContent().

                                    : bool
    {
        return $this->supports_export;
    }

Here is the caller graph for this function:

supportsLearningProgress()

ilPluginInfo::supportsLearningProgress

(

)

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

References $supports_learning_progress.

Referenced by ilPluginsOverviewTable\getContent().

                                              : bool
    {
        return $this->supports_learning_progress;
    }

Here is the caller graph for this function:

Field Documentation

$activated

bool ilPluginInfo::$activated

protected

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

Referenced by __construct(), and isActivated().

$actual_ilias_version

Version ilPluginInfo::$actual_ilias_version

protected

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

Referenced by __construct().

$available_version

Version ilPluginInfo::$available_version

protected

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

Referenced by __construct(), and getAvailableVersion().

$current_db_version

int ilPluginInfo::$current_db_version

protected

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

Referenced by __construct(), and getCurrentDBVersion().

$current_version

Version ilPluginInfo::$current_version

protected

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

Referenced by __construct(), and getCurrentVersion().

$id

string ilPluginInfo::$id

protected

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

Referenced by __construct(), and getId().

$maximum_ilias_version

Version ilPluginInfo::$maximum_ilias_version

protected

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

Referenced by __construct(), and getMaximumILIASVersion().

$minimum_ilias_version

Version ilPluginInfo::$minimum_ilias_version

protected

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

Referenced by __construct(), and getMinimumILIASVersion().

$name

string ilPluginInfo::$name

protected

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

Referenced by __construct(), and getName().

$pluginslot

ilPluginSlotInfo ilPluginInfo::$pluginslot

protected

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

Referenced by __construct(), and getPluginSlot().

$responsible

string ilPluginInfo::$responsible

protected

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

Referenced by __construct(), and getResponsible().

$responsible_mail

string ilPluginInfo::$responsible_mail

protected

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

Referenced by __construct(), and getResponsibleMail().

$supports_cli_setup

bool ilPluginInfo::$supports_cli_setup

protected

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

Referenced by __construct(), and supportsCLISetup().

$supports_export

bool ilPluginInfo::$supports_export

protected

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

Referenced by __construct(), and supportsExport().

$supports_learning_progress

bool ilPluginInfo::$supports_learning_progress

protected

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

Referenced by __construct(), and supportsLearningProgress().

$type

string ilPluginInfo::$type

protected

Definition at line 33 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