eZ Publish  [trunk]
eZForwardCompressionHandler Class Reference

Handles files compressed with gzip. More...

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

List of all members.

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 ()

Detailed Description

Handles files compressed with gzip.

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

Definition at line 19 of file ezforwardcompressionhandler.php.


Member Function Documentation

eZForwardCompressionHandler::compress ( source) [virtual]

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

Implements eZCompressionHandler.

Definition at line 89 of file ezforwardcompressionhandler.php.

eZForwardCompressionHandler::decompress ( source) [virtual]

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

Implements eZCompressionHandler.

Definition at line 94 of file ezforwardcompressionhandler.php.

Does the actual file closing.

See also:
close

Implements eZFileHandler.

Definition at line 44 of file ezforwardcompressionhandler.php.

Does the actual file eof detection.

See also:
eof

Implements eZFileHandler.

Definition at line 79 of file ezforwardcompressionhandler.php.

Does the actual file flushing.

See also:
flush

Implements eZFileHandler.

Definition at line 59 of file ezforwardcompressionhandler.php.

eZForwardCompressionHandler::doOpen ( filename,
mode 
) [virtual]

Does the actual file opening.

See also:
open

Implements eZFileHandler.

Definition at line 39 of file ezforwardcompressionhandler.php.

eZForwardCompressionHandler::doPasstrough ( closeFile = true) [virtual]

Does the actual file passtrough.

See also:
eof

Implements eZFileHandler.

Definition at line 84 of file ezforwardcompressionhandler.php.

eZForwardCompressionHandler::doRead ( length = false) [virtual]

Does the actual file reading.

See also:
read

Implements eZFileHandler.

Definition at line 49 of file ezforwardcompressionhandler.php.

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 69 of file ezforwardcompressionhandler.php.

eZForwardCompressionHandler::doSeek ( offset,
whence 
) [virtual]

Does the actual file seek.

See also:
seek

Implements eZFileHandler.

Definition at line 64 of file ezforwardcompressionhandler.php.

Does the actual file telling.

See also:
tell

Implements eZFileHandler.

Definition at line 74 of file ezforwardcompressionhandler.php.

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

Does the actual file writing.

See also:
write

Implements eZFileHandler.

Definition at line 54 of file ezforwardcompressionhandler.php.

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

Reimplemented from eZFileHandler.

Definition at line 118 of file ezforwardcompressionhandler.php.

Returns error data as an associative array, the array contains:

Reimplemented from eZFileHandler.

Definition at line 99 of file ezforwardcompressionhandler.php.

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

Implements eZFileHandler.

Definition at line 109 of file ezforwardcompressionhandler.php.

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

Implements eZFileHandler.

Definition at line 104 of file ezforwardcompressionhandler.php.

Returns:
the current handler which all requests are forwarded to.

Definition at line 34 of file ezforwardcompressionhandler.php.


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