ResourceControllerInterface.php 1.2 KB

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