Inheritance diagram for ilFileSystemDirectoriesCreatedObjective:

Collaboration diagram for ilFileSystemDirectoriesCreatedObjective:

Public Member Functions
	__construct (\ilFileSystemSetupConfig $config)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)

Protected Member Functions
	deleteRecursive (string $path, bool $delete_base_dir=false)

Protected Attributes
ilFileSystemSetupConfig	$config

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemDirectoriesCreatedObjective::__construct ( \ilFileSystemSetupConfig $config )

Definition at line 28 of file class.ilFileSystemDirectoriesCreatedObjective.php.

References $config.

       {
         $this->config = $config;
     }

Member Function Documentation

◆ achieve()

ilFileSystemDirectoriesCreatedObjective::achieve ( Setup\Environment $environment )

Definition at line 109 of file class.ilFileSystemDirectoriesCreatedObjective.php.

References $ini, and deleteRecursive().

                                                            : Setup\Environment
     {
         $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
         $ini->setVariable("clients", "datadir", $this->config->getDataDir());
         if (!$ini->write()) {
             throw new Setup\UnachievableException("Could not write ilias.ini.php");
         }
 
         if ($environment->hasConfigFor("tmp_dir")) {
             $tmp_dir = $environment->getConfigFor("tmp_dir");
             if (!is_null($tmp_dir)) {
                 $this->deleteRecursive($tmp_dir, true);
             }
         }
 
         return $environment;
     }

Here is the call graph for this function:

◆ deleteRecursive()

ilFileSystemDirectoriesCreatedObjective::deleteRecursive	(	string	$path,
		bool	$delete_base_dir = `false`
	)

protected

Definition at line 142 of file class.ilFileSystemDirectoriesCreatedObjective.php.

Referenced by achieve().

                                                                                    : void
     {
         if (is_file($path)) {
             unlink($path);
             return;
         }
 
         $files = new RecursiveIteratorIterator(
             new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
             RecursiveIteratorIterator::CHILD_FIRST
         );
 
         foreach ($files as $file_info) {
             if ($file_info->isDir()) {
                 rmdir($file_info->getRealPath());
                 continue;
             }
             unlink($file_info->getRealPath());
         }
 
         if ($delete_base_dir) {
             rmdir($path);
         }
     }

Here is the caller graph for this function:

◆ getHash()

ilFileSystemDirectoriesCreatedObjective::getHash ( )

Definition at line 34 of file class.ilFileSystemDirectoriesCreatedObjective.php.

                              : string
     {
         return hash("sha256", self::class);
     }

◆ getLabel()

ilFileSystemDirectoriesCreatedObjective::getLabel ( )

Definition at line 39 of file class.ilFileSystemDirectoriesCreatedObjective.php.

                               : string
     {
         return "ILIAS directories are created";
     }

◆ getPreconditions()

ilFileSystemDirectoriesCreatedObjective::getPreconditions ( Setup\Environment $environment )

Returns: []|[]

Definition at line 52 of file class.ilFileSystemDirectoriesCreatedObjective.php.

References $client_id, and $data_dir.

                                                                     : array
     {
         $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
         $data_dir = $this->config->getDataDir();
         $web_dir = dirname(__DIR__, 4) . "/data";
         $root = dirname(__DIR__, 4);
 
         $client_data_dir = $data_dir . '/' . $client_id;
         $client_web_dir = $web_dir . '/' . $client_id;
 
         $web_dir_objective = new Setup\Objective\DirectoryCreatedObjective($client_web_dir);
         $data_dir_objective = new Setup\Objective\DirectoryCreatedObjective($client_data_dir);
         $customizing_dir_objective = new Setup\Objective\NullObjective();
 
         if ($environment->hasConfigFor(Setup\CLI\InstallCommand::IMPORT)) {
             $tmp_dir = $environment->getConfigFor("tmp_dir");
 
             $web_dir_objective = new ObjectiveWithPreconditions(
                 new ilFileSystemClientDirectoryRenamedObjective(
                     $web_dir
                 ),
                 new ilFileSystemDirectoryCopiedRecursivelyObjective(
                     $tmp_dir . DIRECTORY_SEPARATOR . "web_data",
                     $web_dir,
                     false,
                     true
                 )
             );
             $data_dir_objective = new ObjectiveWithPreconditions(
                 new ilFileSystemClientDirectoryRenamedObjective(
                     $data_dir
                 ),
                 new ilFileSystemDirectoryCopiedRecursivelyObjective(
                     $tmp_dir . DIRECTORY_SEPARATOR . "data",
                     $data_dir,
                     false,
                     true
                 )
             );
             $customizing_dir_objective = new ilFileSystemDirectoryCopiedRecursivelyObjective(
                 $tmp_dir . DIRECTORY_SEPARATOR . "Customizing",
                 $root . "/Customizing",
                 false,
                 true
             );
         }
 
         return [
             new ilIniFilesPopulatedObjective(),
             new Setup\Objective\DirectoryCreatedObjective($data_dir),
             new Setup\Objective\DirectoryCreatedObjective($web_dir),
             $web_dir_objective,
             $data_dir_objective,
             $customizing_dir_objective
         ];
     }

◆ isApplicable()

ilFileSystemDirectoriesCreatedObjective::isApplicable ( Setup\Environment $environment )

Definition at line 131 of file class.ilFileSystemDirectoriesCreatedObjective.php.

References $ini.

                                                                 : bool
     {
         if ($environment->hasConfigFor(Setup\CLI\InstallCommand::IMPORT)) {
             return true;
         }
 
         $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
 
         return $ini->readVariable("clients", "datadir") !== $this->config->getDataDir();
     }

◆ isNotable()

ilFileSystemDirectoriesCreatedObjective::isNotable ( )

Definition at line 44 of file class.ilFileSystemDirectoriesCreatedObjective.php.

                                : bool
     {
         return true;
     }

Field Documentation

◆ $config

ilFileSystemSetupConfig ilFileSystemDirectoriesCreatedObjective::$config