Inheritance diagram for ILIAS\Setup\ImplementationOfAgentFinder:

Collaboration diagram for ILIAS\Setup\ImplementationOfAgentFinder:

Public Member Functions
	__construct (Refinery $refinery, Data\Factory $data_factory, \ilSetupLanguage $lng, ImplementationOfInterfaceFinder $interface_finder, \ilPluginRawReader $plugin_raw_reader, array $predefined_agents=[])

	getAgents ()
	Collect all agents from the system, core and plugin, bundled in a collection. More...

	getCoreAgents ()
	Collect core agents from the system bundled in a collection. More...

	getPluginAgent (string $name)
	Get a agent from a specific plugin. More...

	getAgentByClassName (string $class_name)
	Get an agent by class name. More...

	getAgentNameByClassName (string $class_name)
	Derive a name for the agent based on a class name. More...

	getAgents ()
	Collect all agents from the system, core and plugin, bundled in a collection. More...

	getCoreAgents ()
	Collect core agents from the system bundled in a collection. More...

	getPluginAgent (string $name)
	Get a agent from a specific plugin. More...

	getAgentByClassName (string $class_name)
	Get an agent by class name. More...

	getAgentNameByClassName (string $class_name)
	Derive a name for the agent based on a class name. More...

Protected Attributes
	$refinery

	$data_factory

	$lng

	$plugin_raw_reader

	$interface_finder

	$predefined_agents

Detailed Description

Definition at line 12 of file ImplementationOfAgentFinder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\ImplementationOfAgentFinder::__construct	(	Refinery	$refinery,
		Data\Factory	$data_factory,
		\ilSetupLanguage	$lng,
		ImplementationOfInterfaceFinder	$interface_finder,
		\ilPluginRawReader	$plugin_raw_reader,
		array	$predefined_agents = `[]`
	)

Definition at line 47 of file ImplementationOfAgentFinder.php.

      {
        $this->refinery = $refinery;
        $this->data_factory = $data_factory;
        $this->lng = $lng;
        $this->interface_finder = $interface_finder;
        $this->plugin_raw_reader = $plugin_raw_reader;
        $this->predefined_agents = $predefined_agents;
    }

References ILIAS\Setup\ImplementationOfAgentFinder\$data_factory, ILIAS\Setup\ImplementationOfAgentFinder\$interface_finder, ILIAS\Setup\ImplementationOfAgentFinder\$lng, ILIAS\Setup\ImplementationOfAgentFinder\$plugin_raw_reader, ILIAS\Setup\ImplementationOfAgentFinder\$predefined_agents, and ILIAS\Setup\ImplementationOfAgentFinder\$refinery.

Member Function Documentation

◆ getAgentByClassName()

ILIAS\Setup\ImplementationOfAgentFinder::getAgentByClassName ( string $class_name )

Get an agent by class name.

Throws an exception if the class doesn't exists.

Parameters

string $class_name

Returns: AgentCollection

Exceptions

InvalidArgumentException

Implements ILIAS\Setup\AgentFinder.

Definition at line 166 of file ImplementationOfAgentFinder.php.

                                                            : Agent
    {
        if (!class_exists($class_name)) {
            throw new \InvalidArgumentException("Class '" . $class_name . "' not found.");
        }
 
        return new $class_name(
            $this->refinery,
            $this->data_factory,
            $this->lng
        );
    }

◆ getAgentNameByClassName()

ILIAS\Setup\ImplementationOfAgentFinder::getAgentNameByClassName ( string $class_name )

Derive a name for the agent based on a class name.

Implements ILIAS\Setup\AgentFinder.

Definition at line 182 of file ImplementationOfAgentFinder.php.

                                                                : string
    {
        // We assume that the name of an agent in the class ilXYZSetupAgent really
        // is XYZ. If that does not fit we just use the class name.
        $match = [];
        if (preg_match("/il(\w+)SetupAgent/", $class_name, $match)) {
            return strtolower($match[1]);
        }
        return $class_name;
    }

Referenced by ILIAS\Setup\ImplementationOfAgentFinder\getCoreAgents().

Here is the caller graph for this function:

◆ getAgents()

ILIAS\Setup\ImplementationOfAgentFinder::getAgents ( )

Collect all agents from the system, core and plugin, bundled in a collection.

Parameters

string[] $ignore folders to be ignored.

Implements ILIAS\Setup\AgentFinder.

Definition at line 68 of file ImplementationOfAgentFinder.php.

                                : AgentCollection
    {
        $agents = $this->getCoreAgents();
 
        // Get a list of existing plugins in the system.
        $plugins = $this->plugin_raw_reader->getPluginNames();
 
        foreach ($plugins as $plugin_name) {
            $agents = $agents->withAdditionalAgent(
                strtolower($plugin_name),
                $this->getPluginAgent($plugin_name)
            );
        }
 
        return $agents;
    }

References ILIAS\Setup\ImplementationOfAgentFinder\getCoreAgents(), and ILIAS\Setup\ImplementationOfAgentFinder\getPluginAgent().

Here is the call graph for this function:

◆ getCoreAgents()

ILIAS\Setup\ImplementationOfAgentFinder::getCoreAgents ( )

Collect core agents from the system bundled in a collection.

Implements ILIAS\Setup\AgentFinder.

Definition at line 89 of file ImplementationOfAgentFinder.php.

                                    : AgentCollection
    {
        // Initialize the agents.
        $agents = new AgentCollection(
            $this->refinery,
            $this->predefined_agents
        );
 
        // This is a list of all agent classes in the system (which we don't want to ignore).
        $agent_classes = $this->interface_finder->getMatchingClassNames(
            Agent::class,
            ["[/]Customizing/.*"]
        );
        foreach ($agent_classes as $class_name) {
            $agents = $agents->withAdditionalAgent(
                $this->getAgentNameByClassName($class_name),
                new $class_name(
                    $this->refinery,
                    $this->data_factory,
                    $this->lng
                )
            );
        }
 
        return $agents;
    }

References ILIAS\Setup\ImplementationOfAgentFinder\getAgentNameByClassName().

Referenced by ILIAS\Setup\ImplementationOfAgentFinder\getAgents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginAgent()

ILIAS\Setup\ImplementationOfAgentFinder::getPluginAgent ( string $name )

Get a agent from a specific plugin.

If there is no plugin agent, this would the default agent. If the plugin contains multiple agents, these will be collected.

Parameters

string $name of the plugin to get the agent from

Implements ILIAS\Setup\AgentFinder.

Definition at line 124 of file ImplementationOfAgentFinder.php.

                                                 : Agent
    {
        if (!$this->plugin_raw_reader->hasPlugin($name)) {
            throw new \InvalidArgumentException(
                "Cannot find plugin with name '$name'"
            );
        }
 
        // TODO: This seems to be something that rather belongs to Services/Component/
        // but we put it here anyway for the moment. This seems to be something that
        // could go away when we unify Services/Modules/Plugins to one common concept.
        $path = "[/]Customizing/global/plugins/.*/.*/" . $name . "/.*";
        $agent_classes = iterator_to_array($this->interface_finder->getMatchingClassNames(
            Agent::class,
            [],
            $path
        ));
 
        if (count($agent_classes) === 0) {
            return new class($name) extends \ilPluginDefaultAgent {
            };
        }
 
        $agents = [];
        foreach ($agent_classes as $class_name) {
            $agents[] = new $class_name(
                $this->refinery,
                $this->data_factory,
                $this->lng
            );
        }
 
        if (count($agents) === 1) {
            return $agents[0];
        }
 
        return new AgentCollection(
            $this->refinery,
            $agents
        );
    }