AgentAdder Class Reference

Inheritance diagram for AgentAdder:

Collaboration diagram for AgentAdder:

Public Member Functions
	scheduleAgents ($uploadId, $agentsToStart, Request $request)
	Add an upload to multiple agents (wrapper for agentsAdd()). More...
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 = "agent_add"
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.
	handle (Request $request)
	render ($templateName, $vars=null, $headers=null)
	getDefaultHeaders ()
	getDefaultVars ()
	mergeWithDefault ($vars)
	flushContent ($content)

Private Member Functions
	agentsAdd ($uploadId, $agentsToStart, Request $request)
	Add an upload to multiple agents. More...

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

Detailed Description

Definition at line 26 of file agent-add.php.

Member Function Documentation

AgentAdder::agentsAdd (   $uploadId,   $agentsToStart, Request  $request  )

private

Add an upload to multiple agents.

Parameters

int	$uploadId
	string[]	$agentsToStart - list of agents

Returns

integer Job ID on success, error message string on failure

Definition at line 99 of file agent-add.php.

AgentAdder::handle ( Request  $request )

protected

Parameters

Request

$request

Returns

Response

Definition at line 43 of file agent-add.php.

AgentAdder::scheduleAgents	(		$uploadId,
			$agentsToStart,
		Request	$request
	)

Add an upload to multiple agents (wrapper for agentsAdd()).

Parameters

int	$uploadId
	string[]	$agentsToStart - list of agents

Returns

integer Job ID on success, error message string on failure

See also

agentsAdd()

Definition at line 151 of file agent-add.php.

---

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

• src/www/ui/agent-add.php