vendor/friendsofsymfony/rest-bundle/View/ViewHandlerInterface.php line 44

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the FOSRestBundle package.
  5. *
  6. * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace FOS\RestBundle\View;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  17. /**
  18. * @author Jordi Boggiano <j.boggiano@seld.be>
  19. * @author Lukas K. Smith <smith@pooteeweet.org>
  20. */
  21. interface ViewHandlerInterface
  22. {
  23. /**
  24. * @return bool
  25. */
  26. public function supports(string $format);
  28. /**
  29. * Registers a custom handler.
  30. *
  31. * The handler must have the following signature: handler($viewObject, $request, $response)
  32. * It can use the methods of this class to retrieve the needed data and return a
  33. * Response object ready to be sent.
  34. */
  35. public function registerHandler(string $format, callable $callable);
  37. /**
  38. * Handles a request with the proper handler.
  39. *
  40. * Decides on which handler to use based on the request format
  41. *
  42. * @return Response
  43. */
  44. public function handle(View $view, Request $request = null);
  46. /**
  47. * @return Response
  48. */
  49. public function createRedirectResponse(View $view, string $location, string $format);
  51. /**
  52. * @return Response
  53. */
  54. public function createResponse(View $view, Request $request, string $format);
  55. }