Archives.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;
 
final class Archives
{
    use PathHelper;
 
    private ZipOptions $zip_options;
    private UnzipOptions $unzip_options;
 
    public function __construct()
    {
        $this->zip_options = $this->zipOptions();
        $this->unzip_options = $this->unzipOptions();
    }
 
    public function zip(array $file_streams, ?ZipOptions $zip_options = null): Zip
    {
        if (empty($file_streams)) {
            $file_streams = [Zip::DOT_EMPTY => Streams::ofString('')];
        }
 
        return new Zip(
            $this->mergeZipOptions($zip_options),
            ...$file_streams
        );
    }
 
    public function unzip(FileStream $zip, ?UnzipOptions $unzip_options = null): Unzip
    {
        return new Unzip(
            $this->mergeUnzipOptions($unzip_options),
            $zip
        );
    }
 
    public function unzipOptions(): UnzipOptions
    {
        return new UnzipOptions();
    }
 
    public function zipOptions(): ZipOptions
    {
        return new ZipOptions();
    }
 
    protected function mergeZipOptions(?ZipOptions $zip_options): ZipOptions
    {
        if (null === $zip_options) {
            return $this->zip_options;
        }
        return $this->zip_options
            ->withZipOutputName($zip_options->getZipOutputName())
            ->withZipOutputPath($zip_options->getZipOutputPath())
            ->withDirectoryHandling($zip_options->getDirectoryHandling());
    }
 
    protected function mergeUnzipOptions(?UnzipOptions $unzip_options): UnzipOptions
    {
        if (null === $unzip_options) {
            return $this->unzip_options;
        }
        if ($unzip_options->getZipOutputPath() !== null) {
            $this->unzip_options = $this->unzip_options->withZipOutputPath($unzip_options->getZipOutputPath());
        }
 
        return $this->unzip_options
            ->withOverwrite($unzip_options->isOverwrite())
            ->withDirectoryHandling($unzip_options->getDirectoryHandling());
    }
}