Zip Class Reference

Inheritance diagram for Zip:

Public Member Functions
	__construct ()
	pack ($source, $destination)
	unpack ($source, $destination)
Public Member Functions inherited from AbstractArchive
	getFilename ($source, $withExtension=false)

Additional Inherited Members
Protected Member Functions inherited from AbstractArchive
	_writeFile ($destination, $data)
	_readFile ($source)

Detailed Description

Zip compressed file archive.

Definition at line 12 of file Zip.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Exceptions

Definition at line 17 of file Zip.php.

    {
        $type = 'Zip';
        if (!class_exists('\ZipArchive')) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('\'%1\' file extension is not supported', [$type])
            );
        }
    }

Member Function Documentation

pack()

pack	(		$source,
			$destination
	)

Pack file.

Parameters

string	$source
string	$destination

Returns

string

Implements ArchiveInterface.

Definition at line 35 of file Zip.php.

    {
        $zip = new \ZipArchive();
        $zip->open($destination, \ZipArchive::CREATE);
        $zip->addFile($source);
        $zip->close();
        return $destination;
    }

unpack()

unpack	(		$source,
			$destination
	)

Unpack file.

Parameters

string	$source
string	$destination

Returns

string

Implements ArchiveInterface.

Definition at line 52 of file Zip.php.

    {
        $zip = new \ZipArchive();
        if ($zip->open($source) === true) {
            $filename = $this->filterRelativePaths($zip->getNameIndex(0) ?: '');
            if ($filename) {
                $zip->extractTo(dirname($destination), $filename);
                rename(dirname($destination).'/'.$filename, $destination);
            } else {
                $destination = '';
            }
            $zip->close();
        } else {
            $destination = '';
        }

        return $destination;
    }

---

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

• vendor/magento/framework/Archive/Zip.php