Fossology\CliXml\CliXml Class Reference

Inheritance diagram for Fossology\CliXml\CliXml:

Collaboration diagram for Fossology\CliXml\CliXml:

Public Member Functions
	processUploadId ($uploadId)
	Given an upload ID, process the items in it. More...
Public Member Functions inherited from Fossology\Lib\Agent\Agent
	__construct ($agentName, $version, $revision)
	scheduler_connect ()
	Connect with scheduler and initialize options. More...
	heartbeat ($newProcessed)
	Send hear beat to the scheduler. More...
	bail ($exitvalue)
	Bail the agent, print the stack and disconnect from scheduler. More...
	scheduler_disconnect ($exitvalue)
	Closes connection from scheduler. More...
	scheduler_greet ()
	Greet the scheduler at the beginning of connection. More...
	initArsTable ()
	Initialize ARS table.
	run_scheduler_event_loop ()
	Runs a loop to read commands from scheduler and process them. More...

Public Attributes
const	OUTPUT_FORMAT_KEY = "outputFormat"
const	DEFAULT_OUTPUT_FORMAT = "clixml"
const	AVAILABLE_OUTPUT_FORMATS = "xml"
const	UPLOAD_ADDS = "uploadsAdd"

Protected Member Functions
	preWorkOnArgsFlp ($args, $key1, $key2)
	preWorkOnArgs ($args)
	getTemplateFile ($partname)
	getUri ($fileBase)
	renderPackage ($uploadId, $groupId)
	removeDuplicateAcknowledgements ($licenses, &$countAcknowledgement, $includeAcknowledgements)
	riskMapping ($licenseContent)
	reArrangeMainLic ($contents, $includeAcknowledgements)
	reArrangeContent ($contents)
	computeUri ($uploadId)
	writeReport ($contents, $packageIds, $uploadId)
	updateReportTable ($uploadId, $jobId, $fileName)
	renderString ($templateName, $vars)

Protected Attributes
	$dbManager
	$licenseDao
	$renderer
	$uri
	$packageName
	$outputFormat = self::DEFAULT_OUTPUT_FORMAT
Protected Attributes inherited from Fossology\Lib\Agent\Agent
	$userId
	$groupId
	$jobId
	$agentSpecifOptions = ""
	$agentSpecifLongOptions = array()
	$args = array()
	$dbManager
	$agentDao
	$container
	$schedulerMode

Private Member Functions
	getReportSummary ($uploadId)
	addLicenseNames ($licenses)

Private Attributes
	$uploadDao
	$cpClearedGetter
	$ipraClearedGetter
	$eccClearedGetter
	$licenseDNUGetter

Additional Inherited Members
Static Public Member Functions inherited from Fossology\Lib\Agent\Agent
static	heartbeat_handler ($signo)
	Function to handle hear beats from the agent and send them to the scheduler from STDOUT. More...

Detailed Description

Definition at line 26 of file clixml.php.

Member Function Documentation

addLicenseNames()

Fossology\CliXml\CliXml::addLicenseNames (   $licenses )

private

Add license shortname to the list of license statements.

Parameters

array

$licenses

License statements from

Returns

array License statements with name filed

Definition at line 606 of file clixml.php.

getReportSummary()

Fossology\CliXml\CliXml::getReportSummary (   $uploadId )

private

Generate the GeneralInformation and AssessmentSummary components for the report.

Parameters

int

$uploadId

Upload ID

Returns

array First element as associative array for GeneralInformation and second as associative array for AssessmentSummary

Definition at line 517 of file clixml.php.

preWorkOnArgs()

Fossology\CliXml\CliXml::preWorkOnArgs (   $args )

protected

Parameters

string[]

$args

Returns

string[] $args

Definition at line 122 of file clixml.php.

preWorkOnArgsFlp()

Fossology\CliXml\CliXml::preWorkOnArgsFlp (   $args,   $key1,   $key2  )

protected

Parameters

string[]	$args
string	$key1
string	$key2

Returns

string[] $args

Definition at line 106 of file clixml.php.

processUploadId()

Fossology\CliXml\CliXml::processUploadId

(

$uploadId

)

Given an upload ID, process the items in it.

This function is implemented by agent and should call heartbeat() at regular intervals.

Parameters

int

$uploadId

Upload to be processed by the agent.

Returns

bool Process status

Reimplemented from Fossology\Lib\Agent\Agent.

Definition at line 137 of file clixml.php.

renderString()

Fossology\CliXml\CliXml::renderString (   $templateName,   $vars  )

protected

Parameters

string	$templateName
array	$vars

Returns

string

Definition at line 505 of file clixml.php.

Member Data Documentation

$cpClearedGetter

XpClearedGetter Fossology\CliXml\CliXml::$cpClearedGetter

private

Copyright clearance object

Definition at line 55 of file clixml.php.

$eccClearedGetter

XpClearedGetter Fossology\CliXml\CliXml::$eccClearedGetter

private

ECC clearance object

Definition at line 65 of file clixml.php.

$ipraClearedGetter

XpClearedGetter Fossology\CliXml\CliXml::$ipraClearedGetter

private

IPRA clearance object

Definition at line 60 of file clixml.php.

$licenseDNUGetter

LicenseDNUGetter Fossology\CliXml\CliXml::$licenseDNUGetter

private

LicenseDNUGetter object

Definition at line 69 of file clixml.php.

---

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

• src/clixml/agent/clixml.php