UnifiedReport Class Reference

Generates unified report. More...

Inheritance diagram for UnifiedReport:

Collaboration diagram for UnifiedReport:

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...

Private Member Functions
	documentSettingsAndStyles (PhpWord &$phpWord, $timestamp, $userName)
	Setting default heading styles and paragraph styles. More...
	globalLicenseTable (Section $section, $mainLicenses, $titleSubHeading, $heading)
	Generate global license table. More...
	bulkLicenseTable (Section $section, $title, $licenses, $titleSubHeading)
	This function lists out the bulk licenses, comments of identified licenses. More...
	licensesTable (Section $section, $title, $licenses, $riskarray, $titleSubHeading)
	This function lists out the red, white & yellow licenses. More...
	getRowsAndColumnsForCEI (Section $section, $title, $statementsCEI, $titleSubHeading, $text="")
	Copyright or ecc table. More...
	getRowsAndColumnsForIrre (Section $section, $title, $licensesIrre, $titleSubHeading)
	Irrelevant files in report. More...
	licenseHistogram (Section $section, $dataHistogram, $titleSubHeading, $heading)
	License histogram into report. More...
	writeReport ($contents, $uploadId, $groupId, $userId)
	Writes the report to a file. More...
	updateReportTable ($uploadId, $jobId, $filename)
	Update database with generated report path. More...

Private Attributes
	$licenseClearedGetter
	$licenseMainGetter
	$cpClearedGetter
	$ipraClearedGetter
	$eccClearedGetter
	$licenseIrrelevantGetter
	$licenseDNUGetter
	$licenseNonFunctionalGetter
	$bulkMatchesGetter
	$licenseIrrelevantCommentGetter
	$obligationsGetter
	$reportutils
	$otherGetter
	$uploadDao
	$userDao
	$rowHeight = 500
	$tablestyle
	$subHeadingStyle
	$licenseColumn
	$licenseTextColumn
	$filePathColumn
	$groupBy

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...
Protected Attributes inherited from Fossology\Lib\Agent\Agent
	$userId
	$groupId
	$jobId
	$agentSpecifOptions = ""
	$agentSpecifLongOptions = array()
	$args = array()
	$dbManager
	$agentDao
	$container
	$schedulerMode

Detailed Description

Generates unified report.

Definition at line 117 of file unifiedreport.php.

Member Function Documentation

bulkLicenseTable()

UnifiedReport::bulkLicenseTable ( Section  $section,   $title,   $licenses,   $titleSubHeading  )

private

This function lists out the bulk licenses, comments of identified licenses.

Parameters

Section	$section
string	$title
array	$licenses
array	$titleSubHeading

Definition at line 477 of file unifiedreport.php.

documentSettingsAndStyles()

UnifiedReport::documentSettingsAndStyles ( PhpWord &  $phpWord,   $timestamp,   $userName  )

private

Setting default heading styles and paragraph styles.

Parameters

[in,out]	PhpWord	&$phpWord	PhpWord object
	int	$timestamp	Report gen timestamp
	string	$userName	User generating the report

Definition at line 363 of file unifiedreport.php.

getRowsAndColumnsForCEI()

UnifiedReport::getRowsAndColumnsForCEI ( Section  $section,   $title,   $statementsCEI,   $titleSubHeading,   $text = ""  )

private

Copyright or ecc table.

Parameters

Section	$section
string	$title
array	$statementsCEI
array	$titleSubHeading
string	$text

Definition at line 572 of file unifiedreport.php.

getRowsAndColumnsForIrre()

UnifiedReport::getRowsAndColumnsForIrre ( Section  $section,   $title,   $licensesIrre,   $titleSubHeading  )

private

Irrelevant files in report.

Parameters

Section	$section
string	$title
array	$licensesIrre
array	$titleSubHeading

Definition at line 619 of file unifiedreport.php.

globalLicenseTable()

UnifiedReport::globalLicenseTable ( Section  $section,   $mainLicenses,   $titleSubHeading,   $heading  )

private

Generate global license table.

Parameters

Section	$section
array	$mainLicenses
array	$titleSubHeading
	$heading

Definition at line 423 of file unifiedreport.php.

licenseHistogram()

UnifiedReport::licenseHistogram ( Section  $section,   $dataHistogram,   $titleSubHeading,   $heading  )

private

License histogram into report.

Parameters

Section	$section
array	$dataHistogram
array	$titleSubHeading
	$heading

Definition at line 657 of file unifiedreport.php.

licensesTable()

UnifiedReport::licensesTable ( Section  $section,   $title,   $licenses,   $riskarray,   $titleSubHeading  )

private

This function lists out the red, white & yellow licenses.

Parameters

Section	$section
string	$title
array	$licenses
array	$riskarray
array	$titleSubHeading

Definition at line 521 of file unifiedreport.php.

processUploadId()

UnifiedReport::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

See also

Fossology::Lib::Agent::Agent::processUploadId()

Reimplemented from Fossology\Lib\Agent\Agent.

Definition at line 275 of file unifiedreport.php.

updateReportTable()

UnifiedReport::updateReportTable (   $uploadId,   $jobId,   $filename  )

private

Update database with generated report path.

Parameters

int	$uploadId
int	$jobId
string	$filename

Definition at line 971 of file unifiedreport.php.

writeReport()

UnifiedReport::writeReport (   $contents,   $uploadId,   $groupId,   $userId  )

private

Writes the report to a file.

The file name is of format <packageName>_clearing_report_<D_M_d_m_Y_h_i_s>.docx.

The docx format used is Word2007.

Parameters

array	$contents
int	$uploadId
int	$groupId
int	$userId

Definition at line 689 of file unifiedreport.php.

Member Data Documentation

$bulkMatchesGetter

BulkMatchesGetter UnifiedReport::$bulkMatchesGetter

private

BulkMatchesGetter object

Definition at line 163 of file unifiedreport.php.

$cpClearedGetter

XpClearedGetter UnifiedReport::$cpClearedGetter

private

Copyright clearance object

Definition at line 132 of file unifiedreport.php.

$eccClearedGetter

XpClearedGetter UnifiedReport::$eccClearedGetter

private

ECC clearance object

Definition at line 143 of file unifiedreport.php.

$filePathColumn

array UnifiedReport::$filePathColumn

private

Initial value:

= array("size" => "9",
                                  "bold" => false
                                 )

File path column style attributes

Definition at line 237 of file unifiedreport.php.

$groupBy

string UnifiedReport::$groupBy

private

Todo:

Unused variable

Definition at line 244 of file unifiedreport.php.

$ipraClearedGetter

XpClearedGetter UnifiedReport::$ipraClearedGetter

private

IP clearance object

Definition at line 138 of file unifiedreport.php.

$licenseClearedGetter

LicenseClearedGetter UnifiedReport::$licenseClearedGetter

private

LicenseClearedGetter object

Definition at line 122 of file unifiedreport.php.

$licenseColumn

array UnifiedReport::$licenseColumn

private

Initial value:

= array("size" => "9",
                                 "bold" => true
                                )

License column style attributes

Definition at line 222 of file unifiedreport.php.

$licenseDNUGetter

LicenseDNUGetter UnifiedReport::$licenseDNUGetter

private

LicenseDNUGetter object

Definition at line 153 of file unifiedreport.php.

$licenseIrrelevantCommentGetter

LicenseIrrelevantGetter UnifiedReport::$licenseIrrelevantCommentGetter

private

licenseIrrelevantCommentGetter object

Definition at line 168 of file unifiedreport.php.

$licenseIrrelevantGetter

LicenseIrrelevantGetter UnifiedReport::$licenseIrrelevantGetter

private

LicenseIrrelevantGetter object

Definition at line 148 of file unifiedreport.php.

$licenseMainGetter

LicenseMainGetter UnifiedReport::$licenseMainGetter

private

LicenseMainGetter object

Definition at line 127 of file unifiedreport.php.

$licenseNonFunctionalGetter

LicenseNonFunctionalGetter UnifiedReport::$licenseNonFunctionalGetter

private

LicenseNonFunctionalGetter object

Definition at line 158 of file unifiedreport.php.

$licenseTextColumn

array UnifiedReport::$licenseTextColumn

private

Initial value:

= array("name" => "Courier New",
                                     "size" => 9,
                                     "bold" => false
                                    )

License column text style attributes

Definition at line 229 of file unifiedreport.php.

$obligationsGetter

ObligationsGetter UnifiedReport::$obligationsGetter

private

obligationsGetter object

Definition at line 173 of file unifiedreport.php.

$otherGetter

OtherGetter UnifiedReport::$otherGetter

private

otherGetter object

Definition at line 183 of file unifiedreport.php.

$reportutils

ReportUtils UnifiedReport::$reportutils

private

ReportUtils object

Definition at line 178 of file unifiedreport.php.

$rowHeight

int UnifiedReport::$rowHeight = 500

private

Row height for table

Definition at line 198 of file unifiedreport.php.

$subHeadingStyle

array UnifiedReport::$subHeadingStyle

private

Initial value:

= array("size" => 9,
                                   "align" => "center",
                                   "bold" => true
                                  )

Sub heading style attributes

Definition at line 214 of file unifiedreport.php.

$tablestyle

array UnifiedReport::$tablestyle

private

Initial value:

= array("borderSize" => 2,
                              "name" => "Arial",
                              "borderColor" => "000000",
                              "cellSpacing" => 5,
                              "alignment"   => JcTable::START,
                              "layout"      => Table::LAYOUT_FIXED
                             )

Table style attributes

Definition at line 203 of file unifiedreport.php.

$uploadDao

UploadDao UnifiedReport::$uploadDao

private

UploadDao object

Definition at line 188 of file unifiedreport.php.

$userDao

UserDao UnifiedReport::$userDao

private

UserDao object

Definition at line 193 of file unifiedreport.php.

---

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

• src/unifiedreport/agent/unifiedreport.php