RendererFactory.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <?php
  2. /**
  3. * Factory of REST renders
  4. *
  5. * Copyright © Magento, Inc. All rights reserved.
  6. * See COPYING.txt for license details.
  7. */
  8. namespace Magento\Framework\Webapi\Rest\Response;
  9. use Magento\Framework\Phrase;
  10. class RendererFactory
  11. {
  12. /**
  13. * @var \Magento\Framework\ObjectManagerInterface
  14. */
  15. protected $_objectManager;
  16. /**
  17. * @var \Magento\Framework\Webapi\Rest\Request
  18. */
  19. protected $_request;
  20. /**
  21. * @var array
  22. */
  23. protected $_renders;
  24. /**
  25. * @param \Magento\Framework\ObjectManagerInterface $objectManager
  26. * @param \Magento\Framework\Webapi\Rest\Request $request
  27. * @param array $renders
  28. */
  29. public function __construct(
  30. \Magento\Framework\ObjectManagerInterface $objectManager,
  31. \Magento\Framework\Webapi\Rest\Request $request,
  32. array $renders = []
  33. ) {
  34. $this->_objectManager = $objectManager;
  35. $this->_request = $request;
  36. $this->_renders = $renders;
  37. }
  38. /**
  39. * Get renderer for Mime-Type specified in Accept header of request.
  40. *
  41. * @return \Magento\Framework\Webapi\Rest\Response\RendererInterface
  42. * @throws \Magento\Framework\Webapi\Exception
  43. * @throws \LogicException
  44. */
  45. public function get()
  46. {
  47. $renderer = $this->_objectManager->get($this->_getRendererClass());
  48. if (!$renderer instanceof \Magento\Framework\Webapi\Rest\Response\RendererInterface) {
  49. throw new \LogicException(
  50. 'The renderer must implement "Magento\Framework\Webapi\Rest\Response\RendererInterface".'
  51. );
  52. }
  53. return $renderer;
  54. }
  55. /**
  56. * Find renderer which can render response in requested format.
  57. *
  58. * @return string
  59. * @throws \Magento\Framework\Webapi\Exception
  60. */
  61. protected function _getRendererClass()
  62. {
  63. $acceptTypes = $this->_request->getAcceptTypes();
  64. if (!is_array($acceptTypes)) {
  65. $acceptTypes = [$acceptTypes];
  66. }
  67. foreach ($acceptTypes as $acceptType) {
  68. foreach ($this->_renders as $rendererConfig) {
  69. $rendererType = $rendererConfig['type'];
  70. if ($acceptType == $rendererType || $acceptType == current(
  71. explode('/', $rendererType)
  72. ) . '/*' || $acceptType == '*/*'
  73. ) {
  74. return $rendererConfig['model'];
  75. }
  76. }
  77. }
  78. /** If server does not have renderer for any of the accepted types it SHOULD send 406 (not acceptable). */
  79. throw new \Magento\Framework\Webapi\Exception(
  80. new Phrase(
  81. 'Server cannot match any of the given Accept HTTP header media type(s) from the request: "%1" '.
  82. 'with media types from the config of response renderer.',
  83. $acceptTypes
  84. ),
  85. 0,
  86. \Magento\Framework\Webapi\Exception::HTTP_NOT_ACCEPTABLE
  87. );
  88. }
  89. }