Exponential 6.0.13 Exponential Enterprise Open Source CMS - PHP Class Reference

Public Member Functions | Public Attributes | List of all members
eZForwardCompressionHandler Class Reference

Handles files compressed with gzip. More...

Inheritance diagram for eZForwardCompressionHandler:

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

## Public Attributes
| $ForwardHandler
Public Attributes inherited from eZFileHandler
| $Identifier
| $FileHandler
| $Name
| $FileName
| $Mode
| $IsBinary
| $IsOpen

## Additional Inherited Members
Static Public Member Functions inherited from eZFileHandler
static | isAvailable ()
static | linkCopy ( $sourceFilename, $destinationFilename, $symbolicLink=true)
static | symlink ( $sourceFilename, $destinationFilename)
static | link ( $sourceFilename, $destinationFilename)
static | move ( $sourceFilename, $destinationFilename)
static | copy ( $sourceFilename, $destinationFilename)
static | doUnlink ( $filename)
static | doExists ( $filename)
static | doIsDirectory ( $filename)
static | doIsExecutable ( $filename)
static | doIsFile ( $filename)
static | doIsLink ( $filename)
static | doIsReadable ( $filename)
static | doIsWriteable ( $filename)
static | doStatistics ( $filename)
static | doRename ( $destinationFilename, $sourceFilename)
static | instance ( $identifier, $filename=false, $mode=false, $binaryFile=true)

## 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.

## Constructor & Destructor Documentation

## ◆ __construct()

eZForwardCompressionHandler::__construct | ( | & | $handler,
|  |  | $name,
|  |  | $identifier
| ) |  |

Constructor

Parameters

  bool | string | $handler |
  bool | string | $name |
  string | $identifier |

Definition at line 29 of file ezforwardcompressionhandler.php.

## Member Function Documentation

## ◆ compress()

eZForwardCompressionHandler::compress | ( |  | $source | ) |
| virtual

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

Implements eZCompressionHandler.

Definition at line 93 of file ezforwardcompressionhandler.php.

## ◆ decompress()

eZForwardCompressionHandler::decompress | ( |  | $source | ) |
| virtual

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

Implements eZCompressionHandler.

Definition at line 98 of file ezforwardcompressionhandler.php.

## ◆ doClose()

eZForwardCompressionHandler::doClose | ( |  | ) |
| virtual

Does the actual file closing.

See also
  close

Implements eZFileHandler.

Definition at line 48 of file ezforwardcompressionhandler.php.

## ◆ doEOF()

eZForwardCompressionHandler::doEOF | ( |  | ) |
| virtual

Does the actual file eof detection.

See also
  eof

Implements eZFileHandler.

Definition at line 83 of file ezforwardcompressionhandler.php.

## ◆ doFlush()

eZForwardCompressionHandler::doFlush | ( |  | ) |
| virtual

Does the actual file flushing.

See also
  flush

Implements eZFileHandler.

Definition at line 63 of file ezforwardcompressionhandler.php.

## ◆ doOpen()

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

Does the actual file opening.

See also
  open

Implements eZFileHandler.

Definition at line 43 of file ezforwardcompressionhandler.php.

## ◆ doPasstrough()

eZForwardCompressionHandler::doPasstrough | ( |  | $closeFile = `true` | ) |
| virtual

Does the actual file passtrough.

See also
  eof

Implements eZFileHandler.

Definition at line 88 of file ezforwardcompressionhandler.php.

## ◆ doRead()

eZForwardCompressionHandler::doRead | ( |  | $length = `false` | ) |
| virtual

Does the actual file reading.

See also
  read

Implements eZFileHandler.

Definition at line 53 of file ezforwardcompressionhandler.php.

## ◆ doRewind()

eZForwardCompressionHandler::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 73 of file ezforwardcompressionhandler.php.

## ◆ doSeek()

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

Does the actual file seek.

See also
  seek

Implements eZFileHandler.

Definition at line 68 of file ezforwardcompressionhandler.php.

## ◆ doTell()

eZForwardCompressionHandler::doTell | ( |  | ) |
| virtual

Does the actual file telling.

See also
  tell

Implements eZFileHandler.

Definition at line 78 of file ezforwardcompressionhandler.php.

## ◆ doWrite()

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

Does the actual file writing.

See also
  write

Implements eZFileHandler.

Definition at line 58 of file ezforwardcompressionhandler.php.

## ◆ duplicate()

eZForwardCompressionHandler::duplicate | ( |  | ) |

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

References eZFileHandler\identifier(), and eZFileHandler\name().

## ◆ error()

eZForwardCompressionHandler::error | ( |  | ) |

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

- string - The error string
- number - The error number
  Note
    The default implementation calls errorString() and errorNumber().

Reimplemented from eZFileHandler.

Definition at line 103 of file ezforwardcompressionhandler.php.

## ◆ errorNumber()

eZForwardCompressionHandler::errorNumber | ( |  | ) |
| virtual

Returns
  the error number from the last error that occured.

Implements eZFileHandler.

Definition at line 113 of file ezforwardcompressionhandler.php.

## ◆ errorString()

eZForwardCompressionHandler::errorString | ( |  | ) |
| virtual

Returns
  the error string from the last error that occured.

Implements eZFileHandler.

Definition at line 108 of file ezforwardcompressionhandler.php.

## ◆ forwardHandler()

& eZForwardCompressionHandler::forwardHandler | ( |  | ) |

Returns
  the current handler which all requests are forwarded to.

Definition at line 38 of file ezforwardcompressionhandler.php.

References $ForwardHandler.

## Member Data Documentation

## ◆ $ForwardHandler

eZForwardCompressionHandler::$ForwardHandler

Definition at line 21 of file ezforwardcompressionhandler.php.

Referenced by forwardHandler().

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

- ezforwardcompressionhandler.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.