Fossology\UI\Page\AdminLicenseAcknowledgements Class Reference

Inheritance diagram for Fossology\UI\Page\AdminLicenseAcknowledgements:

Collaboration diagram for Fossology\UI\Page\AdminLicenseAcknowledgements:

Public Attributes
const	NAME = "admin_license_acknowledgements"
const	ACKNOWLEDGEMENT_UPDATE_PARAM_NAME = "formUpdated"
const	ACKNOWLEDGEMENT_PARAM_NAME = "licenseAcknowledgement"
const	ACKNOWLEDGEMENT_ID_PARAM_NAME = "licenseAcknowledgementLaPK"
const	ACKNOWLEDGEMENT_NAME_PARAM_NAME = "licenseAcknowledgementName"
const	INSERT_ACKNOWLEDGEMENT_NAME_PARAM = "insertLicNames"
const	ACKNOWLEDGEMENT_INSERT_PARAM_NAME = "insertLicAcknowledgements"
const	ACKNOWLEDGEMENT_ENABLE_PARAM_NAME = "licAcknowledgementEnabled"
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"

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
	updateAcknowledgements (Request $request)
	insertAcknowledgements ($namesArray, $acknowledgementsArray)

Private Attributes
	$licenseAcknowledgementDao

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 standard license acknowledgements.

Definition at line 26 of file AdminLicenseAcknowledgements.php.

Member Function Documentation

handle()

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

protected

Parameters

Request

$request

Returns

Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 99 of file AdminLicenseAcknowledgements.php.

insertAcknowledgements()

Fossology\UI\Page\AdminLicenseAcknowledgements::insertAcknowledgements (   $namesArray,   $acknowledgementsArray  )

private

Insert new acknowledgements

Parameters

array	$namesArray	Array containing new names
array	$acknowledgementsArray	Array containing new acknowledgements

Returns

number[]

Definition at line 165 of file AdminLicenseAcknowledgements.php.

updateAcknowledgements()

Fossology\UI\Page\AdminLicenseAcknowledgements::updateAcknowledgements ( Request  $request )

private

Get the parameters from the request and update the acknowledgements.

Parameters

Request

$request

The request

Returns

array Number of acknowledgements updated/inserted as value of corresponding keys, or error (if any).

Definition at line 125 of file AdminLicenseAcknowledgements.php.

Member Data Documentation

$licenseAcknowledgementDao

LicenseAcknowledgementDao Fossology\UI\Page\AdminLicenseAcknowledgements::$licenseAcknowledgementDao

private

License acknowledgement DAO in use

Definition at line 81 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_ENABLE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_ENABLE_PARAM_NAME = "licAcknowledgementEnabled"

Parameter storing the acknowledgement status

Definition at line 75 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_ID_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_ID_PARAM_NAME = "licenseAcknowledgementLaPK"

Parameter storing the acknowledgement IDs

Definition at line 51 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_INSERT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_INSERT_PARAM_NAME = "insertLicAcknowledgements"

Parameter storing the new acknowledgements

Definition at line 69 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_NAME_PARAM_NAME = "licenseAcknowledgementName"

Parameter storing the acknowledgements

Definition at line 57 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_PARAM_NAME = "licenseAcknowledgement"

Parameter storing the acknowledgement names

Definition at line 45 of file AdminLicenseAcknowledgements.php.

ACKNOWLEDGEMENT_UPDATE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::ACKNOWLEDGEMENT_UPDATE_PARAM_NAME = "formUpdated"

Name of the parameter to denote form submit

Definition at line 39 of file AdminLicenseAcknowledgements.php.

INSERT_ACKNOWLEDGEMENT_NAME_PARAM

string Fossology\UI\Page\AdminLicenseAcknowledgements::INSERT_ACKNOWLEDGEMENT_NAME_PARAM = "insertLicNames"

Parameter storing the new names

Definition at line 63 of file AdminLicenseAcknowledgements.php.

NAME

string Fossology\UI\Page\AdminLicenseAcknowledgements::NAME = "admin_license_acknowledgements"

Mod name

Definition at line 33 of file AdminLicenseAcknowledgements.php.

---

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

• src/www/ui/page/AdminLicenseAcknowledgements.php