Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 10 |
CRAP | |
16.67% |
6 / 36 |
| Serializer | |
0.00% |
0 / 1 |
|
0.00% |
0 / 10 |
110.80 | |
16.67% |
6 / 36 |
| create | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| __construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
| defineOptions | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
| buildOptionsForm | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 8 |
|||
| submitOptionsForm | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 4 |
|||
| render | |
0.00% |
0 / 1 |
4.59 | |
66.67% |
6 / 9 |
|||
| getFormats | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getCacheMaxAge | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getCacheContexts | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getCacheTags | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\rest\Plugin\views\style\Serializer. | |
| */ | |
| namespace Drupal\rest\Plugin\views\style; | |
| use Drupal\Core\Cache\Cache; | |
| use Drupal\Core\Cache\CacheableDependencyInterface; | |
| use Drupal\Core\Form\FormStateInterface; | |
| use Drupal\views\Plugin\views\style\StylePluginBase; | |
| use Symfony\Component\DependencyInjection\ContainerInterface; | |
| use Symfony\Component\Serializer\SerializerInterface; | |
| /** | |
| * The style plugin for serialized output formats. | |
| * | |
| * @ingroup views_style_plugins | |
| * | |
| * @ViewsStyle( | |
| * id = "serializer", | |
| * title = @Translation("Serializer"), | |
| * help = @Translation("Serializes views row data using the Serializer component."), | |
| * display_types = {"data"} | |
| * ) | |
| */ | |
| class Serializer extends StylePluginBase implements CacheableDependencyInterface { | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesRowPlugin = TRUE; | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected $usesGrouping = FALSE; | |
| /** | |
| * The serializer which serializes the views result. | |
| * | |
| * @var \Symfony\Component\Serializer\Serializer | |
| */ | |
| protected $serializer; | |
| /** | |
| * The available serialization formats. | |
| * | |
| * @var array | |
| */ | |
| protected $formats = array(); | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { | |
| return new static( | |
| $configuration, | |
| $plugin_id, | |
| $plugin_definition, | |
| $container->get('serializer'), | |
| $container->getParameter('serializer.formats') | |
| ); | |
| } | |
| /** | |
| * Constructs a Plugin object. | |
| */ | |
| public function __construct(array $configuration, $plugin_id, $plugin_definition, SerializerInterface $serializer, array $serializer_formats) { | |
| parent::__construct($configuration, $plugin_id, $plugin_definition); | |
| $this->definition = $plugin_definition + $configuration; | |
| $this->serializer = $serializer; | |
| $this->formats = $serializer_formats; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| protected function defineOptions() { | |
| $options = parent::defineOptions(); | |
| $options['formats'] = array('default' => array()); | |
| return $options; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function buildOptionsForm(&$form, FormStateInterface $form_state) { | |
| parent::buildOptionsForm($form, $form_state); | |
| $form['formats'] = array( | |
| '#type' => 'checkboxes', | |
| '#title' => $this->t('Accepted request formats'), | |
| '#description' => $this->t('Request formats that will be allowed in responses. If none are selected all formats will be allowed.'), | |
| '#options' => array_combine($this->formats, $this->formats), | |
| '#default_value' => $this->options['formats'], | |
| ); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function submitOptionsForm(&$form, FormStateInterface $form_state) { | |
| parent::submitOptionsForm($form, $form_state); | |
| $formats = $form_state->getValue(array('style_options', 'formats')); | |
| $form_state->setValue(array('style_options', 'formats'), array_filter($formats)); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function render() { | |
| $rows = array(); | |
| // If the Data Entity row plugin is used, this will be an array of entities | |
| // which will pass through Serializer to one of the registered Normalizers, | |
| // which will transform it to arrays/scalars. If the Data field row plugin | |
| // is used, $rows will not contain objects and will pass directly to the | |
| // Encoder. | |
| foreach ($this->view->result as $row_index => $row) { | |
| $this->view->row_index = $row_index; | |
| $rows[] = $this->view->rowPlugin->render($row); | |
| } | |
| unset($this->view->row_index); | |
| // Get the content type configured in the display or fallback to the | |
| // default. | |
| if ((empty($this->view->live_preview))) { | |
| $content_type = $this->displayHandler->getContentType(); | |
| } | |
| else { | |
| $content_type = !empty($this->options['formats']) ? reset($this->options['formats']) : 'json'; | |
| } | |
| return $this->serializer->serialize($rows, $content_type, ['views_style_plugin' => $this]); | |
| } | |
| /** | |
| * Gets a list of all available formats that can be requested. | |
| * | |
| * This will return the configured formats, or all formats if none have been | |
| * selected. | |
| * | |
| * @return array | |
| * An array of formats. | |
| */ | |
| public function getFormats() { | |
| return $this->options['formats']; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getCacheMaxAge() { | |
| return Cache::PERMANENT; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getCacheContexts() { | |
| return ['request_format']; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getCacheTags() { | |
| return []; | |
| } | |
| } |