eZGZIPZLIBCompressionHandler Class Reference

Handles files compressed with gzip using the zlib extension. More...

Inheritance diagram for eZGZIPZLIBCompressionHandler:

Collaboration diagram for eZGZIPZLIBCompressionHandler:

List of all members.

Public Member Functions
	compress ($source)
	compressionLevel ()
	decompress ($source)
	doClose ()
	doEOF ()
	doFlush ()
	doOpen ($filename, $mode)
	doPasstrough ($closeFile=true)
	doRead ($uncompressedLength=false)
	doRewind ()
	doSeek ($offset, $whence)
	doTell ()
	doWrite ($data, $uncompressedLength=false)
	errorNumber ()
	errorString ()
	eZGZIPZLIBCompressionHandler ()
	setCompressionLevel ($level)
Static Public Member Functions
static	isAvailable ()
Public Attributes
	$File
	File pointer, returned by gzopen.
	$Level
	The compression level.

---

Detailed Description

Handles files compressed with gzip using the zlib extension.

More information on the zlib extension can be found here: http://www.php.net/manual/en/ref.zlib.php

Definition at line 42 of file ezgzipzlibcompressionhandler.php.

---

Member Function Documentation

eZGZIPZLIBCompressionHandler::compress

(

$

source

)

[virtual]

Compress the $source string and return it as compressed data.

Implements eZCompressionHandler.

Definition at line 159 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::compressionLevel

(

)

Returns:

the current compression level which is a number between 0 and 9, or false if the default is to be used.

Definition at line 65 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::decompress

(

$

source

)

[virtual]

Decompress the $source string containing compressed data and return it as a string.

Implements eZCompressionHandler.

Definition at line 164 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doClose

(

)

[virtual]

Does the actual file closing.

See also:

close

Implements eZFileHandler.

Definition at line 91 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doEOF

(

)

[virtual]

Does the actual file eof detection.

See also:

eof

Implements eZFileHandler.

Definition at line 141 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doFlush

(

)

[virtual]

Does the actual file flushing.

See also:

flush

Implements eZFileHandler.

Definition at line 111 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doOpen	(	$	filename,
		$	mode
	)		[virtual]

Does the actual file opening.

See also:

open

Implements eZFileHandler.

Definition at line 85 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doPasstrough

(

$

closeFile = true

)

[virtual]

Does the actual file passtrough.

See also:

eof

Implements eZFileHandler.

Definition at line 146 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doRead

(

$

length = false

)

[virtual]

Does the actual file reading.

See also:

read

Implements eZFileHandler.

Definition at line 98 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doRewind

(

)

Does the actual file rewind.

See also:

rewind

Note:

Default implementation calls seek with offset set to 0 from the file start.

Reimplemented from eZFileHandler.

Definition at line 131 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doSeek	(	$	offset,
		$	whence
	)		[virtual]

Does the actual file seek.

See also:

seek

Implements eZFileHandler.

Definition at line 116 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doTell

(

)

[virtual]

Does the actual file telling.

See also:

tell

Implements eZFileHandler.

Definition at line 136 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doWrite	(	$	data,
		$	length = false
	)		[virtual]

Does the actual file writing.

See also:

write

Implements eZFileHandler.

Definition at line 103 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::errorNumber

(

)

[virtual]

Returns:

the error number from the last error that occured.

Implements eZFileHandler.

Definition at line 174 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::errorString

(

)

[virtual]

Returns:

the error string from the last error that occured.

Implements eZFileHandler.

Definition at line 169 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::eZGZIPZLIBCompressionHandler

(

)

Definition at line 44 of file ezgzipzlibcompressionhandler.php.

static eZGZIPZLIBCompressionHandler::isAvailable

(

)

[static]

Returns:

true if this handler can be used. This function checks if the zlib extension is available.

Reimplemented from eZFileHandler.

Definition at line 74 of file ezgzipzlibcompressionhandler.php.

Referenced by eZGZIPCompressionHandler\eZGZIPCompressionHandler().

eZGZIPZLIBCompressionHandler::setCompressionLevel

(

$

level

)

Sets the current compression level.

Definition at line 54 of file ezgzipzlibcompressionhandler.php.

---

Member Data Documentation

eZGZIPZLIBCompressionHandler::$File

File pointer, returned by gzopen.

Definition at line 181 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::$Level

The compression level.

Definition at line 183 of file ezgzipzlibcompressionhandler.php.

---

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

• ezgzipzlibcompressionhandler.php