Class SimpleID\Protocols\OAuth\OAuthEvent

implements GenericEventInterface, StoppableEventInterface
uses GenericEventTrait, StoppableEventTrait

A generic event to process an OAuth message.

Events of this kind are triggered whenever some kind of processing is required on an OAuth request. These include:

  • resolving and expanding parameters in the request
  • validating the request for compliance
  • determine whether the user has granted access to the request

Listeners can use getRequest() and getResponse() methods to obtain and modify the request and response accordingly. In particular, errors should be communicated by using getResponse() to set the appropriate error response.

Methods
Methods used from SimpleID\Util\Events\GenericEventTrait
setEventName(), getEventName()
Methods used from SimpleID\Util\Events\StoppableEventTrait
isPropagationStopped(), stopPropagation()
Properties
Properties used from SimpleID\Util\Events\GenericEventTrait
$eventName
Properties used from SimpleID\Util\Events\StoppableEventTrait
$stopped