ilEventHandlingBuildEventInfoObjective Class Reference

Inheritance diagram for ilEventHandlingBuildEventInfoObjective:

Collaboration diagram for ilEventHandlingBuildEventInfoObjective:

Public Member Functions
	getArtifactName ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	build ()

Private Attributes
ilComponentRepository	$component_repository = null

Detailed Description

Definition at line 21 of file class.ilEventHandlingBuildEventInfoObjective.php.

Member Function Documentation

achieve()

ilEventHandlingBuildEventInfoObjective::achieve

(

Setup\Environment

$environment

)

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

                                                           : Setup\Environment
    {
        $this->component_repository = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_REPOSITORY);
 
        return parent::achieve($environment);
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

build()

ilEventHandlingBuildEventInfoObjective::build

(

)

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

                           : Setup\Artifact
    {
        $processor = new \ilEventHandlingDefinitionProcessor();
 
        // Plugins behave slightly differently from core components: they do not always have a plugin.xml and the
        // `ilComponentDefinitionReader` does not read them at all. Therefore, we overwrite the reader at this point
        // and supplement it with the information from the existing plugins.
 
        $plugin_and_components_reader = new class ($this->component_repository, $processor) extends
            \ilComponentDefinitionReader {
            public function __construct(
                private ilComponentRepository $component_repository,
                ilComponentDefinitionProcessor ...$processor,
            ) {
                parent::__construct(...$processor);
            }
 
            protected function getComponents(): \Iterator
            {
                yield from parent::getComponents();
 
                foreach ($this->component_repository->getPlugins() as $plugin) {
                    $xml_plugin_path = $plugin->getPath() . '/plugin.xml';
                    if (!file_exists($xml_plugin_path)) {
                        continue;
                    }
                    yield [
                        'Plugins', // Plugins are generally handled in ilAppEventHandler with the prefix "Plugins".
                        $plugin->getName(),
                        $xml_plugin_path,
                    ];
                }
            }
        };
 
        $plugin_and_components_reader->purge();
        $plugin_and_components_reader->readComponentDefinitions();
 
        return new Setup\Artifact\ArrayArtifact($processor->getData());
    }

References $component_repository, XapiProxy\$plugin, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

getArtifactName()

ilEventHandlingBuildEventInfoObjective::getArtifactName

(

)

Definition at line 23 of file class.ilEventHandlingBuildEventInfoObjective.php.

                                     : string
    {
        return "event_handling_data";
    }

getPreconditions()

ilEventHandlingBuildEventInfoObjective::getPreconditions

(

Setup\Environment

$environment

)

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

                                                                    : array
    {
        return [
            new ilStaticComponentRepositoryExistsObjective(),
        ];
    }

Field Documentation

$component_repository

ilComponentRepository ilEventHandlingBuildEventInfoObjective::$component_repository = null

private

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

Referenced by build().

---

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

• components/ILIAS/EventHandling/classes/Setup/class.ilEventHandlingBuildEventInfoObjective.php