StateHandler.php in Auth0 Single Sign On 8.2

Namespace

Auth0\SDK\API\Helpers\State

File

vendor/auth0/auth0-php/src/API/Helpers/State/StateHandler.php

<?php

namespace Auth0\SDK\API\Helpers\State;


/*
 * This file is part of Auth0-PHP package.
 *
 * (c) Auth0
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 */

/**
 * This interface must be implemented by state handlers.
 *
 * @deprecated 5.7.0, replaced by Auth0\SDK\Helpers\TransientStoreHandler
 *
 * @author Auth0
 */
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);

}

Interfaces

Name	Description
StateHandler Deprecated	This interface must be implemented by state handlers.