Matthias Andreas Benkard | b382b10 | 2021-01-02 15:32:21 +0100 | [diff] [blame^] | 1 | <?php |
| 2 | |
| 3 | namespace OAuth2\Controller; |
| 4 | |
| 5 | use OAuth2\RequestInterface; |
| 6 | use OAuth2\ResponseInterface; |
| 7 | |
| 8 | /** |
| 9 | * This controller is called when a "resource" is requested. |
| 10 | * call verifyResourceRequest in order to determine if the request |
| 11 | * contains a valid token. |
| 12 | * |
| 13 | * @code |
| 14 | * if (!$resourceController->verifyResourceRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response())) { |
| 15 | * $response->send(); // authorization failed |
| 16 | * exit(); |
| 17 | * } |
| 18 | * return json_encode($resource); // valid token! Send the stuff! |
| 19 | * @endcode |
| 20 | */ |
| 21 | interface ResourceControllerInterface |
| 22 | { |
| 23 | /** |
| 24 | * Verify the resource request |
| 25 | * |
| 26 | * @param RequestInterface $request - Request object |
| 27 | * @param ResponseInterface $response - Response object |
| 28 | * @param string $scope |
| 29 | * @return mixed |
| 30 | */ |
| 31 | public function verifyResourceRequest(RequestInterface $request, ResponseInterface $response, $scope = null); |
| 32 | |
| 33 | /** |
| 34 | * Get access token data. |
| 35 | * |
| 36 | * @param RequestInterface $request - Request object |
| 37 | * @param ResponseInterface $response - Response object |
| 38 | * @return mixed |
| 39 | */ |
| 40 | public function getAccessTokenData(RequestInterface $request, ResponseInterface $response); |
| 41 | } |