eZArchiveHandler Class Reference

General handling of file archives. More...

Inheritance diagram for eZArchiveHandler:

List of all members.

Public Member Functions
&	detachHandler ()
	eZArchiveHandler ($fileHandler, $archiveFilename=false)
	fileClose ()
	fileCopy ($sourceFilename, $destinationFilename)
	fileEOF ()
	fileError ()
	fileErrorNumber ()
	fileErrorString ()
	fileExists ($filename=false)
	fileFlush ()
	fileHandler ()
	fileIsBinaryMode ()
	fileIsDirectory ($filename=false)
	fileIsExecutable ($filename=false)
	fileIsFile ($filename=false)
	fileIsLink ($filename=false)
	fileIsOpen ()
	fileIsReadable ($filename=false)
	fileIsWriteable ($filename=false)
	fileMode ()
	fileName ()
	fileOpen ($archiveFilename=false, $mode=false)
	filePasstrough ($closeFile=true)
	fileRead ($length=false)
	fileRename ($destinationFilename, $sourceFilename=true)
	fileRewind ()
	fileSeek ($offset, $whence=SEEK_SET)
	fileStatistics ($filename=false)
	fileTell ()
	fileUnlink ($filename=false)
	fileWrite ($data, $length=false)
	isAvailable ()
	setArchiveFileName ($filename)
Static Public Member Functions
static	instance ($identifier, $fileHandlerType=false, $arhiveFilename=false)
Public Attributes
	$FileHandler

---

Detailed Description

General handling of file archives.

Deprecated:

This class will be removed in eZ Publish 4.2

This class handles the abstraction of handling various kinds of archive formats. The actual handling of the formats is sent of the specific archive handlers.

$handler = eZArchiveHandler::instance( 'tar', 'ezpublish.tar' );

Definition at line 49 of file ezarchivehandler.php.

---

Member Function Documentation

& eZArchiveHandler::detachHandler

(

)

Detaches the current file handler and instanties a new duplicate as current.

Returns:

the old file handler.

Definition at line 233 of file ezarchivehandler.php.

eZArchiveHandler::eZArchiveHandler	(	$	fileHandler,
		$	archiveFilename = false
	)

Constructor

Definition at line 54 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\eZTARArchiveHandler().

eZArchiveHandler::fileClose

(

)

Definition at line 95 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_close().

eZArchiveHandler::fileCopy	(	$	sourceFilename,
		$	destinationFilename
	)

Definition at line 168 of file ezarchivehandler.php.

eZArchiveHandler::fileEOF

(

)

Definition at line 130 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_extractList().

eZArchiveHandler::fileError

(

)

Definition at line 140 of file ezarchivehandler.php.

eZArchiveHandler::fileErrorNumber

(

)

Definition at line 150 of file ezarchivehandler.php.

eZArchiveHandler::fileErrorString

(

)

Definition at line 145 of file ezarchivehandler.php.

eZArchiveHandler::fileExists

(

$

filename = false

)

Definition at line 173 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_addList().

eZArchiveHandler::fileFlush

(

)

Definition at line 110 of file ezarchivehandler.php.

eZArchiveHandler::fileHandler

(

)

Returns:

the current file handler used for opening the archive file.

Definition at line 216 of file ezarchivehandler.php.

eZArchiveHandler::fileIsBinaryMode

(

)

Definition at line 70 of file ezarchivehandler.php.

eZArchiveHandler::fileIsDirectory

(

$

filename = false

)

Definition at line 178 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_addList(), and eZTARArchiveHandler\_writeHeader().

eZArchiveHandler::fileIsExecutable

(

$

filename = false

)

Definition at line 183 of file ezarchivehandler.php.

eZArchiveHandler::fileIsFile

(

$

filename = false

)

Definition at line 188 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_addFile().

eZArchiveHandler::fileIsLink

(

$

filename = false

)

Definition at line 193 of file ezarchivehandler.php.

eZArchiveHandler::fileIsOpen

(

)

Definition at line 65 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_addFile(), eZTARArchiveHandler\_addList(), and eZTARArchiveHandler\_writeFooter().

eZArchiveHandler::fileIsReadable

(

$

filename = false

)

Definition at line 198 of file ezarchivehandler.php.

eZArchiveHandler::fileIsWriteable

(

$

filename = false

)

Definition at line 203 of file ezarchivehandler.php.

eZArchiveHandler::fileMode

(

)

Definition at line 80 of file ezarchivehandler.php.

eZArchiveHandler::fileName

(

)

Definition at line 75 of file ezarchivehandler.php.

eZArchiveHandler::fileOpen	(	$	archiveFilename = false,
		$	mode = false
	)

Definition at line 85 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_openRead(), eZTARArchiveHandler\_openReadWrite(), and eZTARArchiveHandler\_openWrite().

eZArchiveHandler::filePasstrough

(

$

closeFile = true

)

Definition at line 135 of file ezarchivehandler.php.

eZArchiveHandler::fileRead

(

$

length = false

)

Definition at line 100 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_extractList().

eZArchiveHandler::fileRename	(	$	destinationFilename,
		$	sourceFilename = true
	)

Calls the rename() function for the current handler.

Definition at line 158 of file ezarchivehandler.php.

eZArchiveHandler::fileRewind

(

)

Definition at line 120 of file ezarchivehandler.php.

eZArchiveHandler::fileSeek	(	$	offset,
		$	whence = SEEK_SET
	)

Definition at line 115 of file ezarchivehandler.php.

eZArchiveHandler::fileStatistics

(

$

filename = false

)

Definition at line 208 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_writeHeader().

eZArchiveHandler::fileTell

(

)

Definition at line 125 of file ezarchivehandler.php.

eZArchiveHandler::fileUnlink

(

$

filename = false

)

Definition at line 163 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_cleanFile(), eZTARArchiveHandler\_close(), and eZTARArchiveHandler\_eZTARArchiveHandler().

eZArchiveHandler::fileWrite	(	$	data,
		$	length = false
	)

Definition at line 105 of file ezarchivehandler.php.

Referenced by eZTARArchiveHandler\_addFile(), eZTARArchiveHandler\_writeFooter(), and eZTARArchiveHandler\_writeHeader().

static eZArchiveHandler::instance	(	$	identifier,
		$	fileHandlerType = false,
		$	arhiveFilename = false
	)		[static]

Returns the handler for the identifier $identifier. The parameter $fileHandler must contain the filehandler object.

Returns:

false if the handler could not be created.

Definition at line 245 of file ezarchivehandler.php.

eZArchiveHandler::isAvailable

(

)

Returns:

true if the handler is available for use.

Definition at line 224 of file ezarchivehandler.php.

eZArchiveHandler::setArchiveFileName

(

$

filename

)

Definition at line 60 of file ezarchivehandler.php.

---

Member Data Documentation

eZArchiveHandler::$FileHandler

Definition at line 269 of file ezarchivehandler.php.

---

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

• ezarchivehandler.php