ilStorageContainersExistingObjective Class Reference

Class ilStorageContainersExistingObjective. More...

Inheritance diagram for ilStorageContainersExistingObjective:

Collaboration diagram for ilStorageContainersExistingObjective:

Public Member Functions
	__construct (?array $storage_handler_ids=null)
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective\DirectoryCreatedObjective
	__construct (string $path, int $permissions=self::DEFAULT_DIRECTORY_PERMISSIONS)
	getHash ()
	Uses hashed Path. More...
	getLabel ()
	Defaults to "Build $this->getArtifactPath()". More...
	isNotable ()
	Defaults to 'true'. More...
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)

Protected Member Functions
	buildStorageBasePath (Environment $environment)

Protected Attributes
string	$base_dir = StorageHandlerFactory::BASE_DIRECTORY
array	$storage_handler_ids
Protected Attributes inherited from ILIAS\Setup\Objective\DirectoryCreatedObjective
string	$path
int	$permissions

Additional Inherited Members
Data Fields inherited from ILIAS\Setup\Objective\DirectoryCreatedObjective
const	DEFAULT_DIRECTORY_PERMISSIONS = 0755

Detailed Description

Class ilStorageContainersExistingObjective.

Author

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

Definition at line 29 of file class.ilStorageContainersExistingObjective.php.

Constructor & Destructor Documentation

__construct()

ilStorageContainersExistingObjective::__construct

(

?array

$storage_handler_ids = null

)

Definition at line 40 of file class.ilStorageContainersExistingObjective.php.

References $storage_handler_ids, and ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct(StorageHandlerFactory::BASE_DIRECTORY);
        $this->storage_handler_ids = $storage_handler_ids ?? $this->storage_handler_ids;
    }

Here is the call graph for this function:

Member Function Documentation

achieve()

ilStorageContainersExistingObjective::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

Implements ILIAS\Setup\Objective.

Definition at line 77 of file class.ilStorageContainersExistingObjective.php.

References buildStorageBasePath().

                                                     : Environment
    {
        $base_path = $this->buildStorageBasePath($environment);
        $this->path = $base_path;
        $environment = parent::achieve($environment);

        foreach ($this->storage_handler_ids as $storage_handler_id) {
            $this->path = $base_path . '/' . $storage_handler_id;
            $environment = parent::achieve($environment);
        }
        return $environment;
    }

Here is the call graph for this function:

buildStorageBasePath()

ilStorageContainersExistingObjective::buildStorageBasePath ( Environment  $environment )

protected

Definition at line 46 of file class.ilStorageContainersExistingObjective.php.

References $base_dir, $client_id, $ini, and ILIAS\Setup\Environment\getResource().

Referenced by achieve(), and isApplicable().

                                                                     : string
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
        return $ini->readVariable(
            'clients',
            'datadir'
        ) . '/' . $client_id . '/' . $this->base_dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPreconditions()

ilStorageContainersExistingObjective::getPreconditions

(

Environment

$environment

)

Returns

[]|[]

Implements ILIAS\Setup\Objective.

Definition at line 60 of file class.ilStorageContainersExistingObjective.php.

References ILIAS\Setup\Environment\getConfigFor(), and ILIAS\Setup\Environment\hasConfigFor().

                                                              : array
    {
        // case if it is a fresh ILIAS installation
        if ($environment->hasConfigFor("filesystem")) {
            $config = $environment->getConfigFor("filesystem");
            return [
                new \ilFileSystemDirectoriesCreatedObjective($config)
            ];
        }

        // case if ILIAS is already installed
        return [
            new \ilIniFilesLoadedObjective()
        ];
    }

Here is the call graph for this function:

isApplicable()

ilStorageContainersExistingObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 94 of file class.ilStorageContainersExistingObjective.php.

References buildStorageBasePath().

                                                          : bool
    {
        $base_path = $this->buildStorageBasePath($environment);
        $this->path = $base_path;
        if (parent::isApplicable($environment)) {
            return true;
        }

        foreach ($this->storage_handler_ids as $storage_handler_id) {
            $this->path = $base_path . '/' . $storage_handler_id;
            if (parent::isApplicable($environment)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$base_dir

string ilStorageContainersExistingObjective::$base_dir = StorageHandlerFactory::BASE_DIRECTORY

protected

Definition at line 31 of file class.ilStorageContainersExistingObjective.php.

Referenced by buildStorageBasePath().

$storage_handler_ids

array ilStorageContainersExistingObjective::$storage_handler_ids

protected

Initial value:

= [
        'fsv2'
    ]

Definition at line 36 of file class.ilStorageContainersExistingObjective.php.

Referenced by __construct().

---

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

• components/ILIAS/ResourceStorage/classes/Setup/class.ilStorageContainersExistingObjective.php