ILIAS\Filesystem\Util\Archive\LegacyArchives Class Reference

Collaboration diagram for ILIAS\Filesystem\Util\Archive\LegacyArchives:

Public Member Functions
	__construct ()
	zip (string $directory_to_zip, string $path_to_output_zip, bool $ensure_top_directory=false)
	unzip (string $path_to_zip, ?string $extract_to_path=null, bool $overwrite=false, bool $flat=false, bool $ensure_top_directory=false)

Private Attributes
Archives	$archives
ZipOptions	$zip_options
UnzipOptions	$unzip_options

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Deprecated:

This class is deprecated and will be removed with ILIAS 10. Please use the Archives implementation instead. LegacyArchives can be used to zip individual files or directories and extract a zip file to a specified location. We should do without these possibilities as soon as possible, but for the moment very many places in ILIAS use such functionalities.

Definition at line 33 of file LegacyArchives.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Util\Archive\LegacyArchives::__construct

(

)

Definition at line 41 of file LegacyArchives.php.

References CLIENT_ID, and ILIAS_DATA_DIR.

    {
        $this->archives = new Archives();
        if (defined('ILIAS_DATA_DIR') && defined('CLIENT_ID')) {
            $base_temp_path = \ILIAS_DATA_DIR . '/' . \CLIENT_ID . '/temp';
        } else {
            $base_temp_path = sys_get_temp_dir();
        }

        $this->zip_options = $this->archives->zipOptions();
        $this->zip_options = $this->zip_options
            ->withZipOutputPath($base_temp_path);
        $this->unzip_options = $this->archives->unzipOptions();
    }

Member Function Documentation

unzip()

ILIAS\Filesystem\Util\Archive\LegacyArchives::unzip	(	string	$path_to_zip,
		?string	$extract_to_path = null,
		bool	$overwrite = false,
		bool	$flat = false,
		bool	$ensure_top_directory = false
	)

Deprecated:

Use ::unzip() instead.

Will be removed in ILIAS 10.

Definition at line 84 of file LegacyArchives.php.

References ILIAS\Filesystem\Util\Archive\FLAT_STRUCTURE.

     : bool {
        $extract_to_path ??= dirname($path_to_zip);
        if ($flat) {
            $dir_handling = ZipDirectoryHandling::FLAT_STRUCTURE;
        } else {
            $dir_handling = $ensure_top_directory ? ZipDirectoryHandling::ENSURE_SINGLE_TOP_DIR : ZipDirectoryHandling::KEEP_STRUCTURE;
        }

        $unzip = $this->archives->unzip(
            Streams::ofResource(fopen($path_to_zip, 'rb')),
            $this->unzip_options
                ->withZipOutputPath($extract_to_path)
                ->withOverwrite($overwrite)
                ->withDirectoryHandling($dir_handling)
        );
        return $unzip->extract();
    }

zip()

ILIAS\Filesystem\Util\Archive\LegacyArchives::zip	(	string	$directory_to_zip,
		string	$path_to_output_zip,
		bool	$ensure_top_directory = false
	)

Deprecated:

Use ::zip() instead.

Will be removed in ILIAS 10.

Definition at line 59 of file LegacyArchives.php.

     : bool {
        $directory_to_zip = $this->normalizePath($directory_to_zip);
        $path_to_output_zip = $this->normalizePath($path_to_output_zip);

        $zip = $this->archives->zip(
            [],
            $this->zip_options
                ->withZipOutputPath(dirname($path_to_output_zip))
                ->withZipOutputName(basename($path_to_output_zip))
                ->withDirectoryHandling($ensure_top_directory ? ZipDirectoryHandling::ENSURE_SINGLE_TOP_DIR : ZipDirectoryHandling::KEEP_STRUCTURE)
        );

        $zip->addDirectory($directory_to_zip);
        $zip_stream = $zip->get();

        return $zip_stream->getSize() > 0;
    }

Field Documentation

$archives

Archives ILIAS\Filesystem\Util\Archive\LegacyArchives::$archives

private

Definition at line 37 of file LegacyArchives.php.

$unzip_options

UnzipOptions ILIAS\Filesystem\Util\Archive\LegacyArchives::$unzip_options

private

Definition at line 39 of file LegacyArchives.php.

$zip_options

ZipOptions ILIAS\Filesystem\Util\Archive\LegacyArchives::$zip_options

private

Definition at line 38 of file LegacyArchives.php.

---

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

• components/ILIAS/Filesystem/src/Util/Archive/LegacyArchives.php