ILIAS  release_8 Revision v8.19-1-g4e8f2f9140c
All Data Structures Namespaces Files Functions Variables Modules Pages
ILIAS\Setup\AgentFinder Interface Reference
+ Inheritance diagram for ILIAS\Setup\AgentFinder:
+ Collaboration diagram for ILIAS\Setup\AgentFinder:

Public Member Functions

 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...
 

Detailed Description

Definition at line 23 of file AgentFinder.php.

Member Function Documentation

◆ getAgentByClassName()

ILIAS\Setup\AgentFinder::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

Implemented in ILIAS\Setup\ImplementationOfAgentFinder.

◆ getAgentNameByClassName()

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

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

Implemented in ILIAS\Setup\ImplementationOfAgentFinder.

◆ getAgents()

ILIAS\Setup\AgentFinder::getAgents ( )

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

Implemented in ILIAS\Setup\ImplementationOfAgentFinder.

◆ getCoreAgents()

ILIAS\Setup\AgentFinder::getCoreAgents ( )

Collect core agents from the system bundled in a collection.

Implemented in ILIAS\Setup\ImplementationOfAgentFinder.

◆ getPluginAgent()

ILIAS\Setup\AgentFinder::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$nameof the plugin to get the agent from

Implemented in ILIAS\Setup\ImplementationOfAgentFinder.


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