ui_report_conf Class Reference

Inheritance diagram for ui_report_conf:

Collaboration diagram for ui_report_conf:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...
	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.
	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...
	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.)
	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 ($listParams)
	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
	$radioListUR
	$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 18 of file ui-report-conf.php.

Constructor & Destructor Documentation

__construct()

ui_report_conf::__construct

(

)

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns

true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

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

Member Function Documentation

allReportConfiguration()

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 146 of file ui-report-conf.php.

createScriptBlock()

ui_report_conf::createScriptBlock ( )

protected

Create Script block for conf.

Returns

string JavaScript block

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

getAllObligationsForGivenUploadId()

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 255 of file ui-report-conf.php.

getCheckBoxSelectionList()

ui_report_conf::getCheckBoxSelectionList (   $listParams )

protected

Parameters

array

$listParams

Returns

string

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

Member Data Documentation

$checkBoxListSPDX

array ui_report_conf::$checkBoxListSPDX

private

Initial value:

= array(
    "spdxLicenseComment" => "spdxLicenseComment",
    "ignoreFilesWOInfo" => "ignoreFilesWOInfo"
  )

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

$clearingDao

ClearingDao ui_report_conf::$clearingDao

private

ClearingDao object

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

$licenseDao

LicenseDao ui_report_conf::$licenseDao

private

LicenseDao object

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

$mapDBColumns

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",
    "componentType" => "ri_component_type",
    "componentId" => "ri_component_id",
    "footerNote" => "ri_footer",
    "generalAssesment" => "ri_general_assesment",
    "gaAdditional" => "ri_ga_additional",
    "gaRisk" => "ri_ga_risk",
    "dependencyBinarySource" => "ri_depnotes",
    "exportRestrictionText" => "ri_exportnotes",
    "copyrightRestrictionText" => "ri_copyrightnotes"
  )

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

$radioListUR

array ui_report_conf::$radioListUR

private

Initial value:

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

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

$uploadDao

UploadDao ui_report_conf::$uploadDao

private

UploadDao object

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

$userDao

UserDao ui_report_conf::$userDao

private

UserDao object

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

---

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

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