Fossology\UI\Page\AdminLicenseStdComments Class Reference

Inheritance diagram for Fossology\UI\Page\AdminLicenseStdComments:

Collaboration diagram for Fossology\UI\Page\AdminLicenseStdComments:

Public Attributes
const	NAME = "admin_license_std_comments"
const	UPDATE_PARAM_NAME = "formUpdated"
const	COMMENT_PARAM_NAME = "licenseStdComment"
const	COMMENT_ID_PARAM_NAME = "licenseCommentLscPK"
const	COMMENT_NAME_PARAM_NAME = "licenseCommentName"
const	INSERT_NAME_PARAM_NAME = "insertStdLicNames"
const	INSERT_COMMENT_PARAM_NAME = "insertStdLicComments"
const	ENABLE_PARAM_NAME = "stdLicCommentEnabled"
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
	updateComments (Request $request)
	insertComments ($namesArray, $commentsArray)

Private Attributes
	$licenseCommentDao

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 comments.

Definition at line 26 of file AdminLicenseStdComments.php.

Member Function Documentation

handle()

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

protected

Parameters

Request

$request

Returns

Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 99 of file AdminLicenseStdComments.php.

insertComments()

Fossology\UI\Page\AdminLicenseStdComments::insertComments (   $namesArray,   $commentsArray  )

private

Insert new comments

Parameters

array	$namesArray	Array containing new names
array	$commentsArray	Array containing new comments

Returns

number[]

Definition at line 165 of file AdminLicenseStdComments.php.

updateComments()

Fossology\UI\Page\AdminLicenseStdComments::updateComments ( Request  $request )

private

Get the parameters from the request and update the comments.

Parameters

Request

$request

The request

Returns

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

Definition at line 125 of file AdminLicenseStdComments.php.

Member Data Documentation

$licenseCommentDao

LicenseStdCommentDao Fossology\UI\Page\AdminLicenseStdComments::$licenseCommentDao

private

License comment DAO in use

Definition at line 81 of file AdminLicenseStdComments.php.

COMMENT_ID_PARAM_NAME

string Fossology\UI\Page\AdminLicenseStdComments::COMMENT_ID_PARAM_NAME = "licenseCommentLscPK"

Parameter storing the comment IDs

Definition at line 51 of file AdminLicenseStdComments.php.

COMMENT_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseStdComments::COMMENT_NAME_PARAM_NAME = "licenseCommentName"

Parameter storing the comments

Definition at line 57 of file AdminLicenseStdComments.php.

COMMENT_PARAM_NAME

string Fossology\UI\Page\AdminLicenseStdComments::COMMENT_PARAM_NAME = "licenseStdComment"

Parameter storing the comment names

Definition at line 45 of file AdminLicenseStdComments.php.

ENABLE_PARAM_NAME

string Fossology\UI\Page\AdminLicenseStdComments::ENABLE_PARAM_NAME = "stdLicCommentEnabled"

Parameter storing the comment status

Definition at line 75 of file AdminLicenseStdComments.php.

INSERT_NAME_PARAM_NAME

string Fossology\UI\Page\AdminLicenseStdComments::INSERT_NAME_PARAM_NAME = "insertStdLicNames"

Parameter storing the new names

Parameter storing the new comments

Definition at line 63 of file AdminLicenseStdComments.php.

NAME

string Fossology\UI\Page\AdminLicenseStdComments::NAME = "admin_license_std_comments"

Mod name

Definition at line 33 of file AdminLicenseStdComments.php.

UPDATE_PARAM_NAME

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

Name of the parameter to denote form submit

Definition at line 39 of file AdminLicenseStdComments.php.

---

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

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