eZPublish  3.9
eZGZIPShellCompressionHandler Class Reference

Handles files compressed with gzip using the shell commands. More...

+ Inheritance diagram for eZGZIPShellCompressionHandler:
+ Collaboration diagram for eZGZIPShellCompressionHandler:

Public Member Functions

 compress ($source)
 
 compressionLevel ()
 
 decompress ($source)
 
 doClose ()
 
 doEOF ()
 
 doFlush ()
 
 doOpen ($filename, $mode)
 
 doPasstrough ()
 
 doRead ($uncompressedLength=false)
 
 doRewind ()
 
 doSeek ($offset, $whence)
 
 doTell ()
 
 doWrite ($data, $uncompressedLength=false)
 
 errorNumber ()
 
 errorString ()
 
 eZGZIPShellCompressionHandler ()
 
 gunzipFile ($filename)
 
 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)
 
 doPasstrough ($closeFile=true)
 
 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 shell commands.

Handles GZIP compression by executing the 'gzip' executable, without this the handler cannot work.

NOTE: This is not done yet.

Member Function Documentation

eZGZIPShellCompressionHandler::compress (   $source)
virtual

Implements eZCompressionHandler.

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

Implements eZCompressionHandler.

eZGZIPShellCompressionHandler::doClose ( )
virtual

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doEOF ( )
virtual

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doFlush ( )
virtual

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doPasstrough ( )
eZGZIPShellCompressionHandler::doRead (   $uncompressedLength = false)
virtual

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doTell ( )
virtual

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPShellCompressionHandler::errorNumber ( )
virtual

Implements eZFileHandler.

eZGZIPShellCompressionHandler::errorString ( )
virtual

Implements eZFileHandler.

eZGZIPShellCompressionHandler::eZGZIPShellCompressionHandler ( )
eZGZIPShellCompressionHandler::gunzipFile (   $filename)
eZGZIPShellCompressionHandler::isAvailable ( )
Returns
true if this handler can be used.

Referenced by eZGZIPCompressionHandler\eZGZIPCompressionHandler().

eZGZIPShellCompressionHandler::setCompressionLevel (   $level)

Sets the current compression level.

Member Data Documentation

eZGZIPShellCompressionHandler::$File
private

File pointer, returned by gzopen.

eZGZIPShellCompressionHandler::$Level
private

The compression level.

Referenced by compressionLevel().


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