Inheritance diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

Collaboration diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

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

	getHash ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Data Fields
const	DATADIR = 1

const	WEBDIR = 2

Protected Member Functions
	buildPath (Setup\Environment $environment)

Protected Attributes
string	$component_dir

int	$base_location

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ilFileSystemComponentDataDirectoryCreatedObjective::achieve ( Setup\Environment $environment )

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

                                                           : Setup\Environment
    {
        $this->path = $this->buildPath($environment);
        return parent::achieve($environment);
    }

References buildPath().

Here is the call graph for this function:

◆ buildPath()

ilFileSystemComponentDataDirectoryCreatedObjective::buildPath ( Setup\Environment $environment )

protected

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

                                                                : ?string
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
 
        if ($ini === null || $client_id === null) {
            return null;
        }
 
        if ($this->base_location === self::DATADIR) {
            $data_dir = $ini->readVariable('clients', 'datadir');
        } elseif ($this->base_location === self::WEBDIR) {
            $data_dir = dirname(__DIR__, 4) . "/data";
        }
        if (!isset($data_dir)) {
            throw new LogicException('cannot determine base directory');
        }
 
        $client_data_dir = $data_dir . '/' . $client_id;
        $new_dir = $client_data_dir . '/' . $this->component_dir;
        return $new_dir;
    }

References $client_id, $component_dir, $data_dir, and $ini.

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

◆ getHash()

ilFileSystemComponentDataDirectoryCreatedObjective::getHash ( )

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

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

◆ getPreconditions()

ilFileSystemComponentDataDirectoryCreatedObjective::getPreconditions ( Setup\Environment $environment )

Returns: \ilFileSystemDirectoriesCreatedObjective[]|\ilIniFilesLoadedObjective[]

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

                                                                    : 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()
        ];
    }

References $config.

◆ isApplicable()

ilFileSystemComponentDataDirectoryCreatedObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

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

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