eZPublish  3.9
eZArchiveHandler Class Reference

General handling of file archives. More...

+ Inheritance diagram for eZArchiveHandler:

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)
 
instance ($identifier, $fileHandlerType=false, $arhiveFilename=false)
 
 isAvailable ()
 
 setArchiveFileName ($filename)
 

Private Attributes

 $FileHandler
 

Detailed Description

General handling of file archives.

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' );

Member Function Documentation

& eZArchiveHandler::detachHandler ( )

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

Returns
the old file handler.
eZArchiveHandler::eZArchiveHandler ( $fileHandler,
  $archiveFilename = false 
)

Constructor

Referenced by eZTARArchiveHandler\eZTARArchiveHandler().

eZArchiveHandler::fileClose ( )
eZArchiveHandler::fileCopy (   $sourceFilename,
  $destinationFilename 
)
eZArchiveHandler::fileEOF ( )
eZArchiveHandler::fileError ( )
eZArchiveHandler::fileErrorNumber ( )
eZArchiveHandler::fileErrorString ( )
eZArchiveHandler::fileExists (   $filename = false)
eZArchiveHandler::fileFlush ( )
eZArchiveHandler::fileHandler ( )
Returns
the current file handler used for opening the archive file.
eZArchiveHandler::fileIsBinaryMode ( )
eZArchiveHandler::fileIsDirectory (   $filename = false)
eZArchiveHandler::fileIsExecutable (   $filename = false)
eZArchiveHandler::fileIsFile (   $filename = false)
eZArchiveHandler::fileIsLink (   $filename = false)
eZArchiveHandler::fileIsReadable (   $filename = false)
eZArchiveHandler::fileIsWriteable (   $filename = false)
eZArchiveHandler::fileMode ( )
eZArchiveHandler::fileName ( )
eZArchiveHandler::fileOpen (   $archiveFilename = false,
  $mode = false 
)
eZArchiveHandler::filePasstrough (   $closeFile = true)
eZArchiveHandler::fileRead (   $length = false)
eZArchiveHandler::fileRename (   $destinationFilename,
  $sourceFilename = true 
)

Calls the rename() function for the current handler.

eZArchiveHandler::fileRewind ( )
eZArchiveHandler::fileSeek (   $offset,
  $whence = SEEK_SET 
)
eZArchiveHandler::fileStatistics (   $filename = false)
eZArchiveHandler::fileTell ( )
eZArchiveHandler::fileUnlink (   $filename = false)
eZArchiveHandler::fileWrite (   $data,
  $length = false 
)
& eZArchiveHandler::instance (   $identifier,
  $fileHandlerType = false,
  $arhiveFilename = false 
)

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

Returns
false if the handler could not be created.
eZArchiveHandler::isAvailable ( )
Returns
true if the handler is available for use.
eZArchiveHandler::setArchiveFileName (   $filename)

Member Data Documentation

eZArchiveHandler::$FileHandler
private

Referenced by detachHandler(), and fileHandler().


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