Inheritance diagram for ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective:

Collaboration diagram for ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective:

Public Member Functions
	getArtifactName ()

	build ()

	buildIn (Environment $env)

	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...

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

	achieve (Environment $environment)
	Objectives can be achieved. More...

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

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

Static Public Member Functions
static	PATH ()

Protected Member Functions
	getPath ()

	makeDirectoryFor (string $path)

Static Protected Member Functions
static	saveName (string $name)

Detailed Description

Definition at line 30 of file BuildStaticConfigStoredObjective.php.

Member Function Documentation

◆ achieve()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::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 77 of file BuildStaticConfigStoredObjective.php.

                                                     : Environment
    {
        $artifact = $this->buildIn($environment);
 
        $path = $this->getPath();
 
        $this->makeDirectoryFor($path);
 
        file_put_contents($path, $artifact->serialize());
 
        return $environment;
    }

References $path, ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\buildIn(), ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getPath(), and ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\makeDirectoryFor().

Here is the call graph for this function:

◆ build()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::build ( )

abstract

Reimplemented in ILIAS\FileDelivery\Setup\BaseDirObjective, and ILIAS\FileDelivery\Setup\DeliveryMethodObjective.

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\buildIn().

Here is the caller graph for this function:

◆ buildIn()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::buildIn ( Environment $env )

Reimplemented in ILIAS\FileDelivery\Setup\BaseDirObjective.

Definition at line 47 of file BuildStaticConfigStoredObjective.php.

                                             : Artifact
    {
        return $this->build();
    }

References ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\build().

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArtifactName()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::getArtifactName ( )

abstract

Reimplemented in ILIAS\FileDelivery\Setup\BaseDirObjective, ILIAS\FileDelivery\Setup\DeliveryMethodObjective, and ILIAS\FileDelivery\Setup\KeyRotationObjective.

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getHash(), ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getLabel(), and ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\PATH().

Here is the caller graph for this function:

◆ getHash()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::getHash ( )

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 57 of file BuildStaticConfigStoredObjective.php.

                             : string
    {
        return hash("sha256", $this->getArtifactName());
    }

References ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getArtifactName().

Here is the call graph for this function:

◆ getLabel()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::getLabel ( )

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 62 of file BuildStaticConfigStoredObjective.php.

                              : string
    {
        return 'Build ' . $this->getArtifactName() . ' Static Config';
    }

References ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getArtifactName().

Here is the call graph for this function:

◆ getPath()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::getPath ( )

finalprotected

Definition at line 72 of file BuildStaticConfigStoredObjective.php.

                                      : string
    {
        return static::PATH();
    }

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\achieve().

Here is the caller graph for this function:

◆ getPreconditions()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::getPreconditions ( Environment $environment )

Objectives might depend on other objectives.

Exceptions

UnachievableException if the objective is not achievable

Returns: Objective[]

Implements ILIAS\Setup\Objective.

Reimplemented in ILIAS\FileDelivery\Setup\BaseDirObjective.

Definition at line 52 of file BuildStaticConfigStoredObjective.php.

◆ isApplicable()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::isApplicable ( Environment $environment )

Get to know whether the objective is applicable.

Don't change the environment or cause changes on services in the environment. Just check if this objective needs to be achieved, either currently or at all. In case of doubt whether the objective is applicable or not return true.

Implements ILIAS\Setup\Objective.

Reimplemented in ILIAS\FileDelivery\Setup\DeliveryMethodObjective.

Definition at line 90 of file BuildStaticConfigStoredObjective.php.

                                                          : bool
    {
        return true;
    }

◆ isNotable()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::isNotable ( )

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 67 of file BuildStaticConfigStoredObjective.php.

                               : bool
    {
        return true;
    }

◆ makeDirectoryFor()

ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::makeDirectoryFor ( string $path )

protected

Definition at line 95 of file BuildStaticConfigStoredObjective.php.

                                                     : void
    {
        $dir = pathinfo($path)["dirname"];
        if (!file_exists($dir) && (!mkdir($dir, 0755, true) && !is_dir($dir))) {
            throw new \RuntimeException(sprintf('Directory "%s" was not created', $dir));
        }
    }

References $path.

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\achieve().

Here is the caller graph for this function:

◆ PATH()

static ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::PATH ( )

staticfinal

Definition at line 37 of file BuildStaticConfigStoredObjective.php.

                                       : string
    {
        return realpath(__DIR__ . '/../../../../../public/data/')
            . '/' . self::saveName((new static())->getArtifactName()) . ".php";
    }

References ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\getArtifactName(), and ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\saveName().

Referenced by ILIAS\FileDelivery\Setup\BaseDirObjective\get(), and ILIAS\FileDelivery\Init\init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveName()

static ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective::saveName ( string $name )

staticprotected

Definition at line 32 of file BuildStaticConfigStoredObjective.php.

                                                    : string
    {
        return strtolower((string) preg_replace('/[^a-zA-Z0-9_]/', '_', $name));
    }

Referenced by ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\PATH().

Here is the caller graph for this function:

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

components/ILIAS/FileDelivery/src/Setup/BuildStaticConfigStoredObjective.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ achieve()

◆ build()

◆ buildIn()

◆ getArtifactName()

◆ getHash()

◆ getLabel()

◆ getPath()

◆ getPreconditions()

◆ isApplicable()

◆ isNotable()

◆ makeDirectoryFor()

◆ PATH()

◆ saveName()