ILIAS\Filesystem\Util\Archive\UnzipOptions Class Reference

Inheritance diagram for ILIAS\Filesystem\Util\Archive\UnzipOptions:

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

Public Member Functions
	getZipOutputPath ()
	withZipOutputPath (string $zip_output_path)
	isOverwrite ()
	withOverwrite (bool $overwrite)
Public Member Functions inherited from ILIAS\Filesystem\Util\Archive\Options
	getIgnoredPathSnippets ()
	@description like __MACOSX, will filter out all paths which contain one of those snippets More...
	withDirectoryHandling (ZipDirectoryHandling $top_dir_handling)
	getDirectoryHandling ()

Protected Attributes
string	$zip_output_path = null
Protected Attributes inherited from ILIAS\Filesystem\Util\Archive\Options
ZipDirectoryHandling	$top_directory_handling = ZipDirectoryHandling::KEEP_STRUCTURE

Private Attributes
bool	$flat = false
bool	$overwrite = false

Detailed Description

Author

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

Definition at line 26 of file UnzipOptions.php.

Member Function Documentation

getZipOutputPath()

ILIAS\Filesystem\Util\Archive\UnzipOptions::getZipOutputPath

(

)

Definition at line 32 of file UnzipOptions.php.

                                      : ?string
    {
        return $this->zip_output_path;
    }

References ILIAS\Filesystem\Util\Archive\UnzipOptions\$zip_output_path.

Referenced by ILIAS\Filesystem\Util\Archive\Archives\mergeUnzipOptions().

Here is the caller graph for this function:

isOverwrite()

ILIAS\Filesystem\Util\Archive\UnzipOptions::isOverwrite

(

)

Definition at line 44 of file UnzipOptions.php.

                                 : bool
    {
        return $this->overwrite;
    }

References ILIAS\Filesystem\Util\Archive\UnzipOptions\$overwrite.

Referenced by ILIAS\Filesystem\Util\Archive\Archives\mergeUnzipOptions().

Here is the caller graph for this function:

withOverwrite()

ILIAS\Filesystem\Util\Archive\UnzipOptions::withOverwrite

(

bool

$overwrite

)

Definition at line 49 of file UnzipOptions.php.

                                                  : self
    {
        $clone = clone $this;
        $clone->overwrite = $overwrite;
        return $clone;
    }

References ILIAS\Filesystem\Util\Archive\UnzipOptions\$overwrite.

withZipOutputPath()

ILIAS\Filesystem\Util\Archive\UnzipOptions::withZipOutputPath

(

string

$zip_output_path

)

Definition at line 37 of file UnzipOptions.php.

                                                              : self
    {
        $clone = clone $this;
        $clone->zip_output_path = $zip_output_path;
        return $clone;
    }

References ILIAS\Filesystem\Util\Archive\UnzipOptions\$zip_output_path.

Referenced by ILIAS\Filesystem\Util\Archive\Archives\mergeUnzipOptions().

Here is the caller graph for this function:

Field Documentation

$flat

bool ILIAS\Filesystem\Util\Archive\UnzipOptions::$flat = false

private

Definition at line 29 of file UnzipOptions.php.

$overwrite

bool ILIAS\Filesystem\Util\Archive\UnzipOptions::$overwrite = false

private

Definition at line 30 of file UnzipOptions.php.

Referenced by ILIAS\Filesystem\Util\Archive\UnzipOptions\isOverwrite(), and ILIAS\Filesystem\Util\Archive\UnzipOptions\withOverwrite().

$zip_output_path

string ILIAS\Filesystem\Util\Archive\UnzipOptions::$zip_output_path = null

protected

Definition at line 28 of file UnzipOptions.php.

Referenced by ILIAS\Filesystem\Util\Archive\UnzipOptions\getZipOutputPath(), and ILIAS\Filesystem\Util\Archive\UnzipOptions\withZipOutputPath().

---

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

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