interface StateHandler in Auth0 Single Sign On 8.2

This interface must be implemented by state handlers.

@author Auth0

Hierarchy

• interface \Auth0\SDK\API\Helpers\State\StateHandler

Deprecated

5.7.0, replaced by Auth0\SDK\Helpers\TransientStoreHandler

1 file declares its use of StateHandler

Auth0.php in vendor/auth0/auth0-php/src/Auth0.php

File

vendor/auth0/auth0-php/src/API/Helpers/State/StateHandler.php, line 21

Namespace

Auth0\SDK\API\Helpers\State

interface StateHandler {

  /**
   * Generate state value to be used for the state param value during authorization.
   *
   * @return string || null
   */
  public function issue();

  /**
   * Store a given state value to be used for the state param value during authorization.
   *
   * @param $state
   *
   * @return mixed
   */
  public function store($state);

  /**
   * Perform validation of the returned state with the previously generated state.
   *
   * @param string $state
   *
   * @return boolean result
   *
   * @throws \Exception
   */
  public function validate($state);

}

Members

Name	Modifiers	Type	Description	Overrides
StateHandler::issue	public	function	Generate state value to be used for the state param value during authorization.	2
StateHandler::store	public	function	Store a given state value to be used for the state param value during authorization.	2
StateHandler::validate	public	function	Perform validation of the returned state with the previously generated state.	2