Samy\RestApi Namespace Reference

Classes
class	AbstractResponse
class	AuthError
class	AuthType
class	GrantType
class	HttpStatus
class	Util

Functions
	getError ()
	withError (string $Error)
	getErrorDescription ()
	withErrorDescription (string $ErrorDescription)
	getErrorUri ()
	withErrorUri (string $ErrorUri)
	parseErrorResponse (array $Data)
	raiseErrorResponse (array &$Result)

Variables
trait	ErrorResponseTrait
	$error_description = ""
	$error_uri = ""

Function Documentation

getError()

Samy\RestApi\getError

(

)

Retrieve provided error parameter

Returns

string

getErrorDescription()

Samy\RestApi\getErrorDescription

(

)

Retrieve provided error description.

Returns

string

getErrorUri()

Samy\RestApi\getErrorUri

(

)

Retrieve provided error uri.

Returns

string

parseErrorResponse()

Samy\RestApi\parseErrorResponse ( array  $Data )

protected

Return an instance with parsed error response.

Parameters

[in]

array

$Data

Error response data.

Returns

static

raiseErrorResponse()

Samy\RestApi\raiseErrorResponse ( array &  $Result )

protected

Raise error response.

Parameters

[in,out]

array

$Result

Error response data.

Returns

static

withError()

Samy\RestApi\withError

(

string

$Error

)

Return an instance with provided error parameter.

Parameters

[in]

string

$Error

Error parameter.

Returns

static

withErrorDescription()

Samy\RestApi\withErrorDescription

(

string

$ErrorDescription

)

Return an instance with provided error description.

Parameters

[in]

string

$ErrorDescription

Error description.

Returns

static

withErrorUri()

Samy\RestApi\withErrorUri

(

string

$ErrorUri

)

Return an instance with provided error uri.

Parameters

[in]

string

$ErrorUri

Error uri.

Returns

static

Variable Documentation

$error_description

Samy::RestApi\$error_description = ""

protected

describe error_description

$error_uri

Samy::RestApi\$error_uri = ""

protected

describe error uri

ErrorResponseTrait

trait Samy::RestApi\ErrorResponseTrait

Initial value:

{
    
    protected $error = ""

Describes RestApi Error Response reuse code.

See also

https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/#error