Fossology\Reuser\ReuserAgentPlugin Class Reference

UI element for reuser during Uploading new package. More...

Inheritance diagram for Fossology\Reuser\ReuserAgentPlugin:

Collaboration diagram for Fossology\Reuser\ReuserAgentPlugin:

Public Member Functions
	renderContent (&$vars)
	Render twig templates for plugin_reuser. More...
	renderFoot (&$vars)
	Render footer twig templates for plugin_reuser. More...
	preInstall ()
	scheduleAgent ($jobId, $uploadId, &$errorMsg, $request)
	Get parameters from request and add to job queue. More...
Public Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	execute ()
	postInstall ()
	unInstall ()
	getName ()
	AgentHasResults ($uploadId=0)
	AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=null)
	__toString ()

Public Attributes
const	UPLOAD_TO_REUSE_SELECTOR_NAME = 'uploadToReuse'
	Form element name for main license to reuse.
Public Attributes inherited from Fossology\Lib\Plugin\AgentPlugin
const	PRE_JOB_QUEUE = 'preJq'
	$AgentName
	$Name = "agent_abstract"
	$Dependency = array()
	$Title = 'how to show checkbox'
	$PluginLevel = 10
	$State = PLUGIN_STATE_READY
	$DBaccess = PLUGIN_DB_WRITE

Protected Member Functions
	createPackageLink ($uploadId, $reuseUploadId, $groupId, $reuseGroupId, $reuseMode=0)
	Create links between old and new upload. More...
Protected Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	doAgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs="", $jq_cmd_args=null)
	implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency)

Private Attributes
	$uploadDao

Detailed Description

UI element for reuser during Uploading new package.

Definition at line 30 of file agent-reuser.php.

Member Function Documentation

createPackageLink()

Fossology\Reuser\ReuserAgentPlugin::createPackageLink (   $uploadId,   $reuseUploadId,   $groupId,   $reuseGroupId,   $reuseMode = 0  )

protected

Create links between old and new upload.

Parameters

int	$uploadId
int	$reuseUploadId
int	$groupId
int	$reuseGroupId
int	$reuseMode

Definition at line 140 of file agent-reuser.php.

preInstall()

Fossology\Reuser\ReuserAgentPlugin::preInstall

(

)

See also

Fossology::Lib::Plugin::AgentPlugin::preInstall()

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 76 of file agent-reuser.php.

renderContent()

Fossology\Reuser\ReuserAgentPlugin::renderContent

(

&

$vars

)

Render twig templates for plugin_reuser.

Parameters

array

$vars

Variables for twig template

Returns

string Rendered HTML

Definition at line 55 of file agent-reuser.php.

renderFoot()

Fossology\Reuser\ReuserAgentPlugin::renderFoot

(

&

$vars

)

Render footer twig templates for plugin_reuser.

Parameters

array

$vars

Variables for twig template

Returns

string Rendered HTML

Definition at line 66 of file agent-reuser.php.

scheduleAgent()

Fossology\Reuser\ReuserAgentPlugin::scheduleAgent	(		$jobId,
			$uploadId,
		&	$errorMsg,
			$request
	)

Get parameters from request and add to job queue.

Parameters

	int	$jobId	Job id to add to
	int	$uploadId	Upload id to add to
[out]	string	$errorMsg	Error message to display
	Request	$request	HTML request

Returns

int Job queue id

Definition at line 89 of file agent-reuser.php.

Member Data Documentation

$uploadDao

UploadDao Fossology\Reuser\ReuserAgentPlugin::$uploadDao

private

Upload Dao object

Definition at line 37 of file agent-reuser.php.

---

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

• src/reuser/ui/agent-reuser.php