ilNotificationsSetupAgent Class Reference

Inheritance diagram for ilNotificationsSetupAgent:

Collaboration diagram for ilNotificationsSetupAgent:

Public Member Functions
	__construct (protected readonly Factory $refinery, protected readonly array $provider)
	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 (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 33 of file ilNotificationsSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilNotificationsSetupAgent::__construct	(	protected readonly Factory	$refinery,
		protected readonly array	$provider
	)

Parameters

PushProviderInterface[]

$provider

Definition at line 40 of file ilNotificationsSetupAgent.php.

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ilNotificationsSetupAgent::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 49 of file ilNotificationsSetupAgent.php.

                                                    : Transformation
    {
        return $this->refinery->custom()->transformation(static function ($data): Config {
            if ($data !== null) {
                if (($data['private_key_path'] ?? '') === '') {
                    throw new InvalidArgumentException(
                        'No valid private key path given for push notifications. Please check your config file.'
                    );
                }
                return new PushNotificationConfig($data['private_key_path']);
            } else {
                return new NullConfig();
            }
        });
    }

References $data, and ILIAS\Repository\refinery().

Here is the call graph for this function:

getBuildObjective()

ilNotificationsSetupAgent::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 82 of file ilNotificationsSetupAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilNotificationsSetupAgent::getInstallObjective

(

?Config

$config = null

)

Get the goals the agent wants to achieve on setup.

The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException

if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 65 of file ilNotificationsSetupAgent.php.

                                                               : Objective
    {
        return new PushNotificationObjective($this->provider, $config ?? new NullConfig());
    }

getMigrations()

ilNotificationsSetupAgent::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 92 of file ilNotificationsSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilNotificationsSetupAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 87 of file ilNotificationsSetupAgent.php.

                                                        : Objective
    {
        return new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilNotificationUpdateSteps());
    }

getUpdateObjective()

ilNotificationsSetupAgent::getUpdateObjective

(

?Config

$config = null

)

Get the goal the agent wants to achieve on update.

The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.

The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.

If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException

if Config does not match the Agent..

Implements ILIAS\Setup\Agent.

Definition at line 70 of file ilNotificationsSetupAgent.php.

                                                              : Objective
    {
        return new ObjectiveCollection(
            'Notification Objectives',
            true,
            new ilTreeAdminNodeAddedObjective('nota', 'Notification Service Administration Object'),
            new ilDatabaseUpdateStepsExecutedObjective(new ilNotificationUpdateSteps()),
            new ilDatabaseUpdateStepsExecutedObjective(new ilNotificationUpdateSteps11()),
            new PushNotificationObjective($this->provider, $config ?? new NullConfig())
        );
    }

hasConfig()

ilNotificationsSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 44 of file ilNotificationsSetupAgent.php.

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/Notifications/classes/Setup/ilNotificationsSetupAgent.php