Fossology\UI\Api\Models\Upload Class Reference

Model class to hold Upload info. More...

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

Public Member Functions
	__construct ($folderId, $folderName, $uploadId, $description, $uploadName, $uploadDate, $assignee, $hash)
	getJSON ($version=ApiVersion::V1)
	getArray ($version=ApiVersion::V1)
	setAssigneeDate (?string $assigneeDate)
	setClosingDate (?string $closingDate)

Private Attributes
	$folderId
	$folderName
	$uploadId
	$description
	$uploadName
	$uploadDate
	$assignee
	$assigneeDate
	$closingDate
	$hash

Detailed Description

Model class to hold Upload info.

Definition at line 16 of file Upload.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\Upload::__construct	(		$folderId,
			$folderName,
			$uploadId,
			$description,
			$uploadName,
			$uploadDate,
			$assignee,
			$hash
	)

Upload constructor.

Parameters

integer	$folderId
string	$folderName
integer	$uploadId
string	$description
string	$uploadName
string	$uploadDate
Hash	$hash

Definition at line 79 of file Upload.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\Upload::getArray

(

$version = ApiVersion::V1

)

Get the upload element as an associative array

Returns

array

Definition at line 107 of file Upload.php.

getJSON()

Fossology\UI\Api\Models\Upload::getJSON

(

$version = ApiVersion::V1

)

Get current upload in JSON representation

Returns

string

Definition at line 98 of file Upload.php.

setAssigneeDate()

Fossology\UI\Api\Models\Upload::setAssigneeDate

(

?string

$assigneeDate

)

Parameters

string | null

$assigneeDate

Returns

Upload

Definition at line 142 of file Upload.php.

setClosingDate()

Fossology\UI\Api\Models\Upload::setClosingDate

(

?string

$closingDate

)

Parameters

string | null

$closingDate

Returns

Upload

Definition at line 152 of file Upload.php.

Member Data Documentation

$assignee

integer Fossology\UI\Api\Models\Upload::$assignee

private

Upload assignee id

Definition at line 52 of file Upload.php.

$assigneeDate

string Fossology\UI\Api\Models\Upload::$assigneeDate

private

Date when a user was assigned to the upload.

Definition at line 57 of file Upload.php.

$closingDate

string Fossology\UI\Api\Models\Upload::$closingDate

private

Date when the upload was closed or rejected.

Definition at line 62 of file Upload.php.

$description

string Fossology\UI\Api\Models\Upload::$description

private

Upload description

Definition at line 37 of file Upload.php.

$folderId

integer Fossology\UI\Api\Models\Upload::$folderId

private

Folder id holding the upload

Definition at line 22 of file Upload.php.

$folderName

string Fossology\UI\Api\Models\Upload::$folderName

private

Folder name holding the upload

Definition at line 27 of file Upload.php.

$hash

Hash Fossology\UI\Api\Models\Upload::$hash

private

Hash information of the upload

Definition at line 67 of file Upload.php.

$uploadDate

string Fossology\UI\Api\Models\Upload::$uploadDate

private

Creation date of upload

Definition at line 47 of file Upload.php.

$uploadId

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

private

Current upload id

Definition at line 32 of file Upload.php.

$uploadName

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

private

Upload name

Definition at line 42 of file Upload.php.

---

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

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