UnzipOptions.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Filesystem\Util\Archive;
 
final class UnzipOptions extends Options
{
    public const UNLIMITED = 0;
 
    public const DEFAULT_MAX_COMPRESSION_RATIO = 100;
 
    public const DEFAULT_RATIO_CHECK_MIN_UNCOMPRESSED_SIZE = 33554432; // 32 MiB
 
    public const DEFAULT_MAX_AMOUNT_OF_ENTRIES = 100000;
 
    public const DEFAULT_MAX_UNCOMPRESSED_SIZE = 4294967296; // 4 GiB
 
    protected ?string $zip_output_path = null;
    private bool $flat = false;
    private bool $overwrite = false;
    private int $max_compression_ratio = self::DEFAULT_MAX_COMPRESSION_RATIO;
    private int $ratio_check_min_uncompressed_size = self::DEFAULT_RATIO_CHECK_MIN_UNCOMPRESSED_SIZE;
    private int $max_amount_of_entries = self::DEFAULT_MAX_AMOUNT_OF_ENTRIES;
    private int $max_uncompressed_size = self::DEFAULT_MAX_UNCOMPRESSED_SIZE;
 
    public function getZipOutputPath(): ?string
    {
        return $this->zip_output_path;
    }
 
    public function withZipOutputPath(string $zip_output_path): self
    {
        $clone = clone $this;
        $clone->zip_output_path = $zip_output_path;
        return $clone;
    }
 
    public function isOverwrite(): bool
    {
        return $this->overwrite;
    }
 
    public function withOverwrite(bool $overwrite): self
    {
        $clone = clone $this;
        $clone->overwrite = $overwrite;
        return $clone;
    }
 
    public function getMaxCompressionRatio(): int
    {
        return $this->max_compression_ratio;
    }
 
    public function withMaxCompressionRatio(int $max_compression_ratio): self
    {
        $clone = clone $this;
        $clone->max_compression_ratio = max(self::UNLIMITED, $max_compression_ratio);
        return $clone;
    }
 
    public function getRatioCheckMinUncompressedSize(): int
    {
        return $this->ratio_check_min_uncompressed_size;
    }
 
    public function withRatioCheckMinUncompressedSize(int $ratio_check_min_uncompressed_size): self
    {
        $clone = clone $this;
        $clone->ratio_check_min_uncompressed_size = max(0, $ratio_check_min_uncompressed_size);
        return $clone;
    }
 
    public function getMaxAmountOfEntries(): int
    {
        return $this->max_amount_of_entries;
    }
 
    public function withMaxAmountOfEntries(int $max_amount_of_entries): self
    {
        $clone = clone $this;
        $clone->max_amount_of_entries = max(self::UNLIMITED, $max_amount_of_entries);
        return $clone;
    }
 
    public function getMaxUncompressedSize(): int
    {
        return $this->max_uncompressed_size;
    }
 
    public function withMaxUncompressedSize(int $max_uncompressed_size): self
    {
        $clone = clone $this;
        $clone->max_uncompressed_size = max(self::UNLIMITED, $max_uncompressed_size);
        return $clone;
    }
 
}