eZPublishCommunityProject(LegacyStack)  2013.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 ($closeFile=true)
 
 doRead ($uncompressedLength=false)
 
 doRewind ()
 
 doSeek ($offset, $whence)
 
 doTell ()
 
 doWrite ($data, $uncompressedLength=false)
 
 errorNumber ()
 
 errorString ()
 
 eZGZIPShellCompressionHandler ()
 
 gunzipFile ($filename)
 
 setCompressionLevel ($level)
 
- 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 ()
 
 unlink ($filename=false)
 
 write ($data, $length=false)
 

Static Public Member Functions

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

Public Attributes

 $File
 File pointer, returned by gzopen. More...
 
 $Level
 The compression level. More...
 
- Public Attributes inherited from eZFileHandler
 $FileName
 
 $IsBinary
 
 $IsOpen
 
 $Mode
 
 $Name
 

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

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

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

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

Implements eZCompressionHandler.

eZGZIPShellCompressionHandler::doClose ( )
virtual

Does the actual file closing.

See Also
close

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doEOF ( )
virtual

Does the actual file eof detection.

See Also
eof

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doFlush ( )
virtual

Does the actual file flushing.

See Also
flush

Implements eZFileHandler.

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

Does the actual file opening.

See Also
open

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doPasstrough (   $closeFile = true)
virtual

Does the actual file passtrough.

See Also
eof

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doRead (   $length = false)
virtual

Does the actual file reading.

See Also
read

Implements eZFileHandler.

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

Does the actual file seek.

See Also
seek

Implements eZFileHandler.

eZGZIPShellCompressionHandler::doTell ( )
virtual

Does the actual file telling.

See Also
tell

Implements eZFileHandler.

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

Does the actual file writing.

See Also
write

Implements eZFileHandler.

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

Implements eZFileHandler.

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

Implements eZFileHandler.

eZGZIPShellCompressionHandler::eZGZIPShellCompressionHandler ( )
eZGZIPShellCompressionHandler::gunzipFile (   $filename)
static eZGZIPShellCompressionHandler::isAvailable ( )
static
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

File pointer, returned by gzopen.

eZGZIPShellCompressionHandler::$Level

The compression level.

Referenced by compressionLevel().


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