Class FTSLog

Description

A class for FTS transfer log

Represented as an array with each line of the log in a row

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

ArrayObject
   |
   --FTSLog
Variable Summary
 string $host
 string $transfer_id
Method Summary
 FTSLog __construct (string $host, string $transfer_id, string $transfer_state, [array $array = null])
 string getChannel ()
 string getHost ()
 string getName ()
 integer getTransferDate ()
 string getTransferID ()
 string getTransferState ()
 string toHTML ()
Variables
string $host (line 59)

Host where the log file was originally written

In case of multiple hosts, transfer logs are distributed depending on where agents are running

string $transfer_id (line 50)

Identifier of the transfer log

Something like "<CHANNEL_NAME>__<DATE>_XXXXXX" defined in the DB as "T_TRANSFER.TRANSFER_ID"

  • see: getTransferId
string $transfer_state (line 69)

State of the transfer

can be "Completed" or "Failed" defined in the DB as "T_TRANSFER_TRANSFER_STATE"

Methods
Constructor __construct (line 79)

Constructor

  • access: public
FTSLog __construct (string $host, string $transfer_id, string $transfer_state, [array $array = null])
  • string $host: Host : where the log was written
  • string $transfer_id: : Identifier of the transfer
  • string $transfer_state: : State of the transfer
  • array $array: : an array containing one log line in each row

Redefinition of:
ArrayObject::constructor __construct ( $array )
getArchivedFileName (line 130)

Gets the archive file name

The archive file name is built as follows:

  • if transfer is "Aborted": "<CHANNEL_NAME>failed/<IDENTIFIER>.log"
  • if the transfer is "Completed" or "Failed": "<CHANNEL_NAME><STATE_IN_LOWERCASE>/<IDENTIFIER>.log"

  • return: : the archive file name
  • access: public
string getArchivedFileName ()
getChannel (line 167)

Gets the channel that managed the transfer

  • return: : the channel extracted from the identifier
  • access: public
string getChannel ()
getHost (line 109)

Gets the host of the transfer

  • return: : the host where the transfer log was originally written to
  • access: public
string getHost ()
getName (line 118)

Gets the name of the log file

  • return: the log file name built as: "<IDENTIFIER>.log"
  • access: public
string getName ()
getTransferDate (line 146)

Gets the Transfer date

The date is included in the transfer identifier in the form "YYYY-MM-DD-HHmm"

  • return: : the transfer date as a timestamp
  • access: public
integer getTransferDate ()
getTransferID (line 91)

Gets the identifier of the transfer

  • return: : the identifier of the transfer as found in the DB in "T_TRANSFER.TRANSFER_ID"
  • access: public
string getTransferID ()
getTransferState (line 100)

Gets the state of the transfer

  • return: : the state of the transfer as found in the DB in "T_TRANSFER.TRANSFER_STATE"
  • access: public
string getTransferState ()
toHTML (line 177)

Gets the HTML display

  • return: : the HTML table containing the log with each of its line in a row
  • access: public
string toHTML ()

Inherited Methods

Inherited From ArrayObject (Internal Class)

 constructor __construct ( $array )
 append ( $value )
 asort ( )
 count ( )
 exchangeArray ( $array )
 getArrayCopy ( )
 getFlags ( )
 getIterator ( )
 getIteratorClass ( )
 ksort ( )
 natcasesort ( )
 natsort ( )
 offsetExists ( $index )
 offsetGet ( $index )
 offsetSet ( $index, $newval )
 offsetUnset ( $index )
 serialize ( )
 setFlags ( $flags )
 setIteratorClass ( $iteratorClass )
 uasort ( $cmp_function )
 uksort ( $cmp_function )
 unserialize ( $serialized )
Class Constants

Inherited Constants

Inherited from ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

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