Handles static part of report. More...

Collaboration diagram for ReportStatic:

Public Member Functions
	__construct ($timeStamp)

	reportHeader (Section $section)
	Generates report header from `Report Header Text` More...

	reportFooter ($phpWord, Section $section, $otherStatement)
	Generates report footer. More...

	clearingProtocolChangeLogTable (Section $section, $heading)
	Generates clearing protocol change log table. More...

	addCheckBoxText ($cell, $value, $text)
	Check checkbox value(checked/unchecked) and append text. More...

	assessmentSummaryTable (Section $section, $otherStatement, $heading)
	Generate assessment summary table. More...

	todoTable (Section $section, $heading)
	Generate todo table. More...

	todoObliTable (Section $section, $obligations)
	Generate todo table for obligations. More...

	allLicensesWithAndWithoutObligations (Section $section, $heading, $obligations, $whiteLists, $titleSubHeadingObli)
	Generate table with all licenses. More...

	basicForClearingReport (Section $section)
	Generate basis for clearing report section. More...

	getNonFunctionalLicenses (Section $section, $heading)

	notes (Section $section, $heading, $subHeading)
	Generate notes. More...

Protected Member Functions
	arrangeObligationsText ($obligationText, $table, $rowWidth, $firstColLen, $rowTextStyleLeft, $secondColLen, $rowTextStyleRight)
	Get obligation text and arrange them to rows and columns. More...

Private Attributes
	$timeStamp

	$subHeadingStyle

	$tablestyle

	$firstColStyle

	$secondColStyle

Detailed Description

Handles static part of report.

Definition at line 20 of file reportStatic.php.

Member Function Documentation

◆ addCheckBoxText()

ReportStatic::addCheckBoxText	(	$cell,
		$value,
		$text
	)

Check checkbox value(checked/unchecked) and append text.

Parameters

Cell	$cell
string	$value
string	$text

Returns: TextRun checkbox with text

Definition at line 147 of file reportStatic.php.

◆ allLicensesWithAndWithoutObligations()

ReportStatic::allLicensesWithAndWithoutObligations	(	Section	$section,
			$heading,
			$obligations,
			$whiteLists,
			$titleSubHeadingObli
	)

Generate table with all licenses.

Parameters

Section	$section
string	$heading
array	$obligations
array	$whiteLists
string	$titleSubHeadingObli

Definition at line 462 of file reportStatic.php.

◆ arrangeObligationsText()

ReportStatic::arrangeObligationsText	(	$obligationText,
		$table,
		$rowWidth,
		$firstColLen,
		$rowTextStyleLeft,
		$secondColLen,
		$rowTextStyleRight
	)

protected

Get obligation text and arrange them to rows and columns.

Parameters

string	$obligationText
string	$table
string	$rowWidth
array	$firstColLen
array	$rowTextStyleLeft
array	$secondColLen
array	$rowTextStyleRight

Returns: table columns

Definition at line 299 of file reportStatic.php.

◆ assessmentSummaryTable()

ReportStatic::assessmentSummaryTable	(	Section	$section,
			$otherStatement,
			$heading
	)

Generate assessment summary table.

Parameters

Section	$section
String[]	$otherStatement
String	$heading

Returns: Cell|\PhpOffice\PhpWord\Element\Text

Definition at line 169 of file reportStatic.php.

◆ basicForClearingReport()

ReportStatic::basicForClearingReport ( Section $section )

Generate basis for clearing report section.

Parameters

Section $section

Definition at line 496 of file reportStatic.php.

◆ clearingProtocolChangeLogTable()

ReportStatic::clearingProtocolChangeLogTable	(	Section	$section,
			$heading
	)

Generates clearing protocol change log table.

Parameters

Section	$section
String	$heading	Section heading

Definition at line 113 of file reportStatic.php.

◆ getNonFunctionalLicenses()

ReportStatic::getNonFunctionalLicenses	(	Section	$section,
			$heading
	)

@biref Generate Heading for nonfunctional licenses

Parameters

Section	$section
string	$heading

Definition at line 556 of file reportStatic.php.

◆ notes()

ReportStatic::notes	(	Section	$section,
			$heading,
			$subHeading
	)

Generate notes.

Parameters

Section	$section
	$heading
	$subHeading

Definition at line 573 of file reportStatic.php.

◆ reportFooter()

ReportStatic::reportFooter	(		$phpWord,
		Section	$section,
			$otherStatement
	)

Generates report footer.

Parameters

PhpWord	$phpWord
Section	$section
array	$otherStatement

Definition at line 86 of file reportStatic.php.

◆ reportHeader()

ReportStatic::reportHeader ( Section $section )

Generates report header from Report Header Text

Parameters

Section $section

Definition at line 70 of file reportStatic.php.

◆ todoObliTable()

ReportStatic::todoObliTable	(	Section	$section,
			$obligations
	)

Generate todo table for obligations.

Parameters

Section	$section
array	$obligations

Definition at line 403 of file reportStatic.php.

◆ todoTable()

ReportStatic::todoTable	(	Section	$section,
			$heading
	)

Generate todo table.

Parameters

Section	$section
String	$heading

Definition at line 339 of file reportStatic.php.

Member Data Documentation

◆ $firstColStyle

array ReportStatic::$firstColStyle

private

Initial value:

= array (

"size" => 11 , "bold"=> true, "bgcolor" => "FFFFC2")

Style of first column

Definition at line 50 of file reportStatic.php.

◆ $secondColStyle

array ReportStatic::$secondColStyle

private

Initial value:

= array (

"size" => 11 , "bold"=> true, "bgcolor"=> "E0FFFF")

Style of second column

Definition at line 57 of file reportStatic.php.

◆ $subHeadingStyle

array ReportStatic::$subHeadingStyle

private

Initial value:

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

Sub heading style attributes

Definition at line 30 of file reportStatic.php.

◆ $tablestyle

array ReportStatic::$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 38 of file reportStatic.php.

◆ $timeStamp

int ReportStatic::$timeStamp

private

Report generation time stamp

Definition at line 25 of file reportStatic.php.

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

src/unifiedreport/agent/reportStatic.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addCheckBoxText()

◆ allLicensesWithAndWithoutObligations()

◆ arrangeObligationsText()

◆ assessmentSummaryTable()

◆ basicForClearingReport()

◆ clearingProtocolChangeLogTable()

◆ getNonFunctionalLicenses()

◆ notes()

◆ reportFooter()

◆ reportHeader()

◆ todoObliTable()

◆ todoTable()

Member Data Documentation

◆ $firstColStyle

◆ $secondColStyle

◆ $subHeadingStyle

◆ $tablestyle

◆ $timeStamp