class Serializer

Same name in this branch

The style plugin for serialized output formats.

Plugin annotation


@Plugin(
  id = "serializer",
  module = "rest",
  title = @Translation("Serializer"),
  help = @Translation("Serializes views row data using the Serializer component."),
  display_types = {"data"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\Core\Plugin\ContainerFactoryPluginBase implements ContainerFactoryPluginInterface
  - class \Drupal\views\Plugin\views\PluginBase
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\rest\Plugin\views\style\Serializer

Expanded class hierarchy of Serializer

File

drupal/core/modules/rest/lib/Drupal/rest/Plugin/views/style/Serializer.php, line 31: Contains \Drupal\rest\Plugin\views\style\Serializer.

Namespace

Drupal\rest\Plugin\views\style

View source

class Serializer extends StylePluginBase {

  /**
   * Overrides \Drupal\views\Plugin\views\style\StylePluginBase::$usesRowPlugin.
   */
  protected $usesRowPlugin = TRUE;

  /**
   * Overrides Drupal\views\Plugin\views\style\StylePluginBase::$usesFields.
   */
  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, array $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, array $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, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['formats'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Accepted request formats'),
      '#description' => t('Request formats that will be allowed in responses. If none are selected all formats will be allowed.'),
      '#options' => drupal_map_assoc($this->formats),
      '#default_value' => $this->options['formats'],
    );
  }

  /**
   * {@inheritdoc}
   */
  public function submitOptionsForm(&$form, &$form_state) {
    parent::submitOptionsForm($form, $form_state);
    $form_state['values']['style_options']['formats'] = array_filter($form_state['values']['style_options']['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) {
      $rows[] = $this->view->rowPlugin
        ->render($row);
    }
    return $this->serializer
      ->serialize($rows, $this->displayHandler
      ->getContentType());
  }

  /**
   * 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() {
    if (!empty($this->options['formats'])) {
      return $this->options['formats'];
    }
    return $this->formats;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display.	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
Serializer::$formats	protected	property	The available serialization formats.
Serializer::$serializer	protected	property	The serializer which serializes the views result.
Serializer::$usesGrouping	protected	property	Overrides Drupal\views\Plugin\views\style\StylePluginBase::$usesFields. Overrides StylePluginBase::$usesGrouping
Serializer::$usesRowPlugin	protected	property	Overrides \Drupal\views\Plugin\views\style\StylePluginBase::$usesRowPlugin. Overrides StylePluginBase::$usesRowPlugin
Serializer::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
Serializer::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginBase::create
Serializer::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides StylePluginBase::defineOptions
Serializer::getFormats	public	function	Gets a list of all available formats that can be requested.
Serializer::render	public	function	Render the display in this style. Overrides StylePluginBase::render
Serializer::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
Serializer::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$row_tokens		property	Store all available tokens row rows.
StylePluginBase::$usesFields	protected	property	Does the style plugin for itself support to add fields to it's output.	3
StylePluginBase::$usesOptions	protected	property	Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows.	4
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view.	2
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	protected	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::pre_render		function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::renderFields	protected	function	Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::usesFields		function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping		function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass		function	Returns the usesRowClass property.	4
StylePluginBase::usesRowPlugin		function	Returns the usesRowPlugin property.	8
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1

Main menu

Search Drupal 8.x

API Navigation

class Serializer

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class Serializer

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members