eZPublish  4.4
eZForwardCompressionHandler Class Reference

Handles files compressed with gzip. More...

+ Inheritance diagram for eZForwardCompressionHandler:
+ Collaboration diagram for eZForwardCompressionHandler:

Public Member Functions

 compress ($source)
 
 decompress ($source)
 
 doClose ()
 
 doEOF ()
 
 doFlush ()
 
 doOpen ($filename, $mode)
 
 doPasstrough ($closeFile=true)
 
 doRead ($uncompressedLength=false)
 
 doRewind ()
 
 doSeek ($offset, $whence)
 
 doTell ()
 
 doWrite ($data, $uncompressedLength=false)
 
 duplicate ()
 
 error ()
 
 errorNumber ()
 
 errorString ()
 
 eZForwardCompressionHandler (&$handler, $name, $identifier)
 
forwardHandler ()
 
- Public Member Functions inherited from eZCompressionHandler
 eZCompressionHandler ($handlerIdentifier, $handlerName)
 
- Public Member Functions inherited from eZFileHandler
 close ()
 
 doRewind ()
 
 duplicate ()
 
 eof ()
 
 error ()
 
 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 ()
 
 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)
 
static unlink ($filename=false)
 
- Public Attributes inherited from eZFileHandler
 $FileName
 
 $IsBinary
 
 $IsOpen
 
 $Mode
 
 $Name
 

Detailed Description

Handles files compressed with gzip.

This class is a wrapper of the eZGZIPZLIBCompressionHandler and eZGZIPShellCompressionHandler classes.

Member Function Documentation

eZForwardCompressionHandler::compress (   $source)
virtual

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

Implements eZCompressionHandler.

eZForwardCompressionHandler::decompress (   $source)
virtual

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

Implements eZCompressionHandler.

eZForwardCompressionHandler::doClose ( )
virtual

Does the actual file closing.

See Also
close

Implements eZFileHandler.

eZForwardCompressionHandler::doEOF ( )
virtual

Does the actual file eof detection.

See Also
eof

Implements eZFileHandler.

eZForwardCompressionHandler::doFlush ( )
virtual

Does the actual file flushing.

See Also
flush

Implements eZFileHandler.

eZForwardCompressionHandler::doOpen (   $filename,
  $mode 
)
virtual

Does the actual file opening.

See Also
open

Implements eZFileHandler.

eZForwardCompressionHandler::doPasstrough (   $closeFile = true)
virtual

Does the actual file passtrough.

See Also
eof

Implements eZFileHandler.

eZForwardCompressionHandler::doRead (   $length = false)
virtual

Does the actual file reading.

See Also
read

Implements eZFileHandler.

eZForwardCompressionHandler::doRewind ( )
eZForwardCompressionHandler::doSeek (   $offset,
  $whence 
)
virtual

Does the actual file seek.

See Also
seek

Implements eZFileHandler.

eZForwardCompressionHandler::doTell ( )
virtual

Does the actual file telling.

See Also
tell

Implements eZFileHandler.

eZForwardCompressionHandler::doWrite (   $data,
  $length = false 
)
virtual

Does the actual file writing.

See Also
write

Implements eZFileHandler.

eZForwardCompressionHandler::duplicate ( )

Duplicates the forward compression handler by calling duplicate() on the handler which gets the forwarded requests and then creates a new eZForwardCompressionHandler.

eZForwardCompressionHandler::error ( )
eZForwardCompressionHandler::errorNumber ( )
virtual
Returns
the error number from the last error that occured.

Implements eZFileHandler.

eZForwardCompressionHandler::errorString ( )
virtual
Returns
the error string from the last error that occured.

Implements eZFileHandler.

eZForwardCompressionHandler::eZForwardCompressionHandler ( $handler,
  $name,
  $identifier 
)
& eZForwardCompressionHandler::forwardHandler ( )
Returns
the current handler which all requests are forwarded to.

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