FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Fossology\UI\Api\Models\UploadSummary Class Reference

Model class to hold Upload info. More...

Collaboration diagram for Fossology\UI\Api\Models\UploadSummary:
Collaboration graph

Public Member Functions

 getJSON ()
 
 getArray ()
 
 setMainLicense ($mainLicense)
 
 setUniqueLicenses ($uniqueLicenses)
 
 setUploadId ($uploadId)
 
 setTotalLicenses ($totalLicenses)
 
 setUploadName ($uploadName)
 
 setAssignee ($assignee)
 
 setUniqueConcludedLicenses ($uniqueConcludedLicenses)
 
 setTotalConcludedLicenses ($totalConcludedLicenses)
 
 setFilesToBeCleared ($filesToBeCleared)
 
 setFilesCleared ($filesCleared)
 
 setClearingStatus ($clearingStatus)
 
 setCopyrightCount ($copyrightCount)
 
 setConcludedNoLicenseFoundCount ($concludedNoLicenseFoundCount)
 
 setFileCount ($fileCount)
 
 setNoScannerLicenseFoundCount ($noScannerLicenseFoundCount)
 
 setScannerUniqueLicenseCount ($scannerUniqueLicenseCount)
 

Static Public Member Functions

static statusToString ($status)
 

Private Attributes

 $mainLicense
 
 $uniqueLicenses
 
 $uploadId
 
 $totalLicenses
 
 $uploadName
 
 $assignee
 
 $uniqueConcludedLicenses
 
 $totalConcludedLicenses
 
 $filesToBeCleared
 
 $filesCleared
 
 $clearingStatus
 
 $copyrightCount
 
 $concludedNoLicenseFoundCount
 
 $fileCount
 
 $noScannerLicenseFoundCount
 
 $scannerUniqueLicenseCount
 

Detailed Description

Model class to hold Upload info.

Definition at line 19 of file UploadSummary.php.

Member Function Documentation

◆ getArray()

Fossology\UI\Api\Models\UploadSummary::getArray ( )

Get the upload element as an associative array

Returns
array

Definition at line 136 of file UploadSummary.php.

◆ getJSON()

Fossology\UI\Api\Models\UploadSummary::getJSON ( )

Get current upload in JSON representation

Returns
string

Definition at line 127 of file UploadSummary.php.

◆ setAssignee()

Fossology\UI\Api\Models\UploadSummary::setAssignee (   $assignee)
Parameters
integer$assignee

Definition at line 201 of file UploadSummary.php.

◆ setClearingStatus()

Fossology\UI\Api\Models\UploadSummary::setClearingStatus (   $clearingStatus)
Parameters
Fossology::Lib::Data::UploadStatus$clearingStatus

Definition at line 241 of file UploadSummary.php.

◆ setConcludedNoLicenseFoundCount()

Fossology\UI\Api\Models\UploadSummary::setConcludedNoLicenseFoundCount (   $concludedNoLicenseFoundCount)
Parameters
number$concludedNoLicenseFoundCount

Definition at line 257 of file UploadSummary.php.

◆ setCopyrightCount()

Fossology\UI\Api\Models\UploadSummary::setCopyrightCount (   $copyrightCount)
Parameters
number$copyrightCount

Definition at line 249 of file UploadSummary.php.

◆ setFileCount()

Fossology\UI\Api\Models\UploadSummary::setFileCount (   $fileCount)
Parameters
number$fileCount

Definition at line 265 of file UploadSummary.php.

◆ setFilesCleared()

Fossology\UI\Api\Models\UploadSummary::setFilesCleared (   $filesCleared)
Parameters
number$filesCleared

Definition at line 233 of file UploadSummary.php.

◆ setFilesToBeCleared()

Fossology\UI\Api\Models\UploadSummary::setFilesToBeCleared (   $filesToBeCleared)
Parameters
number$filesToBeCleared

Definition at line 225 of file UploadSummary.php.

◆ setMainLicense()

Fossology\UI\Api\Models\UploadSummary::setMainLicense (   $mainLicense)
Parameters
string$mainLicense

Definition at line 161 of file UploadSummary.php.

◆ setNoScannerLicenseFoundCount()

Fossology\UI\Api\Models\UploadSummary::setNoScannerLicenseFoundCount (   $noScannerLicenseFoundCount)
Parameters
number$noScannerLicenseFoundCount

Definition at line 273 of file UploadSummary.php.

◆ setScannerUniqueLicenseCount()

Fossology\UI\Api\Models\UploadSummary::setScannerUniqueLicenseCount (   $scannerUniqueLicenseCount)
Parameters
number$scannerUniqueLicenseCount

Definition at line 281 of file UploadSummary.php.

◆ setTotalConcludedLicenses()

Fossology\UI\Api\Models\UploadSummary::setTotalConcludedLicenses (   $totalConcludedLicenses)
Parameters
number$totalConcludedLicenses

Definition at line 217 of file UploadSummary.php.

◆ setTotalLicenses()

Fossology\UI\Api\Models\UploadSummary::setTotalLicenses (   $totalLicenses)
Parameters
number$totalLicenses

Definition at line 185 of file UploadSummary.php.

◆ setUniqueConcludedLicenses()

Fossology\UI\Api\Models\UploadSummary::setUniqueConcludedLicenses (   $uniqueConcludedLicenses)
Parameters
number$uniqueConcludedLicenses

Definition at line 209 of file UploadSummary.php.

◆ setUniqueLicenses()

Fossology\UI\Api\Models\UploadSummary::setUniqueLicenses (   $uniqueLicenses)
Parameters
number$uniqueLicenses

Definition at line 169 of file UploadSummary.php.

◆ setUploadId()

Fossology\UI\Api\Models\UploadSummary::setUploadId (   $uploadId)
Parameters
number$uploadId

Definition at line 177 of file UploadSummary.php.

◆ setUploadName()

Fossology\UI\Api\Models\UploadSummary::setUploadName (   $uploadName)
Parameters
string$uploadName

Definition at line 193 of file UploadSummary.php.

◆ statusToString()

static Fossology\UI\Api\Models\UploadSummary::statusToString (   $status)
static

Convert internal clearing status to strings

Parameters
Fossology::Lib::Data::UploadStatus$status
Returns
string

Definition at line 291 of file UploadSummary.php.

Member Data Documentation

◆ $assignee

integer Fossology\UI\Api\Models\UploadSummary::$assignee
private

Upload assignee Id

Definition at line 51 of file UploadSummary.php.

◆ $clearingStatus

UploadStatus Fossology\UI\Api\Models\UploadSummary::$clearingStatus
private

Clearing status

Definition at line 76 of file UploadSummary.php.

◆ $concludedNoLicenseFoundCount

integer Fossology\UI\Api\Models\UploadSummary::$concludedNoLicenseFoundCount
private

No of concluded files with no license found

Definition at line 86 of file UploadSummary.php.

◆ $copyrightCount

integer Fossology\UI\Api\Models\UploadSummary::$copyrightCount
private

No of files with copyrights

Definition at line 81 of file UploadSummary.php.

◆ $fileCount

integer Fossology\UI\Api\Models\UploadSummary::$fileCount
private

No of files in upload

Definition at line 91 of file UploadSummary.php.

◆ $filesCleared

integer Fossology\UI\Api\Models\UploadSummary::$filesCleared
private

Files with clearing

Definition at line 71 of file UploadSummary.php.

◆ $filesToBeCleared

integer Fossology\UI\Api\Models\UploadSummary::$filesToBeCleared
private

Files without clearing

Definition at line 66 of file UploadSummary.php.

◆ $mainLicense

string Fossology\UI\Api\Models\UploadSummary::$mainLicense
private

Main license selected on upload

Definition at line 26 of file UploadSummary.php.

◆ $noScannerLicenseFoundCount

integer Fossology\UI\Api\Models\UploadSummary::$noScannerLicenseFoundCount
private

No of files with no license found by scanner

Definition at line 96 of file UploadSummary.php.

◆ $scannerUniqueLicenseCount

integer Fossology\UI\Api\Models\UploadSummary::$scannerUniqueLicenseCount
private

No of unique licenses found by scanner

Definition at line 101 of file UploadSummary.php.

◆ $totalConcludedLicenses

integer Fossology\UI\Api\Models\UploadSummary::$totalConcludedLicenses
private

Total licenses concluded for upload

Definition at line 61 of file UploadSummary.php.

◆ $totalLicenses

integer Fossology\UI\Api\Models\UploadSummary::$totalLicenses
private

Total licenses found in upload

Definition at line 41 of file UploadSummary.php.

◆ $uniqueConcludedLicenses

integer Fossology\UI\Api\Models\UploadSummary::$uniqueConcludedLicenses
private

No of unique licenses concluded for upload

Definition at line 56 of file UploadSummary.php.

◆ $uniqueLicenses

integer Fossology\UI\Api\Models\UploadSummary::$uniqueLicenses
private

Number of unique licenses found in upload

Definition at line 31 of file UploadSummary.php.

◆ $uploadId

integer Fossology\UI\Api\Models\UploadSummary::$uploadId
private

Current upload id

Definition at line 36 of file UploadSummary.php.

◆ $uploadName

string Fossology\UI\Api\Models\UploadSummary::$uploadName
private

Upload name

Definition at line 46 of file UploadSummary.php.

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