Fossology\CliXml\UI\CliXmlGeneratorUi Class Reference

Inheritance diagram for Fossology\CliXml\UI\CliXmlGeneratorUi:

Collaboration diagram for Fossology\CliXml\UI\CliXmlGeneratorUi:

Public Member Functions
	preInstall ()
	scheduleAgent ($groupId, $upload, $addUploads=array())
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)
	postInstall ()
	unInstall ()
	execute ()
	isLoggedIn ()
	__get ($name)
	__toString ()

Public Attributes
const	NAME = 'ui_clixml'
const	DEFAULT_OUTPUT_FORMAT = "clixml"
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)
	uploadsAdd ($uploads)
	getJobAndJobqueue ($groupId, $upload, $addUploads)
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
	$outputFormat = self::DEFAULT_OUTPUT_FORMAT
Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
	$container
	$renderer
	$microMenu

Detailed Description

Definition at line 18 of file CliXmlGeneratorUi.php.

Member Function Documentation

handle()

Fossology\CliXml\UI\CliXmlGeneratorUi::handle ( Request  $request )

protected

Parameters

Request

$request

Returns

Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 48 of file CliXmlGeneratorUi.php.

scheduleAgent()

Fossology\CliXml\UI\CliXmlGeneratorUi::scheduleAgent	(		$groupId,
			$upload,
			$addUploads = array()
	)

Schedules CLIXML agent to generate report

Parameters

int	$groupId
Upload	$upload
array	$addUploads

Returns

array|number[] Job id and job queue id

Exceptions

Exception

Definition at line 169 of file CliXmlGeneratorUi.php.

---

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

• src/clixml/ui/CliXmlGeneratorUi.php