eZGZIPShellCompressionHandler Class Reference

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

Inheritance diagram for eZGZIPShellCompressionHandler:

Collaboration diagram for eZGZIPShellCompressionHandler:

List of all members.

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)
Static Public Member Functions
static	isAvailable ()
Public Attributes
	$File
	File pointer, returned by gzopen.
	$Level
	The compression level.

---

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.

Definition at line 44 of file ezgzipshellcompressionhandler.php.

---

Member Function Documentation

eZGZIPShellCompressionHandler::compress

(

$

source

)

[virtual]

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

Implements eZCompressionHandler.

Definition at line 143 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::compressionLevel

(

)

Returns:

the current compression level which is a number between 0 and 9, or false if the default is to be used.

Definition at line 67 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::decompress

(

$

source

)

[virtual]

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

Implements eZCompressionHandler.

Definition at line 148 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doClose

(

)

[virtual]

Does the actual file closing.

See also:

close

Implements eZFileHandler.

Definition at line 90 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doEOF

(

)

[virtual]

Does the actual file eof detection.

See also:

eof

Implements eZFileHandler.

Definition at line 133 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doFlush

(

)

[virtual]

Does the actual file flushing.

See also:

flush

Implements eZFileHandler.

Definition at line 105 of file ezgzipshellcompressionhandler.php.

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

Does the actual file opening.

See also:

open

Implements eZFileHandler.

Definition at line 85 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doPasstrough

(

$

closeFile = true

)

[virtual]

Does the actual file passtrough.

See also:

eof

Implements eZFileHandler.

Definition at line 138 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doRead

(

$

length = false

)

[virtual]

Does the actual file reading.

See also:

read

Implements eZFileHandler.

Definition at line 95 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::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 123 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doSeek	(	$	offset,
		$	whence
	)		[virtual]

Does the actual file seek.

See also:

seek

Implements eZFileHandler.

Definition at line 110 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::doTell

(

)

[virtual]

Does the actual file telling.

See also:

tell

Implements eZFileHandler.

Definition at line 128 of file ezgzipshellcompressionhandler.php.

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

Does the actual file writing.

See also:

write

Implements eZFileHandler.

Definition at line 100 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::errorNumber

(

)

[virtual]

Returns:

the error number from the last error that occured.

Implements eZFileHandler.

Definition at line 158 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::errorString

(

)

[virtual]

Returns:

the error string from the last error that occured.

Implements eZFileHandler.

Definition at line 153 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::eZGZIPShellCompressionHandler

(

)

Definition at line 46 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::gunzipFile

(

$

filename

)

Definition at line 80 of file ezgzipshellcompressionhandler.php.

static eZGZIPShellCompressionHandler::isAvailable

(

)

[static]

Returns:

true if this handler can be used.

Reimplemented from eZFileHandler.

Definition at line 75 of file ezgzipshellcompressionhandler.php.

Referenced by eZGZIPCompressionHandler\eZGZIPCompressionHandler().

eZGZIPShellCompressionHandler::setCompressionLevel

(

$

level

)

Sets the current compression level.

Definition at line 56 of file ezgzipshellcompressionhandler.php.

---

Member Data Documentation

eZGZIPShellCompressionHandler::$File

File pointer, returned by gzopen.

Definition at line 165 of file ezgzipshellcompressionhandler.php.

eZGZIPShellCompressionHandler::$Level

The compression level.

Definition at line 167 of file ezgzipshellcompressionhandler.php.

---

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

• ezgzipshellcompressionhandler.php