1. trait
  2. Hypervel
  3. \
  4. Saloon
  5. \
  6. Traits
  7. \
  8. Auth
  9. \
  10. AuthenticatesRequests

AuthenticatesRequests

trait AuthenticatesRequests

Properties

protected Authenticator|null $authenticator

The authenticator used in requests.

Methods

Authenticator|null
defaultAuth()

Resolve the default authenticator.

Authenticator|null
authenticator()

Get the authenticator.

AuthenticatesRequests
authenticate(Authenticator $authenticator)

Authenticate the request with an authenticator.

AuthenticatesRequests
withToken(string $token, string $type = 'Bearer')

Authenticate the request with a token.

AuthenticatesRequests
withBasicAuth(string $username, string $password)

Authenticate the request with basic authentication.

AuthenticatesRequests
withDigestAuth(string $username, string $password)

Authenticate the request with digest authentication.

Details

at line 23
protected Authenticator|null defaultAuth()

Resolve the default authenticator.

Return Value

Authenticator|null

at line 31
Authenticator|null authenticator()

Get the authenticator.

Return Value

Authenticator|null

at line 41
AuthenticatesRequests authenticate(Authenticator $authenticator)

Authenticate the request with an authenticator.

Parameters

Authenticator $authenticator

Return Value

AuthenticatesRequests

at line 53
AuthenticatesRequests withToken(string $token, string $type = 'Bearer')

Authenticate the request with a token.

Parameters

string $token
string $type

Return Value

AuthenticatesRequests

at line 63
AuthenticatesRequests withBasicAuth(string $username, string $password)

Authenticate the request with basic authentication.

Parameters

string $username
string $password

Return Value

AuthenticatesRequests

at line 73
AuthenticatesRequests withDigestAuth(string $username, string $password)

Authenticate the request with digest authentication.

Parameters

string $username
string $password

Return Value

AuthenticatesRequests