Fossology\ReadmeOSS\UI\ReadMeOssPlugin Class Reference

Agent plugin for Readme_OSS agent. More...

Inheritance diagram for Fossology\ReadmeOSS\UI\ReadMeOssPlugin:

Collaboration diagram for Fossology\ReadmeOSS\UI\ReadMeOssPlugin:

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_readmeoss'
	Mod name for the plugin.
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)
	getJobAndJobqueue ($groupId, $upload, $addUploads)
	Get parameters from job queue and schedule them. More...
Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	RegisterMenus ()
	Customize submenus.
	render ($templateName, $vars=null, $headers=null)
	getDefaultHeaders ()
	getDefaultVars ()
	mergeWithDefault ($vars)
	flushContent ($content)

Additional Inherited Members
Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
	$container
	$renderer
	$microMenu

Detailed Description

Agent plugin for Readme_OSS agent.

Definition at line 26 of file ReadMeOssPlugin.php.

Member Function Documentation

getJobAndJobqueue()

Fossology\ReadmeOSS\UI\ReadMeOssPlugin::getJobAndJobqueue (   $groupId,   $upload,   $addUploads  )

protected

Get parameters from job queue and schedule them.

Parameters

int	$groupId
int	$upload
int	$addUploads

Exceptions

Exception

Returns

int Array of job id and job queue id

Definition at line 111 of file ReadMeOssPlugin.php.

handle()

Fossology\ReadmeOSS\UI\ReadMeOssPlugin::handle ( Request  $request )

protected

Parameters

Request

$request

Returns

Response

See also

Fossology::Lib::Plugin::DefaultPlugin::handle()

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 55 of file ReadMeOssPlugin.php.

preInstall()

Fossology\ReadmeOSS\UI\ReadMeOssPlugin::preInstall

(

)

See also

Fossology::Lib::Plugin::DefaultPlugin::preInstall()

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 43 of file ReadMeOssPlugin.php.

scheduleAgent()

Fossology\ReadmeOSS\UI\ReadMeOssPlugin::scheduleAgent	(		$groupId,
			$upload,
			$addUploads = array()
	)

Schedules readme OSS 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 182 of file ReadMeOssPlugin.php.

---

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

• src/readmeoss/ui/ReadMeOssPlugin.php