Inheritance diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

Collaboration diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

Public Member Functions
	__construct (string $component_dir, protected int $base_location=self::DATADIR)

	getHash ()
	Get a hash for this objective. More...

	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)

Data Fields
const	DATADIR = 1

const	WEBDIR = 2

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

Protected Member Functions
	buildPath (Environment $environment)

Protected Attributes
string	$component_dir

Protected Attributes inherited from ILIAS\Setup\Objective\DirectoryCreatedObjective
string	$path

int	$permissions

Private Member Functions
	checkEnvironment (Environment $environment)

Detailed Description

Definition at line 24 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemComponentDataDirectoryCreatedObjective::__construct	(	string	$component_dir,
		protected int	$base_location = `self::DATADIR`
	)

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

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

       {
         parent::__construct($component_dir);
 
         $this->component_dir = $component_dir;
     }

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ilFileSystemComponentDataDirectoryCreatedObjective::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 86 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

References buildPath(), and checkEnvironment().

                                                      : Environment
     {
         if (!$this->checkEnvironment($environment)) {
             throw new UnachievableException("Environment is not ready for this objective");
         }
         $this->path = $this->buildPath($environment);
         return parent::achieve($environment);
     }

Here is the call graph for this function:

◆ buildPath()

ilFileSystemComponentDataDirectoryCreatedObjective::buildPath ( Environment $environment )

protected

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

References $client_id, $component_dir, $data_dir, $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);
 
         if ($this->base_location === self::DATADIR) {
             $data_dir = $ini->readVariable('clients', 'datadir');
         } elseif ($this->base_location === self::WEBDIR) {
             $data_dir = dirname(__DIR__, 5) . "/public/data";
         }
         if (!isset($data_dir)) {
             throw new LogicException('cannot determine base directory');
         }
 
         $client_data_dir = $data_dir . '/' . $client_id;
 
         return $client_data_dir . '/' . $this->component_dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkEnvironment()

ilFileSystemComponentDataDirectoryCreatedObjective::checkEnvironment ( Environment $environment )

private

Definition at line 108 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

References ILIAS\Setup\Environment\getResource(), and null.

Referenced by achieve(), and isApplicable().

                                                                : bool
     {
         if (null === $environment->getResource(Environment::RESOURCE_ILIAS_INI)) {
             return false;
         }
         return null !== $environment->getResource(Environment::RESOURCE_CLIENT_ID);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHash()

ilFileSystemComponentDataDirectoryCreatedObjective::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 41 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

                              : string
     {
         return hash("sha256", self::class . "::" . $this->component_dir . $this->base_location);
     }

◆ getPreconditions()

ilFileSystemComponentDataDirectoryCreatedObjective::getPreconditions ( Environment $environment )

Returns: []|[]

Implements ILIAS\Setup\Objective.

Definition at line 69 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.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()

ilFileSystemComponentDataDirectoryCreatedObjective::isApplicable ( Environment $environment )

Implements ILIAS\Setup\Objective.

Definition at line 99 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

References buildPath(), and checkEnvironment().

                                                           : bool
     {
         if (!$this->checkEnvironment($environment)) {
             return false;
         }
         $this->path = $this->buildPath($environment);
         return parent::isApplicable($environment);
     }