Fossology\UI\Api\Models\Info Class Reference

Info model to contain general error and return values. More...

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

Public Member Functions
	__construct ($code, $message, $type)
	getJSON ()
	getArray ()
	getCode ()
	getMessage ()
	getType ()

Private Attributes
	$code
	$message
	$type

Detailed Description

Info model to contain general error and return values.

Definition at line 18 of file Info.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\Info::__construct	(		$code,
			$message,
			$type
	)

Error constructor.

Parameters

integer	$code
string	$message
InfoType	$type

Definition at line 41 of file Info.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\Info::getArray

(

)

Get info as associative array

Returns

array

Definition at line 63 of file Info.php.

getCode()

Fossology\UI\Api\Models\Info::getCode

(

)

Returns

integer

Definition at line 75 of file Info.php.

getJSON()

Fossology\UI\Api\Models\Info::getJSON

(

)

Get the info as JSON representation

Returns

string

Definition at line 54 of file Info.php.

getMessage()

Fossology\UI\Api\Models\Info::getMessage

(

)

Returns

string

Definition at line 83 of file Info.php.

getType()

Fossology\UI\Api\Models\Info::getType

(

)

Returns

InfoType

Definition at line 91 of file Info.php.

Member Data Documentation

$code

integer Fossology\UI\Api\Models\Info::$code

private

HTTP response code

Definition at line 24 of file Info.php.

$message

string Fossology\UI\Api\Models\Info::$message

private

Reponse message

Definition at line 29 of file Info.php.

$type

InfoType Fossology\UI\Api\Models\Info::$type

private

Response type

Definition at line 34 of file Info.php.

---

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

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