LegacyArchives.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Filesystem\Util\Archive;

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\ResourceStorage\StorageHandler\StorageHandlerFactory;

final class LegacyArchives
{
    use PathHelper;

    private Archives $archives;
    private ZipOptions $zip_options;
    private UnzipOptions $unzip_options;

    public function __construct()
    {
        $this->archives = new Archives();
        $this->zip_options = $this->archives->zipOptions();
        $this->unzip_options = $this->archives->unzipOptions();
    }

    public function zip(
        string $directory_to_zip,
        string $path_to_output_zip,
        bool $ensure_top_directory = false
    ): 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;
    }

    public function unzip(
        string $path_to_zip,
        string $extract_to_path = null,
        bool $overwrite = false,
        bool $flat = false,
        bool $ensure_top_directory = false
    ): 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();
    }
}