Fossology\UI\Api\Models\FileLicenses Class Reference

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

Public Member Functions
	__construct (string $filePath=null, Findings $findings=null, string $clearing_status=null)
	getFilePath ()
	setFilePath ($filePath)
	getFindings ()
	setFindings ($findings)
	getClearingStatus ()
	setClearingStatus ($clearing_status)
	getArray ($apiVersion=ApiVersion::V1)

Private Attributes
	$filePath
	$findings
	$clearing_status

Detailed Description

@breif License and copyright information about a file

Definition at line 18 of file FileLicenses.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\FileLicenses::__construct	(	string	$filePath = null,
		Findings	$findings = null,
		string	$clearing_status = null
	)

Parameters

string | null	$filePath
Findings | null	$findings
string | null	$clearing_status

Definition at line 43 of file FileLicenses.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\FileLicenses::getArray

(

$apiVersion = ApiVersion::V1

)

Get the object as associative array

Returns

array

Definition at line 110 of file FileLicenses.php.

getClearingStatus()

Fossology\UI\Api\Models\FileLicenses::getClearingStatus

(

)

Returns

string|null

Definition at line 90 of file FileLicenses.php.

getFilePath()

Fossology\UI\Api\Models\FileLicenses::getFilePath

(

)

Returns

string|null

Definition at line 54 of file FileLicenses.php.

getFindings()

Fossology\UI\Api\Models\FileLicenses::getFindings

(

)

Returns

Findings|null

Definition at line 72 of file FileLicenses.php.

setClearingStatus()

Fossology\UI\Api\Models\FileLicenses::setClearingStatus

(

$clearing_status

)

Parameters

string

$clearing_status

Returns

FileLicenses

Definition at line 99 of file FileLicenses.php.

setFilePath()

Fossology\UI\Api\Models\FileLicenses::setFilePath

(

$filePath

)

Parameters

string

$filePath

Returns

FileLicenses

Definition at line 63 of file FileLicenses.php.

setFindings()

Fossology\UI\Api\Models\FileLicenses::setFindings

(

$findings

)

Parameters

Findings

$findings

Returns

FileLicenses

Definition at line 81 of file FileLicenses.php.

Member Data Documentation

$clearing_status

string Fossology\UI\Api\Models\FileLicenses::$clearing_status

private

Clearing status of the file.

Definition at line 36 of file FileLicenses.php.

$filePath

string Fossology\UI\Api\Models\FileLicenses::$filePath

private

Path of the file in file tree.

Definition at line 24 of file FileLicenses.php.

$findings

Findings Fossology\UI\Api\Models\FileLicenses::$findings

private

Findings of the file.

Definition at line 30 of file FileLicenses.php.

---

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

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