Fossology\UI\Api\Models\LicenseStandardComment Class Reference

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

Public Member Functions
	__construct ($id, $name, $comment, $isEnabled)
	getId ()
	getName ()
	getComment ()
	getIsEnabled ()
	getJSON ($version=ApiVersion::V1)
	getArray ($version=ApiVersion::V1)
	setId ($id)
	setName ($name)
	setComment ($comment)
	setIsEnabled ($isEnabled)

Private Attributes
	$id
	$name
	$comment
	$isEnabled

Detailed Description

Definition at line 13 of file LicenseStandardComment.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\LicenseStandardComment::__construct	(		$id,
			$name,
			$comment,
			$isEnabled
	)

Parameters

int	$id
string	$name
string	$comment
boolean	$isEnabled

Definition at line 42 of file LicenseStandardComment.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\LicenseStandardComment::getArray

(

$version = ApiVersion::V1

)

Get ScannedLicense element as associative array

Parameters

integer

$version

Returns

array

Definition at line 99 of file LicenseStandardComment.php.

getComment()

Fossology\UI\Api\Models\LicenseStandardComment::getComment

(

)

Returns

string

Definition at line 69 of file LicenseStandardComment.php.

getId()

Fossology\UI\Api\Models\LicenseStandardComment::getId

(

)

Returns

int

Definition at line 53 of file LicenseStandardComment.php.

getIsEnabled()

Fossology\UI\Api\Models\LicenseStandardComment::getIsEnabled

(

)

Returns

boolean

Definition at line 77 of file LicenseStandardComment.php.

getJSON()

Fossology\UI\Api\Models\LicenseStandardComment::getJSON

(

$version = ApiVersion::V1

)

JSON representation of current scannedLicense

Parameters

integer

$version

Returns

string

Definition at line 89 of file LicenseStandardComment.php.

getName()

Fossology\UI\Api\Models\LicenseStandardComment::getName

(

)

Returns

string

Definition at line 61 of file LicenseStandardComment.php.

setComment()

Fossology\UI\Api\Models\LicenseStandardComment::setComment

(

$comment

)

Parameters

string

$comment

Definition at line 136 of file LicenseStandardComment.php.

setId()

Fossology\UI\Api\Models\LicenseStandardComment::setId

(

$id

)

Parameters

int

$id

Definition at line 120 of file LicenseStandardComment.php.

setIsEnabled()

Fossology\UI\Api\Models\LicenseStandardComment::setIsEnabled

(

$isEnabled

)

Parameters

boolean

$isEnabled

Definition at line 144 of file LicenseStandardComment.php.

setName()

Fossology\UI\Api\Models\LicenseStandardComment::setName

(

$name

)

Parameters

string

$name

Definition at line 128 of file LicenseStandardComment.php.

Member Data Documentation

$comment

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

private

Comment text

Definition at line 29 of file LicenseStandardComment.php.

$id

int Fossology\UI\Api\Models\LicenseStandardComment::$id

private

Id for comment

Definition at line 19 of file LicenseStandardComment.php.

$isEnabled

boolean Fossology\UI\Api\Models\LicenseStandardComment::$isEnabled

private

Comment is enabled or not

Definition at line 34 of file LicenseStandardComment.php.

$name

string Fossology\UI\Api\Models\LicenseStandardComment::$name

private

Comment name

Definition at line 24 of file LicenseStandardComment.php.

---

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

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