ILIAS\FileDelivery\Setup\BaseDirObjective Class Reference

Inheritance diagram for ILIAS\FileDelivery\Setup\BaseDirObjective:

Collaboration diagram for ILIAS\FileDelivery\Setup\BaseDirObjective:

Public Member Functions
	getArtifactPath ()
	buildIn (Environment $env)
	getArtifactName ()
	build ()
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
Public Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
	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	get ()
Static Public Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
static	PATH ()

Data Fields
const	BASE_DIR = './src/FileDelivery/artifacts/base_dir.php'

Protected Attributes
array	$data = []

Additional Inherited Members
Protected Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
	getPath ()
	makeDirectoryFor (string $path)
Static Protected Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
static	saveName (string $name)

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 30 of file BaseDirObjective.php.

Member Function Documentation

build()

ILIAS\FileDelivery\Setup\BaseDirObjective::build

(

)

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 60 of file BaseDirObjective.php.

                           : Artifact
    {
        return new ArrayArtifact($this->data);
    }

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

Here is the caller graph for this function:

buildIn()

ILIAS\FileDelivery\Setup\BaseDirObjective::buildIn

(

Environment

$env

)

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 42 of file BaseDirObjective.php.

                                             : Artifact
    {
        $ilias_ini = $env->getResource(Environment::RESOURCE_ILIAS_INI);
        if ($ilias_ini instanceof \ilIniFile) {
            $base_dir = $ilias_ini->readVariable('clients', 'datadir');
            $client_id = $ilias_ini->readVariable('clients', 'default');
            if (!empty($base_dir) && !empty($client_id)) {
                $this->data['base_dir'] = rtrim(rtrim($base_dir, '/') . '/' . $client_id, '/') . '/';
            }
        }
        return $this->build();
    }

References ILIAS\$client_id, ILIAS\FileDelivery\Setup\BaseDirObjective\build(), ILIAS\Setup\Environment\getResource(), and ILIAS\Setup\Environment\RESOURCE_ILIAS_INI.

Here is the call graph for this function:

get()

static ILIAS\FileDelivery\Setup\BaseDirObjective::get ( )

static

Definition at line 73 of file BaseDirObjective.php.

                                : ?string
    {
        static $base;
 
        if ($base !== null) {
            return $base;
        }
 
        if (is_readable(self::PATH())) {
            $data = require self::PATH();
        }
 
        return $base = $data['base_dir'] ?? null;
    }

References ILIAS\FileDelivery\Setup\BaseDirObjective\$data, and ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\PATH().

Referenced by ILIAS\FileDelivery\Token\Signer\Payload\ShortFilePayload\__construct(), and ILIAS\FileDelivery\Token\Signer\Payload\ShortFilePayload\getUri().

Here is the call graph for this function:

Here is the caller graph for this function:

getArtifactName()

ILIAS\FileDelivery\Setup\BaseDirObjective::getArtifactName

(

)

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 55 of file BaseDirObjective.php.

                                     : string
    {
        return 'base_dir';
    }

getArtifactPath()

ILIAS\FileDelivery\Setup\BaseDirObjective::getArtifactPath

(

)

Definition at line 36 of file BaseDirObjective.php.

                                     : string
    {
        return self::BASE_DIR;
    }

References ILIAS\FileDelivery\Setup\BaseDirObjective\BASE_DIR.

getPreconditions()

ILIAS\FileDelivery\Setup\BaseDirObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 66 of file BaseDirObjective.php.

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

Field Documentation

$data

array ILIAS\FileDelivery\Setup\BaseDirObjective::$data = []

protected

Definition at line 34 of file BaseDirObjective.php.

Referenced by ILIAS\FileDelivery\Setup\BaseDirObjective\get().

BASE_DIR

const ILIAS\FileDelivery\Setup\BaseDirObjective::BASE_DIR = './src/FileDelivery/artifacts/base_dir.php'

Definition at line 32 of file BaseDirObjective.php.

Referenced by ILIAS\FileDelivery\Setup\BaseDirObjective\getArtifactPath().

---

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

• components/ILIAS/FileDelivery/src/Setup/BaseDirObjective.php