eZ Publish: eZGZIPZLIBCompressionHandler Class Reference

eZ Publish [trunk]

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 19 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 135 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 42 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 140 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doClose ( ) [virtual]

Does the actual file closing.

See also:: close

Implements eZFileHandler.

Definition at line 68 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doEOF ( ) [virtual]

Does the actual file eof detection.

See also:: eof

Implements eZFileHandler.

Definition at line 117 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doFlush ( ) [virtual]

Does the actual file flushing.

See also:: flush

Implements eZFileHandler.

Definition at line 88 of file ezgzipzlibcompressionhandler.php.

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

Does the actual file opening.

See also:: open

Implements eZFileHandler.

Definition at line 62 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doPasstrough ( $ closeFile = true ) [virtual]

Does the actual file passtrough.

See also:: eof

Implements eZFileHandler.

Definition at line 122 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doRead ( $ length = false ) [virtual]

Does the actual file reading.

See also:: read

Implements eZFileHandler.

Definition at line 75 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 107 of file ezgzipzlibcompressionhandler.php.

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

Does the actual file seek.

See also:: seek

Implements eZFileHandler.

Definition at line 93 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::doTell ( ) [virtual]

Does the actual file telling.

See also:: tell

Implements eZFileHandler.

Definition at line 112 of file ezgzipzlibcompressionhandler.php.

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

Does the actual file writing.

See also:: write

Implements eZFileHandler.

Definition at line 80 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::errorNumber ( ) [virtual]

Returns:: the error number from the last error that occured.

Implements eZFileHandler.

Definition at line 150 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::errorString ( ) [virtual]

Returns:: the error string from the last error that occured.

Implements eZFileHandler.

Definition at line 145 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::eZGZIPZLIBCompressionHandler ( )

Definition at line 21 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 51 of file ezgzipzlibcompressionhandler.php.

Referenced by eZGZIPCompressionHandler\eZGZIPCompressionHandler().

eZGZIPZLIBCompressionHandler::setCompressionLevel ( $ level )

Sets the current compression level.

Definition at line 31 of file ezgzipzlibcompressionhandler.php.

Member Data Documentation

eZGZIPZLIBCompressionHandler::$File

File pointer, returned by gzopen.

Definition at line 157 of file ezgzipzlibcompressionhandler.php.

eZGZIPZLIBCompressionHandler::$Level

The compression level.

Definition at line 159 of file ezgzipzlibcompressionhandler.php.

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

ezgzipzlibcompressionhandler.php

eZGZIPZLIBCompressionHandler