PHPExcel_Shared_ZipArchive Class Reference

Collaboration diagram for PHPExcel_Shared_ZipArchive:

Public Member Functions
	open ($fileName)
	Open a new zip archive. More...
	close ()
	Close this zip archive. More...
	addFromString ($localname, $contents)
	Add a new file to the zip archive from a string of raw data. More...
	locateName ($fileName)
	Find if given fileName exist in archive (Emulate ZipArchive locateName()) More...
	getFromName ($fileName)
	Extract file from archive by given fileName (Emulate ZipArchive getFromName()) More...

Data Fields
const	OVERWRITE = 'OVERWRITE'
	constants More...
const	CREATE = 'CREATE'

Private Attributes
	$_tempDir
	$_zip

Detailed Description

Definition at line 41 of file ZipArchive.php.

Member Function Documentation

addFromString()

PHPExcel_Shared_ZipArchive::addFromString	(		$localname,
			$contents
	)

Add a new file to the zip archive from a string of raw data.

Parameters

string	$localname	Directory/Name of the file to add to the zip archive
string	$contents	String of data to add to the zip archive

Definition at line 95 of file ZipArchive.php.

        {
                $filenameParts = pathinfo($localname);
 
                $handle = fopen($this->_tempDir.'/'.$filenameParts["basename"], "wb");
                fwrite($handle, $contents);
                fclose($handle);
 
                $res = $this->_zip->add($this->_tempDir.'/'.$filenameParts["basename"],
                                                                PCLZIP_OPT_REMOVE_PATH, $this->_tempDir,
                                                                PCLZIP_OPT_ADD_PATH, $filenameParts["dirname"]
                                                           );
                if ($res == 0) {
                        throw new PHPExcel_Writer_Exception("Error zipping files : " . $this->_zip->errorInfo(true));
                }
 
                unlink($this->_tempDir.'/'.$filenameParts["basename"]);
        }

References $contents, $res, PCLZIP_OPT_ADD_PATH, and PCLZIP_OPT_REMOVE_PATH.

close()

PHPExcel_Shared_ZipArchive::close

(

)

Close this zip archive.

Definition at line 84 of file ZipArchive.php.

        {
        }

getFromName()

PHPExcel_Shared_ZipArchive::getFromName

(

$fileName

)

Extract file from archive by given fileName (Emulate ZipArchive getFromName())

Parameters

string

$fileName

Filename for the file in zip archive

Returns

string $contents File string contents

Definition at line 141 of file ZipArchive.php.

    {
        $list = $this->_zip->listContent();
        $listCount = count($list);
        $list_index = -1;
        for ($i = 0; $i < $listCount; ++$i) {
            if (strtolower($list[$i]["filename"]) == strtolower($fileName) ||
                strtolower($list[$i]["stored_filename"]) == strtolower($fileName)) {
                $list_index = $i;
                break;
            }
        }
 
        $extracted = "";
        if ($list_index != -1) {
            $extracted = $this->_zip->extractByIndex($list_index, PCLZIP_OPT_EXTRACT_AS_STRING);
        } else {
            $filename = substr($fileName, 1);
            $list_index = -1;
            for ($i = 0; $i < $listCount; ++$i) {
                if (strtolower($list[$i]["filename"]) == strtolower($fileName) || 
                    strtolower($list[$i]["stored_filename"]) == strtolower($fileName)) {
                    $list_index = $i;
                    break;
                }
            }
            $extracted = $this->_zip->extractByIndex($list_index, PCLZIP_OPT_EXTRACT_AS_STRING);
        }
        if ((is_array($extracted)) && ($extracted != 0)) {
            $contents = $extracted[0]["content"];
        }
 
        return $contents;
    }

References $contents, $filename, and PCLZIP_OPT_EXTRACT_AS_STRING.

locateName()

PHPExcel_Shared_ZipArchive::locateName

(

$fileName

)

Find if given fileName exist in archive (Emulate ZipArchive locateName())

Parameters

string

$fileName

Filename for the file in zip archive

Returns

boolean

Definition at line 120 of file ZipArchive.php.

    {
        $list = $this->_zip->listContent();
        $listCount = count($list);
        $list_index = -1;
        for ($i = 0; $i < $listCount; ++$i) {
            if (strtolower($list[$i]["filename"]) == strtolower($fileName) ||
                strtolower($list[$i]["stored_filename"]) == strtolower($fileName)) {
                $list_index = $i;
                break;
            }
        }
        return ($list_index > -1);
    }

open()

PHPExcel_Shared_ZipArchive::open

(

$fileName

)

Open a new zip archive.

Parameters

string

$fileName

Filename for the zip archive

Returns

boolean

Definition at line 70 of file ZipArchive.php.

        {
                $this->_tempDir = PHPExcel_Shared_File::sys_get_temp_dir();
 
                $this->_zip = new PclZip($fileName);
 
                return true;
        }

References PHPExcel_Shared_File\sys_get_temp_dir().

Here is the call graph for this function:

Field Documentation

$_tempDir

PHPExcel_Shared_ZipArchive::$_tempDir

private

Definition at line 54 of file ZipArchive.php.

$_zip

PHPExcel_Shared_ZipArchive::$_zip

private

Definition at line 61 of file ZipArchive.php.

CREATE

const PHPExcel_Shared_ZipArchive::CREATE = 'CREATE'

Definition at line 46 of file ZipArchive.php.

OVERWRITE

const PHPExcel_Shared_ZipArchive::OVERWRITE = 'OVERWRITE'

constants

Definition at line 45 of file ZipArchive.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/ZipArchive.php