FOSSology
4.4.0
Open Source License Compliance by Open Source Software
|
Public Member Functions | |
__construct ( $id, $shortName="", $fullName="", $text="", $url="", $obligations=null, $risk=null, $isCandidate=false) | |
getJSON () | |
getArray () | |
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) | |
Static Public Member Functions | |
static | parseFromArray ($inputLicense) |
Public Attributes | |
const | ALLOWED_KEYS |
Private Attributes | |
$id | |
$shortName | |
$fullName | |
$text | |
$url | |
$obligations | |
$risk | |
$isCandidate | |
$mergeRequest | |
Definition at line 19 of file License.php.
Fossology\UI\Api\Models\License::__construct | ( | $id, | |
$shortName = "" , |
|||
$fullName = "" , |
|||
$text = "" , |
|||
$url = "" , |
|||
$obligations = null , |
|||
$risk = null , |
|||
$isCandidate = false |
|||
) |
License constructor.
integer | $id | |
string | $shortName | |
string | $fullName | |
string | $text | |
string | $url | |
array | $obligations | |
integer | null | $risk | |
boolean | $isCandidate |
Definition at line 85 of file License.php.
Fossology\UI\Api\Models\License::addObligation | ( | $obligation | ) |
Add obligation to license's associated obligations
Obligation | $obligation | A single obligation to be added |
Definition at line 315 of file License.php.
Fossology\UI\Api\Models\License::getArray | ( | ) |
Get License element as associative array
Reimplemented in Fossology\UI\Api\Models\LicenseDecision.
Definition at line 120 of file License.php.
Fossology\UI\Api\Models\License::getFullName | ( | ) |
Get the license's full name
Definition at line 162 of file License.php.
Fossology\UI\Api\Models\License::getId | ( | ) |
Fossology\UI\Api\Models\License::getIsCandidate | ( | ) |
Fossology\UI\Api\Models\License::getJSON | ( | ) |
JSON representation of the license
Reimplemented in Fossology\UI\Api\Models\LicenseDecision.
Definition at line 111 of file License.php.
Fossology\UI\Api\Models\License::getMergeRequest | ( | ) |
A new merge request to be made for the license?
Definition at line 229 of file License.php.
Fossology\UI\Api\Models\License::getObligations | ( | ) |
Get the license's associated obligations
Definition at line 216 of file License.php.
Fossology\UI\Api\Models\License::getRisk | ( | ) |
Get the license's risk level
Definition at line 198 of file License.php.
Fossology\UI\Api\Models\License::getShortName | ( | ) |
Get the license's short name
Definition at line 150 of file License.php.
Fossology\UI\Api\Models\License::getText | ( | ) |
Fossology\UI\Api\Models\License::getUrl | ( | ) |
|
static |
Parse a license from JSON input.
array | $inputLicense | Object sent by user |
Definition at line 338 of file License.php.
Fossology\UI\Api\Models\License::setFullName | ( | $fullName | ) |
Set the license's full name
string | $fullName | License's full name |
Definition at line 247 of file License.php.
Fossology\UI\Api\Models\License::setIsCandidate | ( | $isCandidate | ) |
Set if license is candidate.
boolean | $isCandidate |
Definition at line 289 of file License.php.
Fossology\UI\Api\Models\License::setMergeRequest | ( | $mergeRequest | ) |
Set the merge request for new license
boolean | $mergeRequest |
Definition at line 327 of file License.php.
Fossology\UI\Api\Models\License::setObligations | ( | $obligations | ) |
Set the license's associated obligations
array | $obligations | Obligations to be added |
Definition at line 298 of file License.php.
Fossology\UI\Api\Models\License::setRisk | ( | $risk | ) |
Set the license's risk level
int | null | $risk | License's risk level or null |
Definition at line 274 of file License.php.
Fossology\UI\Api\Models\License::setShortName | ( | $shortName | ) |
Set the license's short name
string | $shortName | License's short name |
Definition at line 238 of file License.php.
Fossology\UI\Api\Models\License::setText | ( | $text | ) |
Set the license's text
string | $text | License's text |
Definition at line 256 of file License.php.
Fossology\UI\Api\Models\License::setUrl | ( | $url | ) |
Set the license's URL
string | $url | License's URL |
Definition at line 265 of file License.php.
|
private |
Full name of the license
Definition at line 41 of file License.php.
|
private |
License id
Definition at line 31 of file License.php.
|
private |
Is the license a candidate license?
Definition at line 66 of file License.php.
|
private |
Create merge request for candidate license?
Definition at line 71 of file License.php.
|
private |
Obligations for the license
Definition at line 56 of file License.php.
|
private |
Short name of the license
Definition at line 36 of file License.php.
|
private |
The text of the license
Definition at line 46 of file License.php.
|
private |
License URL
Definition at line 51 of file License.php.
const Fossology\UI\Api\Models\License::ALLOWED_KEYS |
Definition at line 25 of file License.php.