Model class to hold Upload info. More...

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

Public Member Functions
	getJSON ()

	getArray ()

	setMainLicense ($mainLicense)

	setUniqueLicenses ($uniqueLicenses)

	setUploadId ($uploadId)

	setTotalLicenses ($totalLicenses)

	setUploadName ($uploadName)

	setUniqueConcludedLicenses ($uniqueConcludedLicenses)

	setTotalConcludedLicenses ($totalConcludedLicenses)

	setFilesToBeCleared ($filesToBeCleared)

	setFilesCleared ($filesCleared)

	setClearingStatus ($clearingStatus)

	setCopyrightCount ($copyrightCount)

Static Public Member Functions
static	statusToString ($status)

Private Attributes
	$mainLicense

	$uniqueLicenses

	$uploadId

	$totalLicenses

	$uploadName

	$uniqueConcludedLicenses

	$totalConcludedLicenses

	$filesToBeCleared

	$filesCleared

	$clearingStatus

	$copyrightCount

Detailed Description

Model class to hold Upload info.

Definition at line 30 of file UploadSummary.php.

Member Function Documentation

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

Get the upload element as an associative array

Returns: array

Definition at line 117 of file UploadSummary.php.

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

Get current upload in JSON representation

Returns: string

Definition at line 108 of file UploadSummary.php.

Fossology\UI\Api\Models\UploadSummary::setClearingStatus ( $clearingStatus )

Parameters

Fossology::Lib::Data::UploadStatus $clearingStatus

Definition at line 209 of file UploadSummary.php.

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

Parameters

number $copyrightCount

Definition at line 217 of file UploadSummary.php.

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

Parameters

number $filesCleared

Definition at line 201 of file UploadSummary.php.

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

Parameters

number $filesToBeCleared

Definition at line 193 of file UploadSummary.php.

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

Parameters

string $mainLicense

Definition at line 137 of file UploadSummary.php.

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

Parameters

number $totalConcludedLicenses

Definition at line 185 of file UploadSummary.php.

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

Parameters

number $totalLicenses

Definition at line 161 of file UploadSummary.php.

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

Parameters

number $uniqueConcludedLicenses

Definition at line 177 of file UploadSummary.php.

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

Parameters

number $uniqueLicenses

Definition at line 145 of file UploadSummary.php.

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

Parameters

number $uploadId

Definition at line 153 of file UploadSummary.php.

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

Parameters

string $uploadName

Definition at line 169 of file UploadSummary.php.

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 227 of file UploadSummary.php.

Member Data Documentation

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

private

Clearing status

Definition at line 82 of file UploadSummary.php.

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

private

No of files with copyrights

Definition at line 87 of file UploadSummary.php.

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

private

Files with clearing

Definition at line 77 of file UploadSummary.php.

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

private

Files without clearing

Definition at line 72 of file UploadSummary.php.

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

private

Main license selected on upload

Definition at line 37 of file UploadSummary.php.

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

private

Total licenses concluded for upload

Definition at line 67 of file UploadSummary.php.

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

private

Total licenses found in upload

Definition at line 52 of file UploadSummary.php.

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

private

No of unique licenses concluded for upload

Definition at line 62 of file UploadSummary.php.

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

private

Number of unique licenses found in upload

Definition at line 42 of file UploadSummary.php.

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

private

Current upload id

Definition at line 47 of file UploadSummary.php.

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

private

Upload name

Definition at line 57 of file UploadSummary.php.

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

src/www/ui/api/Models/UploadSummary.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation