Collaboration diagram for ilPluginsOverviewTable:

Public Member Functions
	__construct (ilObjComponentSettingsGUI $parent_gui, ilCtrl $ctrl, Factory $ui, Renderer $renderer, ilLanguage $lng, array $filter)

	getTable ()

	withData (array $data)

Data Fields
const	F_PLUGIN_NAME = "plugin_name"

const	F_PLUGIN_ID = "plugin_id"

const	F_SLOT_NAME = "slot_name"

const	F_COMPONENT_NAME = "component_name"

const	F_PLUGIN_ACTIVE = "plugin_active"

Protected Member Functions
	getImportantFields (ilPluginInfo $plugin_info)

	getContent (ilPluginInfo $plugin_info)

	boolToString (bool $value)

	filterData (array $data)

	getData ()

	getActions (ilPluginInfo $plugin_info)

	setParameter (ilPluginInfo $plugin)

	clearParameter ()

	getDropdownButton (string $caption, string $command)

	hasLang (ilPluginInfo $plugin_info)

Protected Attributes
ilObjComponentSettingsGUI	$parent_gui

ilCtrl	$ctrl

Factory	$ui

Renderer	$renderer

ilLanguage	$lng

array	$filter

array	$data = []

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilPluginsOverviewTable::__construct	(	ilObjComponentSettingsGUI	$parent_gui,
		ilCtrl	$ctrl,
		Factory	$ui,
		Renderer	$renderer,
		ilLanguage	$lng,
		array	$filter
	)

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

References $ctrl, $filter, $lng, $parent_gui, $renderer, $ui, ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

       {
         $this->parent_gui = $parent_gui;
         $this->ctrl = $ctrl;
         $this->ui = $ui;
         $this->renderer = $renderer;
         $this->lng = $lng;
         $this->filter = $filter;
     }

Here is the call graph for this function:

Member Function Documentation

◆ boolToString()

ilPluginsOverviewTable::boolToString ( bool $value )

protected

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

References ILIAS\Repository\lng().

Referenced by getContent().

                                                 : string
     {
         if ($value) {
             return $this->lng->txt("yes");
         }
         return $this->lng->txt("no");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearParameter()

ilPluginsOverviewTable::clearParameter ( )

protected

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

References ILIAS\Repository\ctrl(), ilObjComponentSettingsGUI\P_CNAME, ilObjComponentSettingsGUI\P_CTYPE, ilObjComponentSettingsGUI\P_PLUGIN_NAME, and ilObjComponentSettingsGUI\P_SLOT_ID.

Referenced by getActions().

                                        : void
     {
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_CTYPE, null);
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_CNAME, null);
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_SLOT_ID, null);
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_PLUGIN_NAME, null);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterData()

ilPluginsOverviewTable::filterData ( array $data )

protected

Parameters

ilPluginInfo[] $data

Returns: ilPluginInfo[]

Definition at line 134 of file class.ilPluginsOverviewTable.php.

References ILIAS\Repository\filter(), ilPluginInfo\getComponent(), ilPluginInfo\getId(), ilPluginInfo\getName(), ilPluginInfo\getPluginSlot(), ILIAS\Repository\int(), and ilPluginInfo\isActive().

Referenced by getTable().

                                               : array
     {
         $active_filters = array_filter($this->filter, static function ($value): bool {
             return !empty($value);
         });
         $plugins = array_filter($data, static function (ilPluginInfo $plugin_info) use ($active_filters): bool {
             $matches_filter = true;
             if (isset($active_filters[self::F_PLUGIN_NAME])) {
                 $matches_filter = strpos($plugin_info->getName(), $active_filters[self::F_PLUGIN_NAME]) !== false;
             }
             if (isset($active_filters[self::F_PLUGIN_ID])) {
                 $matches_filter = strpos($plugin_info->getId(), $active_filters[self::F_PLUGIN_ID]) !== false;
             }
             if (isset($active_filters[self::F_PLUGIN_ACTIVE])) {
                 $v = (int) $active_filters[self::F_PLUGIN_ACTIVE] === 1;
                 $matches_filter = $plugin_info->isActive() === $v && $matches_filter;
             }
             if (isset($active_filters[self::F_SLOT_NAME])) {
                 $matches_filter = $matches_filter && in_array(
                     $plugin_info->getPluginSlot()->getName(),
                     $active_filters[self::F_SLOT_NAME],
                     true
                 );
             }
             if (isset($active_filters[self::F_COMPONENT_NAME])) {
                 $matches_filter = $matches_filter && in_array(
                     $plugin_info->getComponent()->getQualifiedName(),
                     $active_filters[self::F_COMPONENT_NAME],
                     true
                 );
             }
 
             return $matches_filter;
         });
 
         return $plugins;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

ilPluginsOverviewTable::getActions ( ilPluginInfo $plugin_info )

protected

Definition at line 184 of file class.ilPluginsOverviewTable.php.

References clearParameter(), ilObjComponentSettingsGUI\CMD_ACTIVATE_PLUGIN, ilObjComponentSettingsGUI\CMD_CONFIGURE, ilObjComponentSettingsGUI\CMD_CONFIRM_UNINSTALL_PLUGIN, ilObjComponentSettingsGUI\CMD_DEACTIVATE_PLUGIN, ilObjComponentSettingsGUI\CMD_INSTALL_PLUGIN, ilObjComponentSettingsGUI\CMD_REFRESH_LANGUAGES, ilObjComponentSettingsGUI\CMD_UPDATE_PLUGIN, ILIAS\Repository\ctrl(), ilPluginInfo\getConfigGUIClassName(), getDropdownButton(), hasLang(), ilPluginInfo\isActivationPossible(), ilPluginInfo\isActive(), ilPluginInfo\isInstalled(), ilPluginInfo\isUpdateRequired(), ILIAS\Repository\lng(), setParameter(), and ILIAS\Repository\ui().

Referenced by getTable().

                                                             : Dropdown
     {
         $this->setParameter($plugin_info);
 
         $items = [];
 
         if (!$plugin_info->isInstalled()) {
             $items[] = $this->getDropdownButton("cmps_install", ilObjComponentSettingsGUI::CMD_INSTALL_PLUGIN);
             $this->clearParameter();
             return $this->ui->dropdown()->standard($items);
         }
 
         if (class_exists($plugin_info->getConfigGUIClassName())) {
             $items[] = $this->ui->button()->shy(
                 $this->lng->txt("cmps_configure"),
                 $this->ctrl->getLinkTargetByClass(
                     $plugin_info->getConfigGUIClassName(),
                     ilObjComponentSettingsGUI::CMD_CONFIGURE
                 )
             );
         }
 
         if ($this->hasLang($plugin_info)) {
             $items[] = $this->getDropdownButton("cmps_refresh", ilObjComponentSettingsGUI::CMD_REFRESH_LANGUAGES);
         }
 
         if ($plugin_info->isActive()) {
             $items[] = $this->getDropdownButton("cmps_deactivate", ilObjComponentSettingsGUI::CMD_DEACTIVATE_PLUGIN);
         }
 
         if ($plugin_info->isActivationPossible() && !$plugin_info->isActive()) {
             $items[] = $this->getDropdownButton("cmps_activate", ilObjComponentSettingsGUI::CMD_ACTIVATE_PLUGIN);
         }
 
         if ($plugin_info->isUpdateRequired()) {
             $items[] = $this->getDropdownButton("cmps_update", ilObjComponentSettingsGUI::CMD_UPDATE_PLUGIN);
         }
 
         $items[] = $this->getDropdownButton("cmps_uninstall", ilObjComponentSettingsGUI::CMD_CONFIRM_UNINSTALL_PLUGIN);
 
         $this->clearParameter();
 
         return $this->ui->dropdown()->standard($items);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContent()

ilPluginsOverviewTable::getContent ( ilPluginInfo $plugin_info )

protected

Definition at line 101 of file class.ilPluginsOverviewTable.php.

Referenced by getTable().

                                                             : array
     {
         return [
             $this->lng->txt("cmps_is_installed") => $this->boolToString($plugin_info->isInstalled()),
             $this->lng->txt("cmps_is_active") => $this->boolToString($plugin_info->isActive()),
             $this->lng->txt("cmps_needs_update") => $this->boolToString($plugin_info->isUpdateRequired()),
             $this->lng->txt("cmps_id") => $plugin_info->getId(),
             $this->lng->txt("cmps_plugin_slot") => $plugin_info->getPluginSlot()->getName(),
             $this->lng->txt("cmps_current_version") => (string) $plugin_info->getCurrentVersion(),
             $this->lng->txt("cmps_available_version") => (string) $plugin_info->getAvailableVersion(),
             $this->lng->txt("cmps_current_db_version") => (string) $plugin_info->getCurrentDBVersion(),
             $this->lng->txt("cmps_ilias_min_version") => (string) $plugin_info->getMinimumILIASVersion(),
             $this->lng->txt("cmps_ilias_max_version") => (string) $plugin_info->getMaximumILIASVersion(),
             $this->lng->txt("cmps_responsible") => $plugin_info->getResponsible(),
             $this->lng->txt("cmps_responsible_mail") => $plugin_info->getResponsibleMail(),
             $this->lng->txt("cmps_supports_learning_progress") => $this->boolToString($plugin_info->supportsLearningProgress()),
             $this->lng->txt("cmps_supports_export") => $this->boolToString($plugin_info->supportsExport()),
             $this->lng->txt("cmps_supports_cli_setup") => $this->boolToString($plugin_info->supportsCLISetup())
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

ilPluginsOverviewTable::getData ( )

protected

Definition at line 179 of file class.ilPluginsOverviewTable.php.

References $data.

Referenced by getTable().

                                 : array
     {
         return $this->data;
     }

Here is the caller graph for this function:

◆ getDropdownButton()

ilPluginsOverviewTable::getDropdownButton	(	string	$caption,
		string	$command
	)

protected

Definition at line 246 of file class.ilPluginsOverviewTable.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by getActions().

                                                                           : Shy
     {
         return $this->ui->button()->shy(
             $this->lng->txt($caption),
             $this->ctrl->getLinkTarget($this->parent_gui, $command)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImportantFields()

ilPluginsOverviewTable::getImportantFields ( ilPluginInfo $plugin_info )

protected

Definition at line 78 of file class.ilPluginsOverviewTable.php.

References ilPluginInfo\isActive(), ilPluginInfo\isInstalled(), ilPluginInfo\isUpdateRequired(), and ILIAS\Repository\lng().

Referenced by getTable().

                                                                     : array
     {
         $fields = [];
 
         if ($plugin_info->isInstalled()) {
             $fields[] = $this->lng->txt("installed");
         } else {
             $fields[] = $this->lng->txt("not_installed");
         }
 
         if ($plugin_info->isActive()) {
             $fields[] = $this->lng->txt("cmps_active");
         } else {
             $fields[] = $this->lng->txt("inactive");
         }
 
         if ($plugin_info->isUpdateRequired()) {
             $fields[] = $this->lng->txt("cmps_needs_update");
         }
 
         return $fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTable()

ilPluginsOverviewTable::getTable ( )

Definition at line 59 of file class.ilPluginsOverviewTable.php.

References filterData(), getActions(), getContent(), getData(), getImportantFields(), ilPluginInfo\getName(), ilPluginInfo\getPluginSlot(), ILIAS\Repository\ui(), ILIAS\GlobalScreen\Scope\Footer\Factory\withAction(), and withData().

                               : string
     {
         return $this->renderer->render($this->ui->table()->presentation(
             'Plugins',
             [],
             function ($row, ilPluginInfo $record, $ui_factory) {
                 return $row
                     ->withHeadline($record->getName())
                     ->withSubHeadline($record->getPluginSlot()->getName())
                     ->withImportantFields($this->getImportantFields($record))
                     ->withContent(
                         $ui_factory->listing()->descriptive($this->getContent($record))
                     )
                     ->withAction($this->getActions($record))
                 ;
             }
         )->withData($this->filterData($this->getData())));
     }

Here is the call graph for this function:

◆ hasLang()

ilPluginsOverviewTable::hasLang ( ilPluginInfo $plugin_info )

protected

Definition at line 254 of file class.ilPluginsOverviewTable.php.

Referenced by getActions().

                                                          : bool
     {
         $language_handler = new ilPluginLanguage($plugin_info);
         return $language_handler->hasAvailableLangFiles();
     }

Here is the caller graph for this function:

◆ setParameter()

ilPluginsOverviewTable::setParameter ( ilPluginInfo $plugin )

protected

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

References ILIAS\Repository\ctrl(), ilPluginInfo\getComponent(), ilPluginInfo\getId(), ilPluginInfo\getName(), ilPluginInfo\getPluginSlot(), ilObjComponentSettingsGUI\P_CNAME, ilObjComponentSettingsGUI\P_CTYPE, ilObjComponentSettingsGUI\P_PLUGIN_ID, ilObjComponentSettingsGUI\P_PLUGIN_NAME, and ilObjComponentSettingsGUI\P_SLOT_ID.

Referenced by getActions().

                                                          : void
     {
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_PLUGIN_ID, $plugin->getId());
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_CTYPE, $plugin->getComponent()->getType());
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_CNAME, $plugin->getComponent()->getName());
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_SLOT_ID, $plugin->getPluginSlot()->getId());
         $this->ctrl->setParameter($this->parent_gui, ilObjComponentSettingsGUI::P_PLUGIN_NAME, $plugin->getName());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withData()

ilPluginsOverviewTable::withData ( array $data )

Definition at line 172 of file class.ilPluginsOverviewTable.php.

References $data.

Referenced by getTable(), and ilObjComponentSettingsGUI\listPlugins().

                                          : ilPluginsOverviewTable
     {
         $clone = clone $this;
         $clone->data = $data;
         return $clone;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilPluginsOverviewTable::$ctrl

protected

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

Referenced by __construct().

◆ $data

array ilPluginsOverviewTable::$data = []

protected

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

Referenced by getData(), and withData().

◆ $filter

array ilPluginsOverviewTable::$filter

protected

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

Referenced by __construct().

◆ $lng

ilLanguage ilPluginsOverviewTable::$lng

protected

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

Referenced by __construct().

◆ $parent_gui

ilObjComponentSettingsGUI ilPluginsOverviewTable::$parent_gui

protected

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

Referenced by __construct().

◆ $renderer

Renderer ilPluginsOverviewTable::$renderer

protected

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

Referenced by __construct().

◆ $ui

Factory ilPluginsOverviewTable::$ui

protected

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

Referenced by __construct().

◆ F_COMPONENT_NAME

const ilPluginsOverviewTable::F_COMPONENT_NAME = "component_name"

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

◆ F_PLUGIN_ACTIVE

const ilPluginsOverviewTable::F_PLUGIN_ACTIVE = "plugin_active"

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

◆ F_PLUGIN_ID

const ilPluginsOverviewTable::F_PLUGIN_ID = "plugin_id"

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

◆ F_PLUGIN_NAME

const ilPluginsOverviewTable::F_PLUGIN_NAME = "plugin_name"

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

◆ F_SLOT_NAME

const ilPluginsOverviewTable::F_SLOT_NAME = "slot_name"

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

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

components/ILIAS/Component/classes/Settings/class.ilPluginsOverviewTable.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ boolToString()

◆ clearParameter()

◆ filterData()

◆ getActions()

◆ getContent()

◆ getData()

◆ getDropdownButton()

◆ getImportantFields()

◆ getTable()

◆ hasLang()

◆ setParameter()

◆ withData()

Field Documentation

◆ $ctrl

◆ $data

◆ $filter

◆ $lng

◆ $parent_gui

◆ $renderer

◆ $ui

◆ F_COMPONENT_NAME

◆ F_PLUGIN_ACTIVE

◆ F_PLUGIN_ID

◆ F_PLUGIN_NAME

◆ F_SLOT_NAME