Abstract Class FTSLogViewer

Description

This class is the generic class for log viewers

You have to define your own viewer or use viewers provided by default

Located in /ftslog.classes.php (line 206)


	
			
Direct descendents
Class Description
 class SkeletonLogViewer This class is an example for developping a log viewer plugin.
 class FTSHTTPLogViewer This class allows to read a log file located on a web server.
 class FTSLocalLogViewer This class allows to read a log file located on a local or remote file system.
Variable Summary
 string $root
Method Summary
 FTSLogViewer __construct (string $root)
 FTSLog getLog (string $host, string $transfer_id, string $transfer_state)
 array retrieveLog ()
Variables
FTSLog $log (line 218)

The FTSLog object that contains lines of the log and attributes

string $root (line 212)

Root path of the file/URL to read

Methods
Constructor __construct (line 224)

Constructor

  • access: public
FTSLogViewer __construct (string $root)
  • string $root: : the root path of the file to read

Redefined in descendants as:
getLog (line 250)

Gets the LOG object built from the array returned by "getLogAsArray"

FTSLog getLog (string $host, string $transfer_id, string $transfer_state)
  • string $host: : host where the transfer log can be retrieved
  • string $transfer_id: : identifier of the transfer
  • string $transfer_state: : state of the transfer
retrieveLog (line 239)

Retrives the log as an array

This method has to be implemented depending on the way the log is retrieved

  • return: : an array with each log line in a row
  • abstract:
  • access: public
array retrieveLog ()

Redefined in descendants as:

Documentation generated on Tue, 09 Nov 2010 10:21:10 +0100 by phpDocumentor 1.4.3