ui_report_conf Class Reference

Inheritance diagram for ui_report_conf:

Collaboration diagram for ui_report_conf:

Public Member Functions
	RegisterMenus ()
	Customize submenus.
	allReportConfiguration ($uploadId, $groupId)
	list all the options for Report Configuration More...
	getAllObligationsForGivenUploadId ($uploadId, $groupId)
	get all the obgligations for cleared licenses More...
	getTemplateName ()
Public Member Functions inherited from FO_Plugin
	Install ()
	This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...
	Remove ()
	This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
	__construct ()
	base constructor. Most plugins will just use this More...
	Initialize ()
	dummy stub till all references are removed.
	PostInitialize ()
	This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
	RegisterMenus ()
	While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...
	Destroy ()
	This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
	OutputOpen ()
	This function is called when user output is requested. This function is responsible for assigning headers.
	OutputUnSet ()
	Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
	getResponse ()
	Output ()
	This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)
	getTemplateName ()
	renderString ($templateName, $vars=null)
	renderScripts ($scripts)
	Render JavaScript in the template's footer. More...
	getRequest ()
	execute ()
	preInstall ()
	postInstall ()
	unInstall ()
	getName ()
	__toString ()

Protected Member Functions
	getCheckBoxSelectionList ($checkBoxListParams)
	createScriptBlock ()
	Create Script block for conf. More...
Protected Member Functions inherited from FO_Plugin
	render ($templateName, $vars=null)

Private Attributes
	$dbManager
	$uploadDao
	$userDao
	$licenseDao
	$clearingDao
	$mapDBColumns
	$checkBoxListUR
	$checkBoxListSPDX

Additional Inherited Members
Public Attributes inherited from FO_Plugin
	$State = PLUGIN_STATE_INVALID
	$Name = ""
	$Version = "1.0"
	$Title = ""
	$DBaccess = PLUGIN_DB_NONE
	$LoginFlag = 0
	$NoMenu = 0
	$NoHeader = 0
	$PluginLevel = 10
	$Dependency = array()
	$InitOrder = 0
	$MenuList = NULL
	$MenuOrder = 0
	$MenuTarget = NULL
	$OutputType = "HTML"
	$OutputToStdout = 0
Protected Attributes inherited from FO_Plugin
	$microMenu
	$renderer
	$vars = array()

Detailed Description

Definition at line 28 of file ui-report-conf.php.

Member Function Documentation

ui_report_conf::allReportConfiguration	(		$uploadId,
			$groupId
	)

list all the options for Report Configuration

Parameters

int	$uploadId
int	$groupId

Returns

array with all obligations grouped by obligation topic

Definition at line 151 of file ui-report-conf.php.

ui_report_conf::createScriptBlock ( )

protected

Create Script block for conf.

Returns

string JavaScript block

Definition at line 331 of file ui-report-conf.php.

ui_report_conf::getAllObligationsForGivenUploadId	(		$uploadId,
			$groupId
	)

get all the obgligations for cleared licenses

Parameters

int	$uploadId
int	$groupId

Returns

array with all obligations grouped by obligation topic

Definition at line 201 of file ui-report-conf.php.

ui_report_conf::getCheckBoxSelectionList (   $checkBoxListParams )

protected

Parameters

array

$checkBoxListParams

Returns

$cbSelectionList

Definition at line 246 of file ui-report-conf.php.

Member Data Documentation

checkBoxListSPDX ui_report_conf::$checkBoxListSPDX

private

Initial value:

= array(
    "spdxLicenseComment",
    "ignoreFilesWOInfo"
  )

Definition at line 89 of file ui-report-conf.php.

checkBoxListUR ui_report_conf::$checkBoxListUR

private

Initial value:

= array(
    "nonCritical",
    "critical",
    "noDependency",
    "dependencySource",
    "dependencyBinary",
    "noExportRestriction",
    "exportRestriction",
    "noRestriction",
    "restrictionForUse"
  )

Definition at line 74 of file ui-report-conf.php.

ClearingDao ui_report_conf::$clearingDao

private

ClearingDao object

Definition at line 51 of file ui-report-conf.php.

LicenseDao ui_report_conf::$licenseDao

private

LicenseDao object

Definition at line 46 of file ui-report-conf.php.

mapDBColumns ui_report_conf::$mapDBColumns

private

Initial value:

= array(
    "reviewedBy" => "ri_reviewed",
    "department" => "ri_department",
    "reportRel" => "ri_report_rel",
    "community" => "ri_community",
    "component" => "ri_component",
    "version" => "ri_version",
    "relDate" => "ri_release_date",
    "sw360Link" => "ri_sw360_link",
    "footerNote" => "ri_footer",
    "generalAssesment" => "ri_general_assesment",
    "gaAdditional" => "ri_ga_additional",
    "gaRisk" => "ri_ga_risk"
  )

Definition at line 56 of file ui-report-conf.php.

UploadDao ui_report_conf::$uploadDao

private

UploadDao object

Definition at line 37 of file ui-report-conf.php.

UserDao ui_report_conf::$userDao

private

UserDao object

Definition at line 41 of file ui-report-conf.php.

---

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

• src/www/ui/ui-report-conf.php