Fossology\UI\Api\Models\LicenseCandidate Class Reference

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

Public Member Functions
	__construct ($id, $shortname, $spdxid, $fullname, $text, $group_name, $group_id)
	getId ()
	setId ($id)
	getShortname ()
	setShortname ($shortname)
	getSpdxid ()
	setSpdxid ($spdxid)
	getFullname ()
	setFullname ($fullname)
	getText ()
	setText ($text)
	getGroupName ()
	setGroupName ($group_name)
	getGroupId ()
	setGroupId ($group_id)
	getArray ($apiVersion=ApiVersion::V1)

Static Public Member Functions
static	createFromArray ($licenseData)
static	convertDbArray ($rows, $version=ApiVersion::V1)

Private Attributes
	$id
	$shortname
	$spdxid
	$fullname
	$text
	$group_name
	$group_id

Detailed Description

Definition at line 18 of file LicenseCandidate.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\LicenseCandidate::__construct	(		$id,
			$shortname,
			$spdxid,
			$fullname,
			$text,
			$group_name,
			$group_id
	)

Parameters

int	$id
string	$shortname
string | null	$spdxid
string | null	$fullname
string | null	$text
string	$group_name
int	$group_id

Definition at line 71 of file LicenseCandidate.php.

Member Function Documentation

convertDbArray()

static Fossology\UI\Api\Models\LicenseCandidate::convertDbArray (   $rows,   $version = ApiVersion::V1  )

static

Convert array of results from database.

Parameters

array

$rows

Rows from database

Returns

array

Definition at line 239 of file LicenseCandidate.php.

createFromArray()

static Fossology\UI\Api\Models\LicenseCandidate::createFromArray (   $licenseData )

static

Create new object from database row

Parameters

array

$licenseData

Row from database

Returns

LicenseCandidate

Definition at line 225 of file LicenseCandidate.php.

getFullname()

Fossology\UI\Api\Models\LicenseCandidate::getFullname

(

)

Returns

string|null

Definition at line 134 of file LicenseCandidate.php.

getGroupId()

Fossology\UI\Api\Models\LicenseCandidate::getGroupId

(

)

Returns

int

Definition at line 182 of file LicenseCandidate.php.

getGroupName()

Fossology\UI\Api\Models\LicenseCandidate::getGroupName

(

)

Returns

string

Definition at line 166 of file LicenseCandidate.php.

getId()

Fossology\UI\Api\Models\LicenseCandidate::getId

(

)

Returns

int

Definition at line 86 of file LicenseCandidate.php.

getShortname()

Fossology\UI\Api\Models\LicenseCandidate::getShortname

(

)

Returns

string

Definition at line 102 of file LicenseCandidate.php.

getSpdxid()

Fossology\UI\Api\Models\LicenseCandidate::getSpdxid

(

)

Returns

string|null

Definition at line 118 of file LicenseCandidate.php.

getText()

Fossology\UI\Api\Models\LicenseCandidate::getText

(

)

Returns

string|null

Definition at line 150 of file LicenseCandidate.php.

setFullname()

Fossology\UI\Api\Models\LicenseCandidate::setFullname

(

$fullname

)

Parameters

string | null

$fullname

Definition at line 142 of file LicenseCandidate.php.

setGroupId()

Fossology\UI\Api\Models\LicenseCandidate::setGroupId

(

$group_id

)

Parameters

int

$group_id

Definition at line 190 of file LicenseCandidate.php.

setGroupName()

Fossology\UI\Api\Models\LicenseCandidate::setGroupName

(

$group_name

)

Parameters

string

$group_name

Definition at line 174 of file LicenseCandidate.php.

setId()

Fossology\UI\Api\Models\LicenseCandidate::setId

(

$id

)

Parameters

int

$id

Definition at line 94 of file LicenseCandidate.php.

setShortname()

Fossology\UI\Api\Models\LicenseCandidate::setShortname

(

$shortname

)

Parameters

string

$shortname

Definition at line 110 of file LicenseCandidate.php.

setSpdxid()

Fossology\UI\Api\Models\LicenseCandidate::setSpdxid

(

$spdxid

)

Parameters

string | null

$spdxid

Definition at line 126 of file LicenseCandidate.php.

setText()

Fossology\UI\Api\Models\LicenseCandidate::setText

(

$text

)

Parameters

string | null

$text

Definition at line 158 of file LicenseCandidate.php.

Member Data Documentation

$fullname

string null Fossology\UI\Api\Models\LicenseCandidate::$fullname

private

License full name

Definition at line 42 of file LicenseCandidate.php.

$group_id

int Fossology\UI\Api\Models\LicenseCandidate::$group_id

private

Group ID in which the candidate was created

Definition at line 60 of file LicenseCandidate.php.

$group_name

string Fossology\UI\Api\Models\LicenseCandidate::$group_name

private

Group name in which the candidate was created

Definition at line 54 of file LicenseCandidate.php.

$id

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

private

License id

Definition at line 24 of file LicenseCandidate.php.

$shortname

string Fossology\UI\Api\Models\LicenseCandidate::$shortname

private

License shortname

Definition at line 30 of file LicenseCandidate.php.

$spdxid

string null Fossology\UI\Api\Models\LicenseCandidate::$spdxid

private

License SPDX ID

Definition at line 36 of file LicenseCandidate.php.

$text

string null Fossology\UI\Api\Models\LicenseCandidate::$text

private

License text

Definition at line 48 of file LicenseCandidate.php.

---

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

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