ILIAS\ApacheAuth\Setup\ApacheAuthAgent Class Reference

Inheritance diagram for ILIAS\ApacheAuth\Setup\ApacheAuthAgent:

Collaboration diagram for ILIAS\ApacheAuth\Setup\ApacheAuthAgent:

Public Member Functions
	__construct (private readonly array $username_provider_contributions)
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. More...
	getInstallObjective (?Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getUpdateObjective (?Setup\Config $config=null)
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
Public Member Functions inherited from ILIAS\Setup\Agent
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. More...
	getInstallObjective (?Config $config=null)
	Get the goals the agent wants to achieve on setup. More...
	getUpdateObjective (?Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Detailed Description

Definition at line 26 of file ApacheAuthAgent.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::__construct

(

private readonly array

$username_provider_contributions

)

Parameters

list<UsernameProvider

UsernameProvider> $username_provider_contributions

Definition at line 33 of file ApacheAuthAgent.php.

      {
    }

Member Function Documentation

getArrayToConfigTransformation()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getArrayToConfigTransformation

(

)

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException

if Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 43 of file ApacheAuthAgent.php.

                                                    : \ILIAS\Refinery\Transformation
    {
        throw new \LogicException(self::class . ' has no Config.');
    }

getBuildObjective()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 57 of file ApacheAuthAgent.php.

                                       : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Building ApacheAuthentication',
            false,
            new UsernameProvider\CollectUsernameProvidersObjective($this->username_provider_contributions)
        );
    }

getInstallObjective()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 48 of file ApacheAuthAgent.php.

                                                                     : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Installing ApacheAuthentication',
            false,
            new UsernameProvider\CollectUsernameProvidersObjective($this->username_provider_contributions)
        );
    }

getMigrations()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 80 of file ApacheAuthAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 75 of file ApacheAuthAgent.php.

                                                                      : Setup\Objective
    {
        return new Setup\Objective\NullObjective();
    }

getUpdateObjective()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 66 of file ApacheAuthAgent.php.

                                                                    : Setup\Objective
    {
        return new Setup\ObjectiveCollection(
            'Updating ApacheAuthentication',
            false,
            new UsernameProvider\CollectUsernameProvidersObjective($this->username_provider_contributions)
        );
    }

hasConfig()

ILIAS\ApacheAuth\Setup\ApacheAuthAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 38 of file ApacheAuthAgent.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/AuthApache/src/Setup/ApacheAuthAgent.php