Fossology\UI\Page\BrowseLicense Class Reference

Inheritance diagram for Fossology\UI\Page\BrowseLicense:

Collaboration diagram for Fossology\UI\Page\BrowseLicense:

Public Member Functions
	createLicenseHistogram ($uploadTreeId, $tagId, ItemTreeBounds $itemTreeBounds, $agentIds, $groupId)
	renderString ($templateName, $vars)
	getUploadHist ($itemTreeBounds)
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 ()

Public Attributes
const	NAME = "license"
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)
	createLicenseHistogramJSarray ($scannerLics, $editedLics, $licListUri)
Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	RegisterMenus ()
	Customize submenus.
	render ($templateName, $vars=null, $headers=null)
	getDefaultHeaders ()
	getDefaultVars ()
	mergeWithDefault ($vars)
	flushContent ($content)

Protected Attributes
	$agentNames = AgentRef::AGENT_LIST
Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
	$container
	$renderer
	$microMenu

Private Member Functions
	showUploadHist (ItemTreeBounds $itemTreeBounds)
	Given an $Uploadtree_pk, display: More...
	countFileListing (ItemTreeBounds $itemTreeBounds)

Private Attributes
	$uploadtree_tablename = ""
	$uploadDao
	$licenseDao
	$clearingDao
	$agentDao
	$clearingFilter
	$licenseProjector

Detailed Description

Definition at line 33 of file BrowseLicense.php.

Member Function Documentation

countFileListing()

Fossology\UI\Page\BrowseLicense::countFileListing ( ItemTreeBounds  $itemTreeBounds )

private

Parameters

ItemTreeBounds

$itemTreeBounds

Returns

array with keys 'isFlat','iTotalRecords','fileSwitch'

Definition at line 209 of file BrowseLicense.php.

createLicenseHistogram()

Fossology\UI\Page\BrowseLicense::createLicenseHistogram	(		$uploadTreeId,
			$tagId,
		ItemTreeBounds	$itemTreeBounds,
			$agentIds,
			$groupId
	)

Parameters

	$uploadTreeId
	$tagId
ItemTreeBounds	$itemTreeBounds
int | int[]	$agentIds
	ClearingDecision	[]

Returns

array

Definition at line 228 of file BrowseLicense.php.

createLicenseHistogramJSarray()

Fossology\UI\Page\BrowseLicense::createLicenseHistogramJSarray (   $scannerLics,   $editedLics,   $licListUri  )

protected

Parameters

array	$scannerLics
array	$editedLics
	string

Returns

array

Todo:

convert to template

Definition at line 276 of file BrowseLicense.php.

getUploadHist()

Fossology\UI\Page\BrowseLicense::getUploadHist

(

$itemTreeBounds

)

Get the upload histogram generated

Parameters

ItemTreeBounds

$itemTreeBounds

Returns

array

Definition at line 326 of file BrowseLicense.php.

handle()

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

protected

Parameters

Request

$request

Returns

Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 114 of file BrowseLicense.php.

renderString()

Fossology\UI\Page\BrowseLicense::renderString	(		$templateName,
			$vars
	)

Parameters

string	$templateName
array	$vars

Returns

string

Definition at line 316 of file BrowseLicense.php.

showUploadHist()

Fossology\UI\Page\BrowseLicense::showUploadHist ( ItemTreeBounds  $itemTreeBounds )

private

Given an $Uploadtree_pk, display:

• The histogram for the directory BY LICENSE.
• The file listing for the directory.

Definition at line 158 of file BrowseLicense.php.

---

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

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