Fossology\UI\Api\Models\Agent Class Reference

Collaboration diagram for Fossology\UI\Api\Models\Agent:

Public Member Functions
	__construct ($successfulAgents, $uploadId, $agentName, $currentAgentId, $currentAgentRev, $isAgentRunning)
	getSuccessfulAgents ()
	getUploadId ()
	getAgentName ()
	getCurrentAgentId ()
	getCurrentAgentRev ()
	getIsAgentRunning ()
	getJSON ($version=ApiVersion::V1)
	getArray ($version=ApiVersion::V1)
	setSuccessfulAgents ($successfulAgents)
	setUploadId ($uploadId)
	setAgentName ($agentName)
	setCurrentAgentId ($currentAgentId)
	setCurrentAgentRev ($currentAgentRev)
	setIsAgentRunning ($isAgentRunning)

Private Attributes
	$successfulAgents
	$uploadId
	$agentName
	$currentAgentId
	$currentAgentRev
	$isAgentRunning

Detailed Description

Definition at line 14 of file Agent.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\Agent::__construct	(		$successfulAgents,
			$uploadId,
			$agentName,
			$currentAgentId,
			$currentAgentRev,
			$isAgentRunning
	)

Parameters

integer	$agentId
string	$agentRev
string	$agentName

Definition at line 52 of file Agent.php.

Member Function Documentation

getAgentName()

Fossology\UI\Api\Models\Agent::getAgentName

(

)

Returns

string

Definition at line 80 of file Agent.php.

getArray()

Fossology\UI\Api\Models\Agent::getArray

(

$version = ApiVersion::V1

)

Get ScannedLicense element as associative array

Parameters

integer

$version

Returns

array

Definition at line 125 of file Agent.php.

getCurrentAgentId()

Fossology\UI\Api\Models\Agent::getCurrentAgentId

(

)

Returns

integer

Definition at line 88 of file Agent.php.

getCurrentAgentRev()

Fossology\UI\Api\Models\Agent::getCurrentAgentRev

(

)

Returns

string

Definition at line 96 of file Agent.php.

getIsAgentRunning()

Fossology\UI\Api\Models\Agent::getIsAgentRunning

(

)

Returns

bool

Definition at line 104 of file Agent.php.

getJSON()

Fossology\UI\Api\Models\Agent::getJSON

(

$version = ApiVersion::V1

)

JSON representation of current scannedLicense

Parameters

integer

$version

Returns

string

Definition at line 115 of file Agent.php.

getSuccessfulAgents()

Fossology\UI\Api\Models\Agent::getSuccessfulAgents

(

)

Returns

array

Definition at line 64 of file Agent.php.

getUploadId()

Fossology\UI\Api\Models\Agent::getUploadId

(

)

Returns

integer

Definition at line 72 of file Agent.php.

setAgentName()

Fossology\UI\Api\Models\Agent::setAgentName

(

$agentName

)

Parameters

string

$agentName

Definition at line 156 of file Agent.php.

setCurrentAgentId()

Fossology\UI\Api\Models\Agent::setCurrentAgentId

(

$currentAgentId

)

Parameters

integer

$currentAgentId

Definition at line 164 of file Agent.php.

setCurrentAgentRev()

Fossology\UI\Api\Models\Agent::setCurrentAgentRev

(

$currentAgentRev

)

Parameters

string

$currentAgentRev

Definition at line 172 of file Agent.php.

setIsAgentRunning()

Fossology\UI\Api\Models\Agent::setIsAgentRunning

(

$isAgentRunning

)

Parameters

bool

$isAgentRunning

Definition at line 180 of file Agent.php.

setSuccessfulAgents()

Fossology\UI\Api\Models\Agent::setSuccessfulAgents

(

$successfulAgents

)

Parameters

array

$successfulAgents

Definition at line 140 of file Agent.php.

setUploadId()

Fossology\UI\Api\Models\Agent::setUploadId

(

$uploadId

)

Parameters

integer

$uploadId

Definition at line 148 of file Agent.php.

Member Data Documentation

$agentName

string Fossology\UI\Api\Models\Agent::$agentName

private

Agent's name

Definition at line 30 of file Agent.php.

$currentAgentId

integer Fossology\UI\Api\Models\Agent::$currentAgentId

private

Current agent id

Definition at line 35 of file Agent.php.

$currentAgentRev

string Fossology\UI\Api\Models\Agent::$currentAgentRev

private

Current agent's rev

Definition at line 40 of file Agent.php.

$successfulAgents

array Fossology\UI\Api\Models\Agent::$successfulAgents

private

Successful agents

Definition at line 20 of file Agent.php.

$uploadId

integer Fossology\UI\Api\Models\Agent::$uploadId

private

Upload id

Definition at line 25 of file Agent.php.

---

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

• src/www/ui/api/Models/Agent.php