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)

Data Fields
const	DATADIR = 1

const	WEBDIR = 2

Protected Member Functions
	buildPath (Setup\Environment $environment)

Protected Attributes
string	$component_dir

int	$base_location

Private Member Functions
	checkEnvironment (Setup\Environment $environment)

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ilFileSystemComponentDataDirectoryCreatedObjective::achieve ( Setup\Environment $environment )

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

References buildPath(), and checkEnvironment().

                                                            : Setup\Environment
     {
         if (!$this->checkEnvironment($environment)) {
             throw new Setup\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 ( Setup\Environment $environment )

protected

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

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

Referenced by achieve(), and isApplicable().

                                                                 : string
     {
         $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
         $client_id = $environment->getResource(Setup\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 caller graph for this function:

◆ checkEnvironment()

ilFileSystemComponentDataDirectoryCreatedObjective::checkEnvironment ( Setup\Environment $environment )

private

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

Referenced by achieve(), and isApplicable().

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

Here is the caller graph for this function:

◆ getHash()

ilFileSystemComponentDataDirectoryCreatedObjective::getHash ( )

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

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

◆ getPreconditions()

ilFileSystemComponentDataDirectoryCreatedObjective::getPreconditions ( Setup\Environment $environment )

Returns: []|[]

Definition at line 67 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()
         ];
     }

◆ isApplicable()

ilFileSystemComponentDataDirectoryCreatedObjective::isApplicable ( Setup\Environment $environment )

Definition at line 95 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);
     }