Inheritance diagram for ILIAS\Setup\ImplementationOfAgentFinder:

Collaboration diagram for ILIAS\Setup\ImplementationOfAgentFinder:

Public Member Functions
	__construct (protected Refinery $refinery, protected Data\Factory $data_factory, protected \ILIAS\Language\Language $lng, protected ImplementationOfInterfaceFinder $interface_finder, $component_agents)

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

	getComponentAgents ()
	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...

	getComponentAgents ()
	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 Member Functions
	getPluginNames ()

Protected Attributes
array AgentCollection	$component_agents

Detailed Description

Definition at line 26 of file ImplementationOfAgentFinder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\ImplementationOfAgentFinder::__construct	(	protected Refinery	$refinery,
		protected Data\Factory	$data_factory,
		protected \ILIAS\Language\Language	$lng,
		protected ImplementationOfInterfaceFinder	$interface_finder,
			$component_agents
	)

Definition at line 30 of file ImplementationOfAgentFinder.php.

      {
        $this->component_agents = $component_agents;
    }

References ILIAS\Setup\ImplementationOfAgentFinder\$component_agents.

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 129 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
        );
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ 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 145 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\getComponentAgents().

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 45 of file ImplementationOfAgentFinder.php.

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

References ILIAS\Setup\ImplementationOfAgentFinder\getComponentAgents(), ILIAS\Setup\ImplementationOfAgentFinder\getPluginAgent(), and ILIAS\Setup\ImplementationOfAgentFinder\getPluginNames().

Here is the call graph for this function:

◆ getComponentAgents()

ILIAS\Setup\ImplementationOfAgentFinder::getComponentAgents ( )

Collect core agents from the system bundled in a collection.

Implements ILIAS\Setup\AgentFinder.

Definition at line 66 of file ImplementationOfAgentFinder.php.

                                        : AgentCollection
    {
        if ($this->component_agents instanceof AgentCollection) {
            return $this->component_agents;
        }
 
        $agents = new AgentCollection($this->refinery, []);
 
        foreach ($this->component_agents as $agent) {
            $agents = $agents->withAdditionalAgent(
                $this->getAgentNameByClassName(get_class($agent)),
                $agent
            );
        }
 
        $this->component_agents = $agents;
        return $this->component_agents;
    }

References ILIAS\Setup\ImplementationOfAgentFinder\$component_agents, ILIAS\Setup\ImplementationOfAgentFinder\getAgentNameByClassName(), and ILIAS\Repository\refinery().

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 93 of file ImplementationOfAgentFinder.php.

                                                : Agent
    {
        // 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 = "[/]public/Customizing/global/plugins/.*/.*/" . $name . "/.*";
        $agent_classes = iterator_to_array($this->interface_finder->getMatchingClassNames(
            Agent::class,
            [],
            $path
        ));
 
        if ($agent_classes === []) {
            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
        );
    }

References $path, ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginNames()

ILIAS\Setup\ImplementationOfAgentFinder::getPluginNames ( )

protected

Returns: \Generator <string>

Definition at line 159 of file ImplementationOfAgentFinder.php.

                                       : \Generator
    {
        $directories =
            new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator(__DIR__ . "/../../../../public/Customizing/global/plugins")
            );
        $names = [];
        foreach ($directories as $dir) {
            $groups = [];
            if (preg_match("%^" . __DIR__ . "/[.][.]/[.][.]/[.][.]/[.][.]/public/Customizing/global/plugins/(Services|Modules)/((\\w+/){2})([^/\.]+)(/|$)%", (string) $dir, $groups)) {
                $name = $groups[4];
                if (isset($names[$name])) {
                    continue;
                }
                $names[$name] = true;
                yield $name;
            }
        }
    }