Repository for component data implemented over artifacts. More...

Inheritance diagram for ilArtifactComponentRepository:

Collaboration diagram for ilArtifactComponentRepository:

Public Member Functions
	__construct (Data\Factory $data_factory, ilPluginStateDB $plugin_state_db, Data\Version $ilias_version)

	hasComponent (string $type, string $name)

	hasComponentId (string $id)

	getComponents ()

	getComponentById (string $id)

	getComponentByTypeAndName (string $type, string $name)

	hasPluginSlotId (string $id)

	getPluginSlots ()

	getPluginSlotById (string $id)

	hasPluginId (string $id)
	Check if a plugin exists. More...

	getPlugins ()
	Get all plugins. More...

	getPluginById (string $id)
	Get a plugin by id. More...

	getPluginByName (string $name)
	Get a plugin by name. More...

	setCurrentPluginVersion (string $plugin_id, Data\Version $version, int $db_version)

	setActivation (string $plugin_id, bool $activated)

	removeStateInformationOf (string $plugin_id)

	hasActivatedPlugin (string $id)
	Check if a plugin exists and is activated. More...

Public Member Functions inherited from ilComponentRepositoryWrite
	setCurrentPluginVersion (string $plugin_id, Version $version, int $db_version)

Data Fields
const	COMPONENT_DATA_PATH = "Services/Component/artifacts/component_data.php"

const	PLUGIN_DATA_PATH = "Services/Component/artifacts/plugin_data.php"

Data Fields inherited from ilComponentRepository
const	PLUGIN_BASE_PATH = "Customizing/global/plugins"

Protected Member Functions
	buildDatabase ()

	readComponentData ()

	readPluginData ()

Protected Attributes
Data Factory	$data_factory

ilPluginStateDB	$plugin_state_db

Data Version	$ilias_version

array	$components

array	$component_id_by_type_and_name

array	$pluginslot_by_id

array	$plugin_by_id

array	$plugin_by_name

Detailed Description

Repository for component data implemented over artifacts.

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

Constructor & Destructor Documentation

◆ __construct()

ilArtifactComponentRepository::__construct	(	Data\Factory	$data_factory,
		ilPluginStateDB	$plugin_state_db,
		Data\Version	$ilias_version
	)

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

References $data_factory, $ilias_version, $plugin_state_db, and buildDatabase().

     {
         $this->data_factory = $data_factory;
         $this->plugin_state_db = $plugin_state_db;
         $this->ilias_version = $ilias_version;
 
         $this->buildDatabase();
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildDatabase()

ilArtifactComponentRepository::buildDatabase ( )

protected

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

References $data, $ilias_max_version, $ilias_min_version, $learning_progress, $responsible, $responsible_mail, $supports_export, getComponentByTypeAndName(), hasComponent(), readComponentData(), and readPluginData().

Referenced by __construct(), removeStateInformationOf(), setActivation(), and setCurrentPluginVersion().

                                       : void
     {
         $component_data = $this->readComponentData();
         $plugin_data = $this->readPluginData();
         $this->components = [];
         $this->component_id_by_type_and_name = [
             "Modules" => [],
             "Services" => []
         ];
         $this->pluginslot_by_id = [];
         $plugins_per_slot = [];
         foreach ($component_data as $comp_id => [$type, $comp_name, $slot_data]) {
             $slots = [];
             $component = new ilComponentInfo(
                 $comp_id,
                 $type,
                 $comp_name,
                 $slots
             );
             foreach ($slot_data as [$slot_id, $slot_name]) {
                 $plugins_per_slot[$slot_id] = [];
                 $slots[$slot_id] = new ilPluginSlotInfo(
                     $component,
                     $slot_id,
                     $slot_name,
                     $plugins_per_slot[$slot_id]
                 );
                 $this->pluginslot_by_id[$slot_id] = $slots[$slot_id];
             }
             $this->components[$comp_id] = $component;
             $this->component_id_by_type_and_name[$type][$comp_name] = $comp_id;
             unset($slots);
         }
         $this->plugin_by_id = [];
         foreach ($plugin_data as $plugin_id => $data) {
             [
                 $type,
                 $comp_name,
                 $slot_name,
                 $plugin_name,
                 $plugin_version,
                 $ilias_min_version,
                 $ilias_max_version,
                 $responsible,
                 $responsible_mail,
                 $learning_progress,
                 $supports_export,
                 $supports_cli_setup
             ] = $data;
             if (!$this->hasComponent($type, $comp_name)) {
                 throw new \InvalidArgumentException(
                     "Can't find component $type/$comp_name for plugin $plugin_name"
                 );
             }
             $component = $this->getComponentByTypeAndName($type, $comp_name);
             if (!$component->hasPluginSlotName($slot_name)) {
                 throw new \InvalidArgumentException(
                     "Can't find slot $type/$comp_name/$slot_name for plugin $plugin_name"
                 );
             }
             $slot = $component->getPluginSlotByName($slot_name);
             $this->plugin_by_id[$plugin_id] = new ilPluginInfo(
                 $this->ilias_version,
                 $slot,
                 $plugin_id,
                 $plugin_name,
                 $this->plugin_state_db->isPluginActivated($plugin_id),
                 $this->plugin_state_db->getCurrentPluginVersion($plugin_id),
                 $this->plugin_state_db->getCurrentPluginDBVersion($plugin_id),
                 $this->data_factory->version($plugin_version),
                 $this->data_factory->version($ilias_min_version),
                 $this->data_factory->version($ilias_max_version),
                 $responsible,
                 $responsible_mail,
                 $learning_progress ?? false,
                 $supports_export ?? false,
                 $supports_cli_setup ?? true
             );
             $plugins_per_slot[$slot->getId()][$plugin_id] = $this->plugin_by_id[$plugin_id];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponentById()

ilArtifactComponentRepository::getComponentById ( string $id )

Implements ilComponentRepository.

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

References $id, and hasComponentId().

                                                 : ilComponentInfo
     {
         if (!$this->hasComponentId($id)) {
             throw new \InvalidArgumentException(
                 "Unknown component $id"
             );
         }
         return $this->components[$id];
     }

Here is the call graph for this function:

◆ getComponentByTypeAndName()

ilArtifactComponentRepository::getComponentByTypeAndName	(	string	$type,
		string	$name
	)

Implements ilComponentRepository.

Definition at line 191 of file class.ilArtifactComponentRepository.php.

References hasComponent().

Referenced by buildDatabase().

                                                                          : ilComponentInfo
     {
         if (!$this->hasComponent($type, $name)) {
             throw new \InvalidArgumentException(
                 "Unknown component $type/$name"
             );
         }
         return $this->components[$this->component_id_by_type_and_name[$type][$name]];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponents()

ilArtifactComponentRepository::getComponents ( )

Implements ilComponentRepository.

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

References $id.

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

◆ getPluginById()

ilArtifactComponentRepository::getPluginById ( string $id )

Get a plugin by id.

Exceptions

Implements ilComponentRepository.

Definition at line 260 of file class.ilArtifactComponentRepository.php.

References $id, and hasPluginId().

Referenced by hasActivatedPlugin(), setCurrentPluginVersion(), and ilArtifactComponentRepositoryTest\testUsesPluginStateDB().

                                              : ilPluginInfo
     {
         if (!$this->hasPluginId($id)) {
             throw new \InvalidArgumentException(
                 "Unknown plugin $id."
             );
         }
         return $this->plugin_by_id[$id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginByName()

ilArtifactComponentRepository::getPluginByName ( string $name )

Get a plugin by name.

Exceptions

Implements ilComponentRepository.

Definition at line 275 of file class.ilArtifactComponentRepository.php.

References XapiProxy\$plugin, and getPlugins().

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

Here is the call graph for this function:

◆ getPlugins()

ilArtifactComponentRepository::getPlugins ( )

Get all plugins.

Keys are the ids.

Returns: Iterator <string, ilPluginInfo>

Implements ilComponentRepository.

Definition at line 248 of file class.ilArtifactComponentRepository.php.

References $id, and XapiProxy\$plugin.

Referenced by getPluginByName().

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

Here is the caller graph for this function:

◆ getPluginSlotById()

ilArtifactComponentRepository::getPluginSlotById ( string $id )

Implements ilComponentRepository.

Definition at line 223 of file class.ilArtifactComponentRepository.php.

References $id, and hasPluginSlotId().

                                                  : ilPluginSlotInfo
     {
         if (!$this->hasPluginSlotId($id)) {
             throw new \InvalidArgumentException(
                 "Unknown pluginslot $id"
             );
         }
         return $this->pluginslot_by_id[$id];
     }

Here is the call graph for this function:

◆ getPluginSlots()

ilArtifactComponentRepository::getPluginSlots ( )

Implements ilComponentRepository.

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

References $id.

Referenced by ilArtifactComponentRepositoryTest\testNoPluginSlot().

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

Here is the caller graph for this function:

◆ hasActivatedPlugin()

ilArtifactComponentRepository::hasActivatedPlugin ( string $id )

Check if a plugin exists and is activated.

Implements ilComponentRepository.

Definition at line 326 of file class.ilArtifactComponentRepository.php.

References getPluginById(), and hasPluginId().

                                                   : bool
     {
         return ($this->hasPluginId($id) && $this->getPluginById($id)->isActivated());
     }

Here is the call graph for this function:

◆ hasComponent()

ilArtifactComponentRepository::hasComponent	(	string	$type,
		string	$name
	)

Implements ilComponentRepository.

Definition at line 146 of file class.ilArtifactComponentRepository.php.

References ilComponentInfo\TYPES.

Referenced by buildDatabase(), and getComponentByTypeAndName().

                                                             : bool
     {
         if (!in_array($type, ilComponentInfo::TYPES)) {
             throw new \InvalidArgumentException(
                 "Unknown component type $type."
             );
         }
 
         return isset($this->component_id_by_type_and_name[$type][$name]);
     }

Here is the caller graph for this function:

◆ hasComponentId()

ilArtifactComponentRepository::hasComponentId ( string $id )

Implements ilComponentRepository.

Definition at line 160 of file class.ilArtifactComponentRepository.php.

Referenced by getComponentById().

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

Here is the caller graph for this function:

◆ hasPluginId()

ilArtifactComponentRepository::hasPluginId ( string $id )

Check if a plugin exists.

Implements ilComponentRepository.

Definition at line 236 of file class.ilArtifactComponentRepository.php.

Referenced by getPluginById(), hasActivatedPlugin(), removeStateInformationOf(), and setActivation().

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

Here is the caller graph for this function:

◆ hasPluginSlotId()

ilArtifactComponentRepository::hasPluginSlotId ( string $id )

Implements ilComponentRepository.

Definition at line 205 of file class.ilArtifactComponentRepository.php.

Referenced by getPluginSlotById().

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

Here is the caller graph for this function:

◆ readComponentData()

ilArtifactComponentRepository::readComponentData ( )

protected

Definition at line 133 of file class.ilArtifactComponentRepository.php.

Referenced by buildDatabase().

                                           : array
     {
         return require self::COMPONENT_DATA_PATH;
     }

Here is the caller graph for this function:

◆ readPluginData()

ilArtifactComponentRepository::readPluginData ( )

protected

Definition at line 138 of file class.ilArtifactComponentRepository.php.

Referenced by buildDatabase().

                                        : array
     {
         return require self::PLUGIN_DATA_PATH;
     }

Here is the caller graph for this function:

◆ removeStateInformationOf()

ilArtifactComponentRepository::removeStateInformationOf ( string $plugin_id )

Implements ilComponentRepositoryWrite.

Definition at line 315 of file class.ilArtifactComponentRepository.php.

References buildDatabase(), and hasPluginId().

Referenced by ilArtifactComponentRepositoryTest\testRemoveStateInformationOfCallsStateDB(), and ilArtifactComponentRepositoryTest\testRemoveStateInformationOfTriggersRebuild().

                                                                : void
     {
         if (!$this->hasPluginId($plugin_id)) {
             throw new \InvalidArgumentException(
                 "Unknown plugin $plugin_id."
             );
         }
         $this->plugin_state_db->remove($plugin_id);
         $this->buildDatabase();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActivation()

ilArtifactComponentRepository::setActivation	(	string	$plugin_id,
		bool	$activated
	)

Implements ilComponentRepositoryWrite.

Definition at line 304 of file class.ilArtifactComponentRepository.php.

References buildDatabase(), and hasPluginId().

Referenced by ilArtifactComponentRepositoryTest\testSetActivationCallsStateDB(), and ilArtifactComponentRepositoryTest\testSetActivationTriggersRebuild().

                                                                      : void
     {
         if (!$this->hasPluginId($plugin_id)) {
             throw new \InvalidArgumentException(
                 "Unknown plugin $plugin_id."
             );
         }
         $this->plugin_state_db->setActivation($plugin_id, $activated);
         $this->buildDatabase();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentPluginVersion()

ilArtifactComponentRepository::setCurrentPluginVersion	(	string	$plugin_id,
		Data\Version	$version,
		int	$db_version
	)

Definition at line 287 of file class.ilArtifactComponentRepository.php.

References XapiProxy\$plugin, buildDatabase(), and getPluginById().

Referenced by ilArtifactComponentRepositoryTest\testSetCurrentPluginVersionCallsStateDB(), and ilArtifactComponentRepositoryTest\testSetCurrentPluginVersionCallsStateDBTriggersRebuild().

                                                                                                       : void
     {
         $plugin = $this->getPluginById($plugin_id);
         if ($plugin->getCurrentVersion() !== null && $plugin->getCurrentVersion()->isGreaterThan($version)) {
             throw new \RuntimeException(
                 "Cannot downgrade plugins version from {$plugin->getCurrentVersion()} to $version"
             );
         }
         if ($plugin->getCurrentDBVersion() !== null && $plugin->getCurrentDBVersion() > $db_version) {
             throw new \RuntimeException(
                 "Cannot downgrade plugins db version from {$plugin->getCurrentDBVersion()} to $db_version"
             );
         }
         $this->plugin_state_db->setCurrentPluginVersion($plugin_id, $version, $db_version);
         $this->buildDatabase();
     }