Inheritance diagram for Fossology\UI\Page\AdminLicenseCompatibilityRules:

Collaboration diagram for Fossology\UI\Page\AdminLicenseCompatibilityRules:

Public Attributes
const	NAME = "admin_license_compatibility_rules"

const	UPDATE_PARAM_NAME = "formUpdated"

const	RULE_ID_PARAM_NAME = "licenseRuleLrPK"

const	INSERT_FIRST_LIC_TYPE_PARAM_NAME = "insertFirstLicType"

const	FIRST_LIC_TYPE_PARAM_NAME = "firstLicenseType"

const	INSERT_SECOND_LIC_TYPE_PARAM_NAME = "insertSecondLicType"

const	SECOND_LIC_TYPE_PARAM_NAME = "secondLicenseType"

const	INSERT_FIRST_LIC_NAME_PARAM_NAME = "insertFirstLicName"

const	FIRST_LIC_NAME_PARAM_NAME = "firstLicenseName"

const	INSERT_SECOND_LIC_NAME_PARAM_NAME = "insertSecondLicName"

const	SECOND_LIC_NAME_PARAM_NAME = "secondLicenseName"

const	INSERT_TEXT_PARAM_NAME = "insertLicRuleText"

const	TEXT_PARAM_NAME = "licenseRuleText"

const	INSERT_RESULT_PARAM_NAME = "insertLicCompatibilityResult"

const	RESULT_PARAM_NAME = "licCompatibilityResult"

Public Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
const	PERMISSION = "permission"

const	REQUIRES_LOGIN = "requiresLogin"

const	ENABLE_MENU = "ENABLE_MENU"

const	LEVEL = "level"

const	DEPENDENCIES = "dependencies"

const	INIT_ORDER = "initOrder"

const	MENU_LIST = "menuList"

const	MENU_ORDER = "menuOrder"

const	MENU_TARGET = "menuTarget"

const	TITLE = "title"

	$fileLogger

Protected Member Functions
	handle (Request $request)

Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	RegisterMenus ()
	Customize submenus.

	render ($templateName, $vars=null, $headers=null)

	getDefaultHeaders ()

	getDefaultVars ()

	mergeWithDefault ($vars)

	flushContent ($content)

Private Member Functions
	fetchLicenseData ()
	Fetch the available license data. More...

	fetchRules (Request $request)
	Fetch the compatibility rules based on search query and pagination. More...

	addRule ()
	Add a new empty compatibility rule. More...

	updateRules (Request $request)
	Update the already existing rules. More...

	insertRules ($firstNameArray, $secondNameArray, $firstTypeArray, $secondTypeArray, $commentArray, $resultArray)
	Insert new rules from the UI. More...

	deleteRules (Request $request)
	Delete a rule from the UI. More...

Private Attributes
	$compatibilityDao

	$licenseDao

Additional Inherited Members
Public Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	__construct ($name, $parameters=array())

	getName ()

	getVersion ()

	getTitle ()

	isRequiresLogin ()

	getDependency ()

	getPluginLevel ()

	getDBaccess ()

	getState ()

	getInitOrder ()

	getNoMenu ()

	getResponse ()

	getObject ($name)

	preInstall ()

	postInstall ()

	unInstall ()

	execute ()

	isLoggedIn ()

	__get ($name)

	__toString ()

Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
	$container

	$renderer

	$microMenu

Detailed Description

Page to allow users to manage the license compatibility rules.

Definition at line 26 of file AdminLicenseCompatibilityRules.php.

Member Function Documentation

◆ addRule()

Fossology\UI\Page\AdminLicenseCompatibilityRules::addRule ( )

private

Add a new empty compatibility rule.

Returns: JsonResponse

Definition at line 243 of file AdminLicenseCompatibilityRules.php.

◆ deleteRules()

Fossology\UI\Page\AdminLicenseCompatibilityRules::deleteRules ( Request $request )

private

Delete a rule from the UI.

Parameters

Request $request

Returns: array If 1 then rule is deleted otherwise not

Definition at line 403 of file AdminLicenseCompatibilityRules.php.

◆ fetchLicenseData()

Fossology\UI\Page\AdminLicenseCompatibilityRules::fetchLicenseData ( )

private

Fetch the available license data.

Returns: JsonResponse

Definition at line 191 of file AdminLicenseCompatibilityRules.php.

◆ fetchRules()

Fossology\UI\Page\AdminLicenseCompatibilityRules::fetchRules ( Request $request )

private

Fetch the compatibility rules based on search query and pagination.

Parameters

Request $request The request containing query parameters for pagination and search

Returns: JsonResponse

Definition at line 217 of file AdminLicenseCompatibilityRules.php.

◆ handle()

Fossology\UI\Page\AdminLicenseCompatibilityRules::handle ( Request $request )

protected

Parameters

Request $request

Returns: Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 148 of file AdminLicenseCompatibilityRules.php.

◆ insertRules()

Fossology\UI\Page\AdminLicenseCompatibilityRules::insertRules	(	$firstNameArray,
		$secondNameArray,
		$firstTypeArray,
		$secondTypeArray,
		$commentArray,
		$resultArray
	)

private

Insert new rules from the UI.

Parameters

array	$firstNameArray
array	$secondNameArray
array	$firstTypeArray
array	$secondTypeArray
array	$commentArray
array	$resultArray

Returns: array Containing the status whether rule is inserted or not

Definition at line 354 of file AdminLicenseCompatibilityRules.php.

◆ updateRules()

Fossology\UI\Page\AdminLicenseCompatibilityRules::updateRules ( Request $request )

private

Update the already existing rules.

Parameters

Request $request

Returns: array Containing the updated values of the licenses

Definition at line 257 of file AdminLicenseCompatibilityRules.php.

Member Data Documentation

◆ $compatibilityDao

CompatibilityDao Fossology\UI\Page\AdminLicenseCompatibilityRules::$compatibilityDao

private

Compatibility DAO in use

Definition at line 123 of file AdminLicenseCompatibilityRules.php.

◆ $licenseDao

LicenseDao Fossology\UI\Page\AdminLicenseCompatibilityRules::$licenseDao

private

License DAO in use

Definition at line 129 of file AdminLicenseCompatibilityRules.php.

◆ FIRST_LIC_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::FIRST_LIC_NAME_PARAM_NAME = "firstLicenseName"

Parameter storing the license name

Definition at line 81 of file AdminLicenseCompatibilityRules.php.

◆ FIRST_LIC_TYPE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::FIRST_LIC_TYPE_PARAM_NAME = "firstLicenseType"

Parameter storing the license type

Definition at line 57 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_FIRST_LIC_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_FIRST_LIC_NAME_PARAM_NAME = "insertFirstLicName"

Parameter storing the new license name

Definition at line 75 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_FIRST_LIC_TYPE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_FIRST_LIC_TYPE_PARAM_NAME = "insertFirstLicType"

Parameter storing the new license type

Definition at line 51 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_RESULT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_RESULT_PARAM_NAME = "insertLicCompatibilityResult"

Parameter storing the new compatibility result

Definition at line 111 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_SECOND_LIC_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_SECOND_LIC_NAME_PARAM_NAME = "insertSecondLicName"

Parameter storing the new license name

Definition at line 87 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_SECOND_LIC_TYPE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_SECOND_LIC_TYPE_PARAM_NAME = "insertSecondLicType"

Parameter storing the new license type

Definition at line 63 of file AdminLicenseCompatibilityRules.php.

◆ INSERT_TEXT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::INSERT_TEXT_PARAM_NAME = "insertLicRuleText"

Parameter storing the new rule description

Definition at line 99 of file AdminLicenseCompatibilityRules.php.

◆ NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::NAME = "admin_license_compatibility_rules"

Mod name

Definition at line 33 of file AdminLicenseCompatibilityRules.php.

◆ RESULT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::RESULT_PARAM_NAME = "licCompatibilityResult"

Parameter storing the compatibility result

Definition at line 117 of file AdminLicenseCompatibilityRules.php.

◆ RULE_ID_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::RULE_ID_PARAM_NAME = "licenseRuleLrPK"

Parameter storing the rule IDs

Definition at line 45 of file AdminLicenseCompatibilityRules.php.

◆ SECOND_LIC_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::SECOND_LIC_NAME_PARAM_NAME = "secondLicenseName"

Parameter storing the license name

Definition at line 93 of file AdminLicenseCompatibilityRules.php.

◆ SECOND_LIC_TYPE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::SECOND_LIC_TYPE_PARAM_NAME = "secondLicenseType"

Parameter storing the license type

Definition at line 69 of file AdminLicenseCompatibilityRules.php.

◆ TEXT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::TEXT_PARAM_NAME = "licenseRuleText"

Parameter storing the rule description

Definition at line 105 of file AdminLicenseCompatibilityRules.php.

◆ UPDATE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseCompatibilityRules::UPDATE_PARAM_NAME = "formUpdated"

Name of the parameter to denote form submit

Definition at line 39 of file AdminLicenseCompatibilityRules.php.

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

src/www/ui/page/AdminLicenseCompatibilityRules.php

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRule()

◆ deleteRules()

◆ fetchLicenseData()

◆ fetchRules()

◆ handle()

◆ insertRules()

◆ updateRules()

Member Data Documentation

◆ $compatibilityDao

◆ $licenseDao

◆ FIRST_LIC_NAME_PARAM_NAME

◆ FIRST_LIC_TYPE_PARAM_NAME

◆ INSERT_FIRST_LIC_NAME_PARAM_NAME

◆ INSERT_FIRST_LIC_TYPE_PARAM_NAME

◆ INSERT_RESULT_PARAM_NAME

◆ INSERT_SECOND_LIC_NAME_PARAM_NAME

◆ INSERT_SECOND_LIC_TYPE_PARAM_NAME

◆ INSERT_TEXT_PARAM_NAME

◆ NAME

◆ RESULT_PARAM_NAME

◆ RULE_ID_PARAM_NAME

◆ SECOND_LIC_NAME_PARAM_NAME

◆ SECOND_LIC_TYPE_PARAM_NAME

◆ TEXT_PARAM_NAME

◆ UPDATE_PARAM_NAME