Fossology\UI\Api\Models\LicenseDecision Class Reference

Inheritance diagram for Fossology\UI\Api\Models\LicenseDecision:

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

Public Member Functions
	__construct ($id, $shortName="", $fullName="", $text="", $url="", $sources=[], $acknowledgement="", $comment="", $isMainLicense=false, $obligations=null, $risk=null, $isRemoved=false, $isCandidate=false)
	getJSON ()
	getArray ()
	getSources ()
	setSources (array $sources)
	getAcknowledgement ()
	setAcknowledgement (string $acknowledgement)
	getComment ()
	setComment (string $comment)
	setIsRemoved (bool $isRemoved)
	getIsRemoved ()
	getIsMainLicense ()
	setIsMainLicense (bool $isMainLicense)
Public Member Functions inherited from Fossology\UI\Api\Models\License
	__construct ( $id, $shortName="", $fullName="", $text="", $url="", $obligations=null, $risk=null, $isCandidate=false)
	getId ()
	getShortName ()
	getFullName ()
	getText ()
	getUrl ()
	getRisk ()
	getIsCandidate ()
	getObligations ()
	getMergeRequest ()
	setShortName ($shortName)
	setFullName ($fullName)
	setText ($text)
	setUrl ($url)
	setRisk ($risk)
	setIsCandidate ($isCandidate)
	setObligations ($obligations)
	addObligation ($obligation)
	setMergeRequest ($mergeRequest)

Public Attributes
const	ALLOWED_KEYS
Public Attributes inherited from Fossology\UI\Api\Models\License
const	ALLOWED_KEYS

Private Attributes
	$sources
	$acknowledgement
	$comment
	$isMainLicense
	$isRemoved

Additional Inherited Members
Static Public Member Functions inherited from Fossology\UI\Api\Models\License
static	parseFromArray ($inputLicense)

Detailed Description

Definition at line 22 of file LicenseDecision.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\LicenseDecision::__construct	(		$id,
			$shortName = "",
			$fullName = "",
			$text = "",
			$url = "",
			$sources = [],
			$acknowledgement = "",
			$comment = "",
			$isMainLicense = false,
			$obligations = null,
			$risk = null,
			$isRemoved = false,
			$isCandidate = false
	)

Parameters

array	$sources
string	$acknowledgement
string	$comment

Definition at line 64 of file LicenseDecision.php.

Member Function Documentation

getAcknowledgement()

Fossology\UI\Api\Models\LicenseDecision::getAcknowledgement

(

)

Returns

string

Definition at line 137 of file LicenseDecision.php.

getArray()

Fossology\UI\Api\Models\LicenseDecision::getArray

(

)

Array representation of the license

Returns

array

Reimplemented from Fossology\UI\Api\Models\License.

Definition at line 107 of file LicenseDecision.php.

getComment()

Fossology\UI\Api\Models\LicenseDecision::getComment

(

)

Returns

string

Definition at line 153 of file LicenseDecision.php.

getIsMainLicense()

Fossology\UI\Api\Models\LicenseDecision::getIsMainLicense

(

)

Returns

bool

Definition at line 185 of file LicenseDecision.php.

getIsRemoved()

Fossology\UI\Api\Models\LicenseDecision::getIsRemoved

(

)

Returns

bool

Definition at line 177 of file LicenseDecision.php.

getJSON()

Fossology\UI\Api\Models\LicenseDecision::getJSON

(

)

JSON representation of the license

Returns

string

Reimplemented from Fossology\UI\Api\Models\License.

Definition at line 98 of file LicenseDecision.php.

getSources()

Fossology\UI\Api\Models\LicenseDecision::getSources

(

)

Returns

array

Definition at line 121 of file LicenseDecision.php.

setAcknowledgement()

Fossology\UI\Api\Models\LicenseDecision::setAcknowledgement

(

string

$acknowledgement

)

Parameters

string

$acknowledgement

Definition at line 145 of file LicenseDecision.php.

setComment()

Fossology\UI\Api\Models\LicenseDecision::setComment

(

string

$comment

)

Parameters

string

$comment

Definition at line 161 of file LicenseDecision.php.

setIsMainLicense()

Fossology\UI\Api\Models\LicenseDecision::setIsMainLicense

(

bool

$isMainLicense

)

Parameters

bool

$isMainLicense

Definition at line 193 of file LicenseDecision.php.

setIsRemoved()

Fossology\UI\Api\Models\LicenseDecision::setIsRemoved

(

bool

$isRemoved

)

Parameters

bool

$isRemoved

Definition at line 169 of file LicenseDecision.php.

setSources()

Fossology\UI\Api\Models\LicenseDecision::setSources

(

array

$sources

)

Parameters

array

$sources

Definition at line 129 of file LicenseDecision.php.

Member Data Documentation

$acknowledgement

string Fossology\UI\Api\Models\LicenseDecision::$acknowledgement

private

acknowledgement of the license

Definition at line 40 of file LicenseDecision.php.

$comment

string Fossology\UI\Api\Models\LicenseDecision::$comment

private

The comment of the license

Definition at line 45 of file LicenseDecision.php.

$isMainLicense

bool Fossology\UI\Api\Models\LicenseDecision::$isMainLicense

private

The main license

Definition at line 51 of file LicenseDecision.php.

$isRemoved

bool Fossology\UI\Api\Models\LicenseDecision::$isRemoved

private

The removed license

Definition at line 57 of file LicenseDecision.php.

$sources

array Fossology\UI\Api\Models\LicenseDecision::$sources

private

source of the license

Definition at line 35 of file LicenseDecision.php.

ALLOWED_KEYS

const Fossology\UI\Api\Models\LicenseDecision::ALLOWED_KEYS

Initial value:

= ['shortName', 'fullName', 'text', 'url', 'risk',
    'isCandidate', 'mergeRequest', 'source', 'acknowledgement', 'comment']

Definition at line 28 of file LicenseDecision.php.

---

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

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