ldap-matter/oauth/OAuth2/Controller/TokenControllerInterface.php

40 lines
1.3 KiB
PHP
Raw Permalink Normal View History

2017-08-08 03:01:11 +08:00
<?php
namespace OAuth2\Controller;
use OAuth2\RequestInterface;
use OAuth2\ResponseInterface;
/**
* This controller is called when a token is being requested.
* it is called to handle all grant types the application supports.
* It also validates the client's credentials
*
2020-04-30 21:43:07 +08:00
* @code
* $tokenController->handleTokenRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response());
* $response->send();
* @endcode
2017-08-08 03:01:11 +08:00
*/
interface TokenControllerInterface
{
/**
2020-04-30 21:43:07 +08:00
* Handle the token request
2017-08-08 03:01:11 +08:00
*
2020-04-30 21:43:07 +08:00
* @param RequestInterface $request - The current http request
* @param ResponseInterface $response - An instance of OAuth2\ResponseInterface to contain the response data
2017-08-08 03:01:11 +08:00
*/
public function handleTokenRequest(RequestInterface $request, ResponseInterface $response);
2020-04-30 21:43:07 +08:00
/**
* Grant or deny a requested access token.
* This would be called from the "/token" endpoint as defined in the spec.
* You can call your endpoint whatever you want.
*
* @param RequestInterface $request - Request object to grant access token
* @param ResponseInterface $response - Response object
*
* @return mixed
*/
2017-08-08 03:01:11 +08:00
public function grantAccessToken(RequestInterface $request, ResponseInterface $response);
}