ILIAS\Setup\CLI\ImportFileUnzippedFileObjective Class Reference

Inheritance diagram for ILIAS\Setup\CLI\ImportFileUnzippedFileObjective:

Collaboration diagram for ILIAS\Setup\CLI\ImportFileUnzippedFileObjective:

Public Member Functions
	__construct (string $zip_path)
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

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

Protected Attributes
string	$zip_path

Detailed Description

Definition at line 31 of file ImportFileUnzippedFileObjective.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::__construct

(

string

$zip_path

)

Definition at line 35 of file ImportFileUnzippedFileObjective.php.

References ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\$zip_path.

    {
        $this->zip_path = $zip_path;
    }

Member Function Documentation

achieve()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::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 62 of file ImportFileUnzippedFileObjective.php.

References ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\deleteRecursive(), ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\extractZip(), and ILIAS\Setup\Environment\getConfigFor().

                                                     : Environment
    {
        $tmp_dir = $environment->getConfigFor("tmp_dir");
        $dirs = [
            $tmp_dir . DIRECTORY_SEPARATOR . "web_data.zip" => $tmp_dir . DIRECTORY_SEPARATOR . "web_data",
            $tmp_dir . DIRECTORY_SEPARATOR . "Customizing.zip" => $tmp_dir . DIRECTORY_SEPARATOR . "Customizing",
            $tmp_dir . DIRECTORY_SEPARATOR . "data.zip" => $tmp_dir . DIRECTORY_SEPARATOR . "data",
            $tmp_dir . DIRECTORY_SEPARATOR . "dump.zip" => $tmp_dir
        ];

        $this->extractZip($this->zip_path, $tmp_dir);

        foreach ($dirs as $source => $destination) {
            if (!file_exists($source)) {
                continue;
            }

            $this->extractZip($source, $destination);

            $this->deleteRecursive($source);
        }

        return $environment;
    }

Here is the call graph for this function:

deleteRecursive()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::deleteRecursive ( string  $path, bool  $delete_base_dir = false  )

protected

Definition at line 92 of file ImportFileUnzippedFileObjective.php.

Referenced by ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\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:

extractZip()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::extractZip ( string  $source, string  $destination  )

protected

Definition at line 117 of file ImportFileUnzippedFileObjective.php.

References Vendor\Package\$e.

Referenced by ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\achieve().

                                                                      : void
    {
        $zip = new ZipArchive();
        try {
            $zip->open($source);
            $zip->extractTo($destination);
        } catch (\Exception $e) {
            throw new Setup\UnachievableException("Could not open zip at $source");
        } finally {
            $zip->close();
        }
    }

Here is the caller graph for this function:

getHash()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::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 40 of file ImportFileUnzippedFileObjective.php.

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

getLabel()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 45 of file ImportFileUnzippedFileObjective.php.

                              : string
    {
        return "Unzip files from $this->zip_path into temporary directory";
    }

getPreconditions()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 55 of file ImportFileUnzippedFileObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective()
        ];
    }

isApplicable()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::isApplicable

(

Environment

$environment

)

Get to know whether the objective is applicable.

Don't change the environment or cause changes on services in the environment. Just check if this objective needs to be achieved, either currently or at all. In case of doubt whether the objective is applicable or not return true.

Implements ILIAS\Setup\Objective.

Definition at line 87 of file ImportFileUnzippedFileObjective.php.

                                                          : bool
    {
        return file_exists($this->zip_path);
    }

isNotable()

ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 50 of file ImportFileUnzippedFileObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$zip_path

string ILIAS\Setup\CLI\ImportFileUnzippedFileObjective::$zip_path

protected

Definition at line 33 of file ImportFileUnzippedFileObjective.php.

Referenced by ILIAS\Setup\CLI\ImportFileUnzippedFileObjective\__construct().

---

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

• components/ILIAS/Setup/src/CLI/ImportFileUnzippedFileObjective.php