FoIntegration Class Reference

base class for fossology integration. More...

Inheritance diagram for FoIntegration:

Collaboration diagram for FoIntegration:

Public Member Functions
	__construct ($sourcePath, $logPath=NULL)

Public Attributes
	$srcPath
	$logPath

Protected Member Functions
	log ($message)
	log a message in a file More...

Protected Attributes
	$LOGFD

Detailed Description

base class for fossology integration.

This class holds properties that extenders of this class should use, such as srcPath or logPath.

Parameters

string	$sourcePath	The fully qualified path to the fossology sources. If no source path is supplied, the current working directory will be used. This may or may not work for the caller, but is better than failing. Operating in this way should allow the code to run standalone or in Jenkins.
string	$logPath	The fully qualified path to the log file. The default is to use the current working directory. If the the logfile cannot be opened an expection is thrown.

Returns

object or exception

Version

"$Id$"

Author

markd

Created on Aug 11, 2011 by Mark Donohoe

Definition at line 32 of file fo_integration.php.

Member Function Documentation

log()

FoIntegration::log (   $message )

protected

log a message in a file

Parameters

string

$message

The message to log.

Todo:

add in a time stamp for each entry written.

Returns

boolean, false if the write failed, true otherwise.

Definition at line 78 of file fo_integration.php.

---

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

• src/testing/fo_integration.php