Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
16.67% |
3 / 18 |
CRAP | |
20.51% |
16 / 78 |
| RestExport | |
0.00% |
0 / 1 |
|
16.67% |
3 / 18 |
338.89 | |
20.51% |
16 / 78 |
| __construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
3 / 3 |
|||
| create | |
100.00% |
1 / 1 |
1 | |
100.00% |
4 / 4 |
|||
| initDisplay | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 8 |
|||
| getType | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| usesExposed | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| displaysExposed | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| setMimeType | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| getMimeType | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| setContentType | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| getContentType | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| defineOptions | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 9 |
|||
| optionsSummary | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 12 |
|||
| collectRoutes | |
100.00% |
1 / 1 |
3 | |
100.00% |
9 / 9 |
|||
| buildResponse | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 8 |
|||
| execute | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| render | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 1 |
|||
| anonymous function | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| preview | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\rest\Plugin\views\display\RestExport. | |
| */ | |
| namespace Drupal\rest\Plugin\views\display; | |
| use Drupal\Core\Cache\CacheableMetadata; | |
| use Drupal\Core\Cache\CacheableResponse; | |
| use Drupal\Core\Render\RenderContext; | |
| use Drupal\Core\Render\RendererInterface; | |
| use Drupal\Core\Routing\RouteProviderInterface; | |
| use Drupal\Core\State\StateInterface; | |
| use Drupal\views\Plugin\views\display\ResponseDisplayPluginInterface; | |
| use Drupal\views\Render\ViewsRenderPipelineMarkup; | |
| use Drupal\views\ViewExecutable; | |
| use Drupal\views\Plugin\views\display\PathPluginBase; | |
| use Symfony\Component\DependencyInjection\ContainerInterface; | |
| use Symfony\Component\Routing\RouteCollection; | |
| /** | |
| * The plugin that handles Data response callbacks for REST resources. | |
| * | |
| * @ingroup views_display_plugins | |
| * | |
| * @ViewsDisplay( | |
| * id = "rest_export", | |
| * title = @Translation("REST export"), | |
| * help = @Translation("Create a REST export resource."), | |
| * uses_route = TRUE, | |
| * admin = @Translation("REST export"), | |
| * returns_response = TRUE | |
| * ) | |
| */ | |
| class RestExport extends PathPluginBase implements ResponseDisplayPluginInterface { | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesAJAX = FALSE; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesPager = FALSE; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesMore = FALSE; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesAreas = FALSE; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesOptions = FALSE; | |
| /** | |
| * Overrides the content type of the data response, if needed. | |
| * | |
| * @var string | |
| */ | |
| protected $contentType = 'json'; | |
| /** | |
| * The mime type for the response. | |
| * | |
| * @var string | |
| */ | |
| protected $mimeType; | |
| /** | |
| * The renderer. | |
| * | |
| * @var \Drupal\Core\Render\RendererInterface | |
| */ | |
| protected $renderer; | |
| /** | |
| * Constructs a RestExport object. | |
| * | |
| * @param array $configuration | |
| * A configuration array containing information about the plugin instance. | |
| * @param string $plugin_id | |
| * The plugin_id for the plugin instance. | |
| * @param mixed $plugin_definition | |
| * The plugin implementation definition. | |
| * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider | |
| * The route provider. | |
| * @param \Drupal\Core\State\StateInterface $state | |
| * The state key value store. | |
| * @param \Drupal\Core\Render\RendererInterface $renderer | |
| * The renderer. | |
| */ | |
| public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state, RendererInterface $renderer) { | |
| parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider, $state); | |
| $this->renderer = $renderer; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { | |
| return new static( | |
| $configuration, | |
| $plugin_id, | |
| $plugin_definition, | |
| $container->get('router.route_provider'), | |
| $container->get('state'), | |
| $container->get('renderer') | |
| ); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function initDisplay(ViewExecutable $view, array &$display, array &$options = NULL) { | |
| parent::initDisplay($view, $display, $options); | |
| $request_content_type = $this->view->getRequest()->getRequestFormat(); | |
| // Only use the requested content type if it's not 'html'. If it is then | |
| // default to 'json' to aid debugging. | |
| // @todo Remove the need for this when we have better content negotiation. | |
| if ($request_content_type != 'html') { | |
| $this->setContentType($request_content_type); | |
| } | |
| // If the requested content type is 'html' and the default 'json' is not | |
| // selected as a format option in the view display, fallback to the first | |
| // format in the array. | |
| elseif (!empty($options['style']['options']['formats']) && !isset($options['style']['options']['formats'][$this->getContentType()])) { | |
| $this->setContentType(reset($options['style']['options']['formats'])); | |
| } | |
| $this->setMimeType($this->view->getRequest()->getMimeType($this->contentType)); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getType() { | |
| return 'data'; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function usesExposed() { | |
| return TRUE; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function displaysExposed() { | |
| return FALSE; | |
| } | |
| /** | |
| * Sets the request content type. | |
| * | |
| * @param string $mime_type | |
| * The response mime type. E.g. 'application/json'. | |
| */ | |
| public function setMimeType($mime_type) { | |
| $this->mimeType = $mime_type; | |
| } | |
| /** | |
| * Gets the mime type. | |
| * | |
| * This will return any overridden mime type, otherwise returns the mime type | |
| * from the request. | |
| * | |
| * @return string | |
| * The response mime type. E.g. 'application/json'. | |
| */ | |
| public function getMimeType() { | |
| return $this->mimeType; | |
| } | |
| /** | |
| * Sets the content type. | |
| * | |
| * @param string $content_type | |
| * The content type machine name. E.g. 'json'. | |
| */ | |
| public function setContentType($content_type) { | |
| $this->contentType = $content_type; | |
| } | |
| /** | |
| * Gets the content type. | |
| * | |
| * @return string | |
| * The content type machine name. E.g. 'json'. | |
| */ | |
| public function getContentType() { | |
| return $this->contentType; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected function defineOptions() { | |
| $options = parent::defineOptions(); | |
| // Set the default style plugin to 'json'. | |
| $options['style']['contains']['type']['default'] = 'serializer'; | |
| $options['row']['contains']['type']['default'] = 'data_entity'; | |
| $options['defaults']['default']['style'] = FALSE; | |
| $options['defaults']['default']['row'] = FALSE; | |
| // Remove css/exposed form settings, as they are not used for the data display. | |
| unset($options['exposed_form']); | |
| unset($options['exposed_block']); | |
| unset($options['css_class']); | |
| return $options; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function optionsSummary(&$categories, &$options) { | |
| parent::optionsSummary($categories, $options); | |
| unset($categories['page'], $categories['exposed']); | |
| // Hide some settings, as they aren't useful for pure data output. | |
| unset($options['show_admin_links'], $options['analyze-theme']); | |
| $categories['path'] = array( | |
| 'title' => $this->t('Path settings'), | |
| 'column' => 'second', | |
| 'build' => array( | |
| '#weight' => -10, | |
| ), | |
| ); | |
| $options['path']['category'] = 'path'; | |
| $options['path']['title'] = $this->t('Path'); | |
| // Remove css/exposed form settings, as they are not used for the data | |
| // display. | |
| unset($options['exposed_form']); | |
| unset($options['exposed_block']); | |
| unset($options['css_class']); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function collectRoutes(RouteCollection $collection) { | |
| parent::collectRoutes($collection); | |
| $view_id = $this->view->storage->id(); | |
| $display_id = $this->display['id']; | |
| if ($route = $collection->get("view.$view_id.$display_id")) { | |
| $style_plugin = $this->getPlugin('style'); | |
| // REST exports should only respond to get methods. | |
| $route->setMethods(['GET']); | |
| // Format as a string using pipes as a delimiter. | |
| if ($formats = $style_plugin->getFormats()) { | |
| // Allow a REST Export View to be returned with an HTML-only accept | |
| // format. That allows browsers or other non-compliant systems to access | |
| // the view, as it is unlikely to have a conflicting HTML representation | |
| // anyway. | |
| $route->setRequirement('_format', implode('|', $formats + ['html'])); | |
| } | |
| } | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public static function buildResponse($view_id, $display_id, array $args = []) { | |
| $build = static::buildBasicRenderable($view_id, $display_id, $args); | |
| /** @var \Drupal\Core\Render\RendererInterface $renderer */ | |
| $renderer = \Drupal::service('renderer'); | |
| $output = $renderer->renderRoot($build); | |
| $response = new CacheableResponse($output, 200); | |
| $cache_metadata = CacheableMetadata::createFromRenderArray($build); | |
| $response->addCacheableDependency($cache_metadata); | |
| $response->headers->set('Content-type', $build['#content_type']); | |
| return $response; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function execute() { | |
| parent::execute(); | |
| return $this->view->render(); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function render() { | |
| $build = array(); | |
| $build['#markup'] = $this->renderer->executeInRenderContext(new RenderContext(), function() { | |
| return $this->view->style_plugin->render(); | |
| }); | |
| $this->view->element['#content_type'] = $this->getMimeType(); | |
| $this->view->element['#cache_properties'][] = '#content_type'; | |
| // Encode and wrap the output in a pre tag if this is for a live preview. | |
| if (!empty($this->view->live_preview)) { | |
| $build['#prefix'] = '<pre>'; | |
| $build['#plain_text'] = $build['#markup']; | |
| $build['#suffix'] = '</pre>'; | |
| unset($build['#markup']); | |
| } | |
| elseif ($this->view->getRequest()->getFormat($this->view->element['#content_type']) !== 'html') { | |
| // This display plugin is primarily for returning non-HTML formats. | |
| // However, we still invoke the renderer to collect cacheability metadata. | |
| // Because the renderer is designed for HTML rendering, it filters | |
| // #markup for XSS unless it is already known to be safe, but that filter | |
| // only works for HTML. Therefore, we mark the contents as safe to bypass | |
| // the filter. So long as we are returning this in a non-HTML response | |
| // (checked above), this is safe, because an XSS attack only works when | |
| // executed by an HTML agent. | |
| // @todo Decide how to support non-HTML in the render API in | |
| // https://www.drupal.org/node/2501313. | |
| $build['#markup'] = ViewsRenderPipelineMarkup::create($build['#markup']); | |
| } | |
| parent::applyDisplayCachablityMetadata($build); | |
| return $build; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| * | |
| * The DisplayPluginBase preview method assumes we will be returning a render | |
| * array. The data plugin will already return the serialized string. | |
| */ | |
| public function preview() { | |
| return $this->view->render(); | |
| } | |
| } |