ILIAS\Filesystem\Util\Archive\Archives Class Reference

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

Public Member Functions
	__construct ()
	zip (array $file_streams, ?ZipOptions $zip_options=null)
	unzip (FileStream $zip, ?UnzipOptions $unzip_options=null)
	unzipOptions ()
	zipOptions ()

Protected Member Functions
	mergeZipOptions (?ZipOptions $zip_options)
	mergeUnzipOptions (?UnzipOptions $unzip_options)

Private Attributes
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

This class is used to create a zip archive from a list of file-streams. In most cases this will be used inside other Services such as the Filesystem Service or the IRSS.

Definition at line 32 of file Archives.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Util\Archive\Archives::__construct

(

)

Definition at line 39 of file Archives.php.

References ILIAS\Filesystem\Util\Archive\Archives\unzipOptions(), and ILIAS\Filesystem\Util\Archive\Archives\zipOptions().

    {
        $this->zip_options = $this->zipOptions();
        $this->unzip_options = $this->unzipOptions();
    }

Here is the call graph for this function:

Member Function Documentation

mergeUnzipOptions()

ILIAS\Filesystem\Util\Archive\Archives::mergeUnzipOptions ( ?UnzipOptions  $unzip_options )

protected

Definition at line 86 of file Archives.php.

References ILIAS\Filesystem\Util\Archive\Archives\$unzip_options, ILIAS\Filesystem\Util\Archive\Options\getDirectoryHandling(), ILIAS\Filesystem\Util\Archive\UnzipOptions\getZipOutputPath(), ILIAS\Filesystem\Util\Archive\UnzipOptions\isOverwrite(), null, and ILIAS\Filesystem\Util\Archive\UnzipOptions\withZipOutputPath().

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

                                                                      : 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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mergeZipOptions()

ILIAS\Filesystem\Util\Archive\Archives::mergeZipOptions ( ?ZipOptions  $zip_options )

protected

Definition at line 75 of file Archives.php.

References ILIAS\Filesystem\Util\Archive\Archives\$zip_options, ILIAS\Filesystem\Util\Archive\Options\getDirectoryHandling(), ILIAS\Filesystem\Util\Archive\ZipOptions\getZipOutputName(), ILIAS\Filesystem\Util\Archive\ZipOptions\getZipOutputPath(), null, and ILIAS\Filesystem\Util\Archive\ZipOptions\withZipOutputName().

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

                                                                : 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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unzip()

ILIAS\Filesystem\Util\Archive\Archives::unzip	(	FileStream	$zip,
		?UnzipOptions	$unzip_options = null
	)

Definition at line 57 of file Archives.php.

References ILIAS\Filesystem\Util\Archive\Archives\mergeUnzipOptions().

                                                                               : Unzip
    {
        return new Unzip(
            $this->mergeUnzipOptions($unzip_options),
            $zip
        );
    }

Here is the call graph for this function:

unzipOptions()

ILIAS\Filesystem\Util\Archive\Archives::unzipOptions

(

)

Definition at line 65 of file Archives.php.

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

                                  : UnzipOptions
    {
        return new UnzipOptions();
    }

Here is the caller graph for this function:

zip()

ILIAS\Filesystem\Util\Archive\Archives::zip	(	array	$file_streams,
		?ZipOptions	$zip_options = null
	)

Definition at line 45 of file Archives.php.

References ILIAS\Filesystem\Util\Archive\Zip\DOT_EMPTY, and ILIAS\Filesystem\Util\Archive\Archives\mergeZipOptions().

                                                                             : Zip
    {
        if (empty($file_streams)) {
            $file_streams = [Zip::DOT_EMPTY => Streams::ofString('')];
        }

        return new Zip(
            $this->mergeZipOptions($zip_options),
            ...$file_streams
        );
    }

Here is the call graph for this function:

zipOptions()

ILIAS\Filesystem\Util\Archive\Archives::zipOptions

(

)

Definition at line 70 of file Archives.php.

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

                                : ZipOptions
    {
        return new ZipOptions();
    }

Here is the caller graph for this function:

Field Documentation

$unzip_options

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

private

Definition at line 37 of file Archives.php.

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

$zip_options

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

private

Definition at line 36 of file Archives.php.

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

---

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

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