PushNotificationObjective Class Reference

Inheritance diagram for PushNotificationObjective:

Collaboration diagram for PushNotificationObjective:

Public Member Functions
	__construct (protected readonly array $provider, protected readonly Config $config)
	build ()
	Build the artifact based. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	getArtifactName ()
	Get the filename where the builder wants to put its artifact. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
Public Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
	getArtifactName ()
	Get the filename where the builder wants to put its artifact. More...
	build ()
	Build the artifact based. More...
	buildIn (Setup\Environment $env)
	Builds an artifact in some given Environment. More...
	getPreconditions (Setup\Environment $environment)
	Defaults to no preconditions. More...
	getHash ()
	Uses hashed Path. More...
	getLabel ()
	Defaults to 'Build ' . More...
	isNotable ()
	Defaults to 'true'. More...
	achieve (Setup\Environment $environment)
	Builds the artifact and puts it in its location. More...
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Additional Inherited Members
Static Public Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
static	PATH ()
Protected Member Functions inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
	getPath ()
	makeDirectoryFor (string $path)
Protected Attributes inherited from ILIAS\Setup\Artifact\BuildArtifactObjective
const	ARTIFACTS = __DIR__ . "/../../../../../artifacts"

Detailed Description

Definition at line 30 of file PushNotificationObjective.php.

Constructor & Destructor Documentation

__construct()

PushNotificationObjective::__construct	(	protected readonly array	$provider,
		protected readonly Config	$config
	)

Parameters

PushProviderInterface[]

$provider

Definition at line 35 of file PushNotificationObjective.php.

    {
    }

Member Function Documentation

achieve()

PushNotificationObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 56 of file PushNotificationObjective.php.

                                                     : Environment
    {
        if (!($this->config instanceof NullConfig)) {
            $settings = $environment->getResource(Environment::RESOURCE_SETTINGS_FACTORY)->settingsFor('notifications');
 
            $private_key_path = $this->config->getPrivateKeyPath();
            if (file_exists($private_key_path)) {
                $settings->set('private_key_path', $private_key_path);
 
                $details = openssl_pkey_get_details(openssl_pkey_get_private('file://' . $private_key_path))['ec'];
                $settings->set(
                    'application_server_key',
                    str_replace(
                        ['+', '/', '='],
                        ['-', '_', ''],
                        base64_encode(hex2bin('04') . $details['x'] . $details['y'])
                    )
                );
            } else {
                throw new InvalidArgumentException('Notification key path is invalid!');
            }
        }
 
        return parent::achieve($environment);
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

build()

PushNotificationObjective::build

(

)

Build the artifact based.

If you want to use the environment reimplement buildIn instead.

Reimplemented from ILIAS\Setup\Artifact\BuildArtifactObjective.

Definition at line 39 of file PushNotificationObjective.php.

                           : Artifact
    {
        return new ArrayArtifact(array_map(fn($p) => $p::class, $this->provider));
    }

getArtifactName()

PushNotificationObjective::getArtifactName

(

)

Get the filename where the builder wants to put its artifact.

This is understood to be a path relative to the ILIAS root directory.

Reimplemented from ILIAS\Setup\Artifact\BuildArtifactObjective.

Definition at line 51 of file PushNotificationObjective.php.

                                     : string
    {
        return 'push_providers';
    }

getPreconditions()

PushNotificationObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 44 of file PushNotificationObjective.php.

                                                              : array
    {
        return [
            new ilSettingsFactoryExistsObjective(),
        ];
    }

---

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

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