PHPExcel_Shared_ZipStreamWrapper Class Reference

Collaboration diagram for PHPExcel_Shared_ZipStreamWrapper:

Public Member Functions
	stream_open ($path, $mode, $options, &$opened_path)
	Implements support for fopen(). More...
	statName ()
	Implements support for fstat(). More...
	url_stat ()
	Implements support for fstat(). More...
	stream_stat ()
	Implements support for fstat(). More...
	stream_read ($count)
	Implements support for fread(), fgets() etc. More...
	stream_tell ()
	Returns the position of the file pointer, i.e. More...
	stream_eof ()
	EOF stream. More...
	stream_seek ($offset, $whence)
	Seek stream. More...

Static Public Member Functions
static	register ()
	Register wrapper. More...

Private Attributes
	$_archive
	$_fileNameInArchive = ''
	$_position = 0
	$_data = ''

Detailed Description

Definition at line 36 of file ZipStreamWrapper.php.

Member Function Documentation

register()

static PHPExcel_Shared_ZipStreamWrapper::register ( )

static

Register wrapper.

Definition at line 68 of file ZipStreamWrapper.php.

                                      {
                @stream_wrapper_unregister("zip");
                @stream_wrapper_register("zip", __CLASS__);
    }

statName()

PHPExcel_Shared_ZipStreamWrapper::statName

(

)

Implements support for fstat().

Returns

boolean

Definition at line 108 of file ZipStreamWrapper.php.

                               {
        return $this->_fileNameInArchive;
    }

References $_fileNameInArchive.

Referenced by url_stat().

Here is the caller graph for this function:

stream_eof()

PHPExcel_Shared_ZipStreamWrapper::stream_eof

(

)

EOF stream.

@return     bool

Definition at line 157 of file ZipStreamWrapper.php.

                                 {
        return $this->_position >= strlen($this->_data);
    }

stream_open()

PHPExcel_Shared_ZipStreamWrapper::stream_open	(		$path,
			$mode,
			$options,
		&	$opened_path
	)

Implements support for fopen().

Parameters

string	$path	resource name including scheme, e.g.
string	$mode	only "r" is supported
int	$options	mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH
string	&$openedPath	absolute path of the opened stream (out parameter)

Returns

bool true on success

Definition at line 82 of file ZipStreamWrapper.php.

                                                                       {
        // Check for mode
        if ($mode{0} != 'r') {
            throw new PHPExcel_Reader_Exception('Mode ' . $mode . ' is not supported. Only read mode is supported.');
        }
 
                $pos = strrpos($path, '#');
                $url['host'] = substr($path, 6, $pos - 6); // 6: strlen('zip://')
                $url['fragment'] = substr($path, $pos + 1);
 
        // Open archive
        $this->_archive = new ZipArchive();
        $this->_archive->open($url['host']);
 
        $this->_fileNameInArchive = $url['fragment'];
        $this->_position = 0;
        $this->_data = $this->_archive->getFromName( $this->_fileNameInArchive );
 
        return true;
    }

References $path, and $url.

stream_read()

PHPExcel_Shared_ZipStreamWrapper::stream_read

(

$count

)

Implements support for fread(), fgets() etc.

Parameters

int

$count

maximum number of bytes to read

Returns

string

Definition at line 136 of file ZipStreamWrapper.php.

                                 {
        $ret = substr($this->_data, $this->_position, $count);
        $this->_position += strlen($ret);
        return $ret;
    }

References $ret.

stream_seek()

PHPExcel_Shared_ZipStreamWrapper::stream_seek	(		$offset,
			$whence
	)

Seek stream.

@param      int             $offset byte offset
@param      int             $whence SEEK_SET, SEEK_CUR or SEEK_END
@return     bool

Definition at line 168 of file ZipStreamWrapper.php.

                                                  {
        switch ($whence) {
            case SEEK_SET:
                if ($offset < strlen($this->_data) && $offset >= 0) {
                     $this->_position = $offset;
                     return true;
                } else {
                     return false;
                }
                break;
 
            case SEEK_CUR:
                if ($offset >= 0) {
                     $this->_position += $offset;
                     return true;
                } else {
                     return false;
                }
                break;
 
            case SEEK_END:
                if (strlen($this->_data) + $offset >= 0) {
                     $this->_position = strlen($this->_data) + $offset;
                     return true;
                } else {
                     return false;
                }
                break;
 
            default:
                return false;
        }
    }

stream_stat()

PHPExcel_Shared_ZipStreamWrapper::stream_stat

(

)

Implements support for fstat().

Returns

boolean

Definition at line 126 of file ZipStreamWrapper.php.

                                  {
        return $this->_archive->statName( $this->_fileNameInArchive );
    }

stream_tell()

PHPExcel_Shared_ZipStreamWrapper::stream_tell

(

)

Returns the position of the file pointer, i.e.

its offset into the file stream. Implements support for ftell().

Returns

int

Definition at line 148 of file ZipStreamWrapper.php.

                                  {
        return $this->_position;
    }

References $_position.

url_stat()

PHPExcel_Shared_ZipStreamWrapper::url_stat

(

)

Implements support for fstat().

Returns

boolean

Definition at line 117 of file ZipStreamWrapper.php.

                               {
        return $this->statName( $this->_fileNameInArchive );
    }

References statName().

Here is the call graph for this function:

Field Documentation

$_archive

PHPExcel_Shared_ZipStreamWrapper::$_archive

private

Definition at line 42 of file ZipStreamWrapper.php.

$_data

PHPExcel_Shared_ZipStreamWrapper::$_data = ''

private

Definition at line 63 of file ZipStreamWrapper.php.

$_fileNameInArchive

PHPExcel_Shared_ZipStreamWrapper::$_fileNameInArchive = ''

private

Definition at line 49 of file ZipStreamWrapper.php.

Referenced by statName().

$_position

PHPExcel_Shared_ZipStreamWrapper::$_position = 0

private

Definition at line 56 of file ZipStreamWrapper.php.

Referenced by stream_tell().

---

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

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