Samy\SimpleApi Namespace Reference

Classes
class	ClientRequest
interface	RequestInterface
class	Response
interface	ResponseInterface
class	ServerRequest

Functions
	hasAuthorization ()
	getAuthorization ()
	getAuthType ()
	withAuthType (string $AuthType)
	getCredentials ()
	withCredentials (string $Credentials)

Variables
trait	RequestTrait
	$credentials = ""

Function Documentation

getAuthorization()

Samy\SimpleApi\getAuthorization

(

)

Return an instance with provided authorization header.

Returns

string

getAuthType()

Samy\SimpleApi\getAuthType

(

)

Retrieve provided authorization type.

Returns

string

getCredentials()

Samy\SimpleApi\getCredentials

(

)

Retrieve provided authorization credentials.

Returns

string

hasAuthorization()

Samy\SimpleApi\hasAuthorization

(

)

Checks if a has authorization header.

Returns

bool

withAuthType()

Samy\SimpleApi\withAuthType

(

string

$AuthType

)

Return an instance with provided authorization type.

Parameters

[in]

string

$AuthType

Authorization type

Returns

static

withCredentials()

Samy\SimpleApi\withCredentials

(

string

$Credentials

)

Return an instance with provided authorization credentials.

Parameters

[in]

string

$Credentials

Authorization credentials

Returns

static

Variable Documentation

$credentials

Samy::SimpleApi\$credentials = ""

protected

describe credentials

RequestTrait

trait Samy::SimpleApi\RequestTrait

Initial value:

{
    
    protected $auth_type = AuthType::BEARER

Describes SimpleApi Request reuse code.