eZCompressionHandler Class Reference

Interface for file handlers using compression. More...

Inheritance diagram for eZCompressionHandler:

Collaboration diagram for eZCompressionHandler:

Public Member Functions
	compress ($source)
	decompress ($source)
	eZCompressionHandler ($handlerIdentifier, $handlerName)
Public Member Functions inherited from eZFileHandler
	close ()
	doClose ()
	doEOF ()
	doFlush ()
	doOpen ($filename, $mode)
	doPasstrough ($closeFile=true)
	doRead ($length=false)
	doRewind ()
	doSeek ($offset, $whence)
	doTell ()
	doWrite ($data, $length=false)
	duplicate ()
	eof ()
	error ()
	errorNumber ()
	errorString ()
	exists ($filename=false)
	eZFileHandler ($handlerIdentifier=false, $handlerName=false)
	filename ()
	flush ()
	identifier ()
	isBinaryMode ()
	isDirectory ($filename=false)
	isExecutable ($filename=false)
	isFile ($filename=false)
	isLink ($filename=false)
	isOpen ()
	isReadable ($filename=false)
	isWriteable ($filename=false)
	mode ()
	name ()
	open ($filename, $mode, $binaryFile=true)
	passtrough ($closeFile=true)
	read ($length=false)
	rename ($destinationFilename, $sourceFilename=false)
	rewind ()
	seek ($offset, $whence=SEEK_SET)
	statistics ($filename=false)
	tell ()
	unlink ($filename=false)
	write ($data, $length=false)

Additional Inherited Members
Static Public Member Functions inherited from eZFileHandler
static	copy ($sourceFilename, $destinationFilename)
static	doExists ($filename)
static	doIsDirectory ($filename)
static	doIsExecutable ($filename)
static	doIsFile ($filename)
static	doIsLink ($filename)
static	doIsReadable ($filename)
static	doIsWriteable ($filename)
static	doRename ($destinationFilename, $sourceFilename)
static	doStatistics ($filename)
static	doUnlink ($filename)
static	instance ($identifier, $filename=false, $mode=false, $binaryFile=true)
	Returns a shared instance of the eZFileHandler class. More...
static	isAvailable ()
static	link ($sourceFilename, $destinationFilename)
static	linkCopy ($sourceFilename, $destinationFilename, $symbolicLink=true)
static	move ($sourceFilename, $destinationFilename)
static	symlink ($sourceFilename, $destinationFilename)
Public Attributes inherited from eZFileHandler
	$FileName
	$IsBinary
	$IsOpen
	$Mode
	$Name

Detailed Description

Interface for file handlers using compression.

Generic interface for all file handlers using compression.

This class introduces two new functions from the eZFileHandler base class, they are compress() and decompress() and are used for string based compression.

Creating specific handlers

The compressor handlers must inherit from this class and reimplement some virtual functions.

For dealing with compressed strings the following functions must be reimplemented. compress() and decompress()

The handlers must also implement the virtual functions defined in eZFileHandler.

Member Function Documentation

eZCompressionHandler::compress (   $source )

pure virtual

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

Implemented in eZGZIPZLIBCompressionHandler, eZGZIPShellCompressionHandler, eZForwardCompressionHandler, and eZBZIP2Handler.

eZCompressionHandler::decompress (   $source )

pure virtual

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

Implemented in eZGZIPZLIBCompressionHandler, eZGZIPShellCompressionHandler, eZForwardCompressionHandler, and eZBZIP2Handler.

eZCompressionHandler::eZCompressionHandler	(		$handlerIdentifier,
			$handlerName
	)

Initializes the handler. Optionally the parameters $filename and $mode may be provided to automatically open the file.

Referenced by eZBZIP2Handler\eZBZIP2Handler(), eZForwardCompressionHandler\eZForwardCompressionHandler(), eZGZIPShellCompressionHandler\eZGZIPShellCompressionHandler(), eZGZIPZLIBCompressionHandler\eZGZIPZLIBCompressionHandler(), and eZNoCompressionHandler\eZNoCompressionHandler().

---

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

• ezcompressionhandler.php