API Documentation
Back to top  

ChainAuthHandler

An auth handler that chains to a sequence of handlers.

package

Default

Methods

__construct

__construct()

Add a set of required authorities for this auth handler

addAuthorities( $arg0) : $this

Arguments

$arg0

array

Response

$this

a reference to this, so the API can be used fluently

Add a required authority for this auth handler

addAuthority( $arg0) : $this

Arguments

$arg0

string

Response

$this

a reference to this, so the API can be used fluently

Appends a auth provider to the chain.

append( $arg0) : $this

Arguments

$arg0

AuthHandler

Response

$this

self

Authorizes the given user against all added authorities.

authorize( $arg0,  $arg1) : void

Arguments

$arg0

User

$arg1

callable

Clears the chain.

clear() : void

create

create() : \io\vertx\jphp\ext\web\handler\ChainAuthHandler
static

Response

\io\vertx\jphp\ext\web\handler\ChainAuthHandler

Something has happened, so handle it.

handle( $arg0) : void

Arguments

$arg0

RoutingContext

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

parseCredentials( $arg0,  $arg1) : void

Arguments

$arg0

RoutingContext

$arg1

callable

Removes a provider from the chain.

remove( $arg0) : boolean

Arguments

$arg0

AuthHandler

Response

boolean

true if provider was removed, false if non existent in the chain.