ilExportZipBuiltObjective Class Reference

Inheritance diagram for ilExportZipBuiltObjective:

Collaboration diagram for ilExportZipBuiltObjective:

Public Member Functions
	__construct (Setup\Config $config)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	createTempDir ()
Public Member Functions inherited from ilSetupObjective
	__construct (Setup\Config $config)

Protected Member Functions
	deleteDirRecursive (string $path)

Protected Attributes
const	FILENAME = "ILIAS_EXPORT.zip"
string	$cwd
Protected Attributes inherited from ilSetupObjective
Setup Config	$config

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilExportZipBuiltObjective::__construct

(

Setup\Config

$config

)

Definition at line 30 of file class.ilExportZipBuiltObjective.php.

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

    {
        parent::__construct($config);
        $this->tmp_dir = $this->createTempDir();
        if (is_null($this->tmp_dir)) {
            throw new RuntimeException("Can't create temporary directory!");
        }
        if(! array_key_exists('PWD', $_SERVER)) {
            throw new RuntimeException("Can't get to current directory. \nIf you ran the script using 'sudo', please try using 'sudo -s'");
        }
        $this->cwd = $_SERVER["PWD"];
    }

Here is the call graph for this function:

Member Function Documentation

achieve()

ilExportZipBuiltObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 100 of file class.ilExportZipBuiltObjective.php.

References deleteDirRecursive(), ilExportMetadataGatheredObjective\EXPORT_META, and ILIAS\Setup\Environment\getConfigFor().

                                                           : Setup\Environment
    {
        $meta = $environment->getConfigFor(ilExportMetadataGatheredObjective::EXPORT_META);
        file_put_contents($this->tmp_dir . "/meta.txt", implode("\n", $meta) . "\n", FILE_APPEND);

        // This will be recreated during import with new data for the imported instance.
        $this->deleteDirRecursive($this->tmp_dir . "/web_data/default/client.ini.php");

        $this->addFolderToZip($this->tmp_dir . "/web_data", $this->tmp_dir . "/web_data.zip");
        $this->addFolderToZip($this->tmp_dir . "/Customizing", $this->tmp_dir . "/Customizing.zip");
        $this->addFolderToZip($this->tmp_dir . "/public/data", $this->tmp_dir . "/data.zip");
        $this->addFolderToZip($this->tmp_dir . "/dump", $this->tmp_dir . "/dump.zip");

        $this->deleteDirRecursive($this->tmp_dir . "/web_data");
        $this->deleteDirRecursive($this->tmp_dir . "/Customizing");
        $this->deleteDirRecursive($this->tmp_dir . "/public/data");
        $this->deleteDirRecursive($this->tmp_dir . "/dump");

        $this->addFolderToZip($this->tmp_dir, $this->cwd . "/" . self::FILENAME);

        $this->deleteDirRecursive($this->tmp_dir);

        return $environment;
    }

Here is the call graph for this function:

createTempDir()

ilExportZipBuiltObjective::createTempDir

(

)

Definition at line 188 of file class.ilExportZipBuiltObjective.php.

References $path.

Referenced by __construct().

                                   : ?string
    {
        $path = rtrim(sys_get_temp_dir(), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . mt_rand() . microtime(true);
        if (mkdir($path)) {
            return $path;
        }
        return null;
    }

Here is the caller graph for this function:

deleteDirRecursive()

ilExportZipBuiltObjective::deleteDirRecursive ( string  $path )

protected

Definition at line 165 of file class.ilExportZipBuiltObjective.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());
        }

        rmdir($path);
    }

Here is the caller graph for this function:

getHash()

ilExportZipBuiltObjective::getHash

(

)

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

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

getLabel()

ilExportZipBuiltObjective::getLabel

(

)

Definition at line 54 of file class.ilExportZipBuiltObjective.php.

                              : string
    {
        return "Export ILIAS to $this->cwd/" . self::FILENAME;
    }

getPreconditions()

ilExportZipBuiltObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 70 of file class.ilExportZipBuiltObjective.php.

                                                                    : array
    {
        $dumper = new MysqlIfsnopDumper($this->config->getExportHooksPath());

        return [
            new ilExportMetadataGatheredObjective(),
            new Setup\ObjectiveCollection(
                "",
                false,
                new ObjectiveWithPreconditions(
                    new ilFileSystemClientDirectoryRenamedObjective(
                        $this->tmp_dir . "/public/data/"
                    ),
                    new ilFileSystemDirectoryCopiedRecursivelyObjective("", $this->tmp_dir . "/public/data", true)
                ),
                new ObjectiveWithPreconditions(
                    new ilFileSystemClientDirectoryRenamedObjective(
                        $this->tmp_dir . "/web_data/"
                    ),
                    new ilFileSystemDirectoryCopiedRecursivelyObjective("public/data", $this->tmp_dir . "/web_data"),
                ),
            ),
            new ilFileSystemDirectoryCopiedRecursivelyObjective("Customizing", $this->tmp_dir . "/Customizing"),
            new ilDatabaseDumpedToDirectoryObjective($this->tmp_dir . "/dump", $dumper)
        ];
    }

isApplicable()

ilExportZipBuiltObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 128 of file class.ilExportZipBuiltObjective.php.

                                                                : bool
    {
        return is_writable($this->cwd);
    }

isNotable()

ilExportZipBuiltObjective::isNotable

(

)

Definition at line 62 of file class.ilExportZipBuiltObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$cwd

string ilExportZipBuiltObjective::$cwd

protected

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

FILENAME

const ilExportZipBuiltObjective::FILENAME = "ILIAS_EXPORT.zip"

protected

Definition at line 26 of file class.ilExportZipBuiltObjective.php.

---

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

• components/ILIAS/setup_/classes/class.ilExportZipBuiltObjective.php