eZPublish  3.9
eZGZIPZLIBCompressionHandler Class Reference

Handles files compressed with gzip using the zlib extension. More...

+ Inheritance diagram for eZGZIPZLIBCompressionHandler:
+ Collaboration diagram for eZGZIPZLIBCompressionHandler:

Public Member Functions

 compress ($source)
 
 compressionLevel ()
 
 decompress ($source)
 
 doClose ()
 
 doEOF ()
 
 doFlush ()
 
 doOpen ($filename, $mode)
 
 doPasstrough ($closeFile)
 
 doRead ($uncompressedLength=false)
 
 doRewind ()
 
 doSeek ($offset, $whence)
 
 doTell ()
 
 doWrite ($data, $uncompressedLength=false)
 
 errorNumber ()
 
 errorString ()
 
 eZGZIPZLIBCompressionHandler ()
 
 isAvailable ()
 
 setCompressionLevel ($level)
 
- Public Member Functions inherited from eZCompressionHandler
 eZCompressionHandler ($handlerIdentifier, $handlerName)
 
- Public Member Functions inherited from eZFileHandler
 close ()
 
 copy ($sourceFilename, $destinationFilename)
 
 doExists ($filename)
 
 doIsDirectory ($filename)
 
 doIsExecutable ($filename)
 
 doIsFile ($filename)
 
 doIsLink ($filename)
 
 doIsReadable ($filename)
 
 doIsWriteable ($filename)
 
 doRename ($destinationFilename, $sourceFilename)
 
 doRewind ()
 
 doStatistics ($filename)
 
 doUnlink ($filename)
 
duplicate ()
 
 eof ()
 
 error ()
 
 exists ($filename=false)
 
 eZFileHandler ($handlerIdentifier=false, $handlerName=false)
 
 filename ()
 
 flush ()
 
 identifier ()
 
instance ($identifier, $filename=false, $mode=false, $binaryFile=true)
 
 isAvailable ()
 
 isBinaryMode ()
 
 isDirectory ($filename=false)
 
 isExecutable ($filename=false)
 
 isFile ($filename=false)
 
 isLink ($filename=false)
 
 isOpen ()
 
 isReadable ($filename=false)
 
 isWriteable ($filename=false)
 
 link ($sourceFilename, $destinationFilename)
 
 linkCopy ($sourceFilename, $destinationFilename, $symbolicLink=true)
 
 mode ()
 
 move ($sourceFilename, $destinationFilename)
 
 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)
 
 symlink ($sourceFilename, $destinationFilename)
 
 tell ()
 
 unlink ($filename=false)
 
 write ($data, $length=false)
 

Private Attributes

 $File
 File pointer, returned by gzopen. More...
 
 $Level
 The compression level. More...
 

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

Member Function Documentation

eZGZIPZLIBCompressionHandler::compress (   $source)
virtual

Implements eZCompressionHandler.

eZGZIPZLIBCompressionHandler::compressionLevel ( )
Returns
the current compression level which is a number between 0 and 9, or false if the default is to be used.
eZGZIPZLIBCompressionHandler::decompress (   $source)
virtual

Implements eZCompressionHandler.

eZGZIPZLIBCompressionHandler::doClose ( )
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doEOF ( )
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doFlush ( )
virtual

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doPasstrough (   $closeFile)
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doRead (   $uncompressedLength = false)
virtual

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doTell ( )
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::doWrite (   $data,
  $uncompressedLength = false 
)
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::errorNumber ( )
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::errorString ( )
virtual

Implements eZFileHandler.

eZGZIPZLIBCompressionHandler::eZGZIPZLIBCompressionHandler ( )
eZGZIPZLIBCompressionHandler::isAvailable ( )
Returns
true if this handler can be used. This function checks if the zlib extension is available.

Referenced by eZGZIPCompressionHandler\eZGZIPCompressionHandler().

eZGZIPZLIBCompressionHandler::setCompressionLevel (   $level)

Sets the current compression level.

Member Data Documentation

eZGZIPZLIBCompressionHandler::$File
private

File pointer, returned by gzopen.

Referenced by doOpen().

eZGZIPZLIBCompressionHandler::$Level
private

The compression level.

Referenced by compressionLevel().


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