Fossology\Lib\Data\Spasht\Coordinate Class Reference

Collaboration diagram for Fossology\Lib\Data\Spasht\Coordinate:

Public Member Functions
	__construct ($obj)
	generateUrlString ()
	getRevision ()
	getType ()
	getName ()
	getProvider ()
	getNamespace ()
	getScore ()
	setScore ($score)

Static Public Member Functions
static	generateFromString ($coordinate)

Private Attributes
	$revision
	$type
	$name
	$provider
	$namespace
	$score

Detailed Description

Holds the coordinates of a pakcage in ClearlyDefined

Definition at line 17 of file Coordinate.php.

Constructor & Destructor Documentation

__construct()

Fossology\Lib\Data\Spasht\Coordinate::__construct

(

$obj

)

Set the object based on array returned by API

Parameters

array

$obj

Array containing the data

Exceptions

Definition at line 61 of file Coordinate.php.

Member Function Documentation

generateFromString()

static Fossology\Lib\Data\Spasht\Coordinate::generateFromString (   $coordinate )

static

Helper function to generate Coordinate from string

Parameters

string

$coordinate

Coordinates returned from definintions API

Exceptions

Definition at line 147 of file Coordinate.php.

generateUrlString()

Fossology\Lib\Data\Spasht\Coordinate::generateUrlString

(

)

Generate API understandable URI

Returns

string

Definition at line 86 of file Coordinate.php.

getName()

Fossology\Lib\Data\Spasht\Coordinate::getName

(

)

Returns

string

Definition at line 111 of file Coordinate.php.

getNamespace()

Fossology\Lib\Data\Spasht\Coordinate::getNamespace

(

)

Returns

string

Definition at line 127 of file Coordinate.php.

getProvider()

Fossology\Lib\Data\Spasht\Coordinate::getProvider

(

)

Returns

string

Definition at line 119 of file Coordinate.php.

getRevision()

Fossology\Lib\Data\Spasht\Coordinate::getRevision

(

)

Returns

string

Definition at line 95 of file Coordinate.php.

getScore()

Fossology\Lib\Data\Spasht\Coordinate::getScore

(

)

Returns

integer

Definition at line 135 of file Coordinate.php.

getType()

Fossology\Lib\Data\Spasht\Coordinate::getType

(

)

Returns

string

Definition at line 103 of file Coordinate.php.

setScore()

Fossology\Lib\Data\Spasht\Coordinate::setScore

(

$score

)

Set the score for this coordinate of package.

Parameters

integer

$score

Score

Definition at line 168 of file Coordinate.php.

Member Data Documentation

$name

string Fossology\Lib\Data\Spasht\Coordinate::$name

private

Name of package

Definition at line 35 of file Coordinate.php.

$namespace

string Fossology\Lib\Data\Spasht\Coordinate::$namespace

private

Namespace of the package

Definition at line 47 of file Coordinate.php.

$provider

string Fossology\Lib\Data\Spasht\Coordinate::$provider

private

Provider of package

Definition at line 41 of file Coordinate.php.

$revision

string Fossology\Lib\Data\Spasht\Coordinate::$revision

private

Revision of package

Definition at line 23 of file Coordinate.php.

$score

integer Fossology\Lib\Data\Spasht\Coordinate::$score

private

Package score

Definition at line 53 of file Coordinate.php.

$type

string Fossology\Lib\Data\Spasht\Coordinate::$type

private

Type of package

Definition at line 29 of file Coordinate.php.

---

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

• src/lib/php/Data/Spasht/Coordinate.php