You are here

Home » API reference » Layout Plugin Views 8 » Fields.php

class Fields in Layout Plugin Views 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/views/row/Fields.php \Drupal\layout_plugin_views\Plugin\views\row\Fields

The layout_plugin_views 'fields' row plugin

This displays fields in a panel.

Plugin annotation


@ViewsRow(
  id = "layout_plugin_views_fields",
  title = @Translation("Layout fields"),
  help = @Translation("Displays the fields in a layout rather than using a simple row template."),
  theme = "views_view_fields",
  display_types = {"normal"}
)

Hierarchy

Expanded class hierarchy of Fields

3 files declare their use of Fields
FieldsPluginOptions.php in src/FieldsPluginOptions.php
FieldsTest.php in tests/src/Unit/FieldsTest.php
RegionMap.php in src/RegionMap.php

File

src/Plugin/views/row/Fields.php, line 30

Namespace

Drupal\layout_plugin_views\Plugin\views\row
View source 
class Fields extends \Drupal\views\Plugin\views\row\Fields {

  /**
   * @var \Drupal\layout_plugin_views\RegionMap
   */
  private $regionMap;

  /**
   * @var \Drupal\layout_plugin\Plugin\Layout\LayoutPluginManagerInterface
   */
  private $layoutPluginManager;

  /**
   * @var \Drupal\layout_plugin_views\FieldsPluginOptions
   */
  private $pluginOptions;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LayoutPluginManagerInterface $layout_plugin_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->layoutPluginManager = $layout_plugin_manager;
    $this->pluginOptions = FieldsPluginOptions::fromFieldsPlugin($layout_plugin_manager, $this);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.layout_plugin'));
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['layout']['default'] = '';
    $options['default_region']['default'] = '';
    $options['assigned_regions']['default'] = [];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    if ($this->pluginOptions
      ->hasValidSelectedLayout()) {
      $layout_definition = $this->pluginOptions
        ->getSelectedLayoutDefinition();
    }
    elseif ($this->pluginOptions
      ->layoutFallbackIsPossible()) {
      $layout_definition = $this->pluginOptions
        ->getFallbackLayoutDefinition();
    }
    if (!empty($layout_definition)) {
      $form['layout'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Panel layout'),
        '#options' => $this->layoutPluginManager
          ->getLayoutOptions([
          'group_by_category' => TRUE,
        ]),
        '#default_value' => $layout_definition['id'],
      ];
      $form['default_region'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Default region'),
        '#description' => $this
          ->t('Defines the region in which the fields will be rendered by default.'),
        '#options' => $layout_definition['region_names'],
        '#default_value' => $this->pluginOptions
          ->getDefaultRegion(),
      ];
      $form['assigned_regions'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Assign regions'),
        '#description' => $this
          ->t('You can use the dropdown menus above to select a region for each field to be rendered in.'),
      ];
      foreach ($this->displayHandler
        ->getFieldLabels() as $field_name => $field_label) {
        $form['assigned_regions'][$field_name] = [
          '#type' => 'select',
          '#options' => $layout_definition['region_names'],
          '#title' => $field_label,
          '#default_value' => $this->pluginOptions
            ->getAssignedRegion($field_name),
          '#empty_option' => $this
            ->t('Default region'),
        ];
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render($row) {

    /** @var \Drupal\views\ResultRow $row */
    $build = $this
      ->renderFieldsIntoRegions($row);
    return $this
      ->buildLayoutRenderArray($build);
  }

  /**
   * Renders the row's fields into the regions specified in the region map.
   *
   * @param \Drupal\views\ResultRow $row
   *
   * @return \Drupal\Component\Render\MarkupInterface[]
   *   An array of MarkupInterface objects keyed by region machine name.
   */
  protected function renderFieldsIntoRegions(ResultRow $row) {
    $build = [];
    foreach ($this
      ->getRegionMap()
      ->getNonEmptyRegionNames() as $region_name) {
      try {
        $fieldsToRender = $this
          ->getRegionMap()
          ->getFieldsForRegion($region_name);
        $build[$region_name]['#markup'] = $this
          ->renderFields($row, $fieldsToRender);
      } catch (NoMarkupGeneratedException $e) {

        // Even though we only try to render regions that actually contain
        // fields, it is still possible that those fields are empty. We don't
        // want to render empty regions, so we do nothing.
      }
    }
    return $build;
  }

  /**
   * Renders the fields.
   *
   * @param \Drupal\views\ResultRow $row
   * @param \Drupal\views\Plugin\views\field\FieldPluginBase[] $fieldsToRender
   *
   * @return \Drupal\Component\Render\MarkupInterface
   *
   * @throws NoMarkupGeneratedException
   */
  protected function renderFields(ResultRow $row, array $fieldsToRender) {

    // We have to override the available fields for rendering so we create a
    // backup of the original fields.
    $original_fields = $this
      ->getViewFieldDefinitions();
    $this
      ->setViewFieldDefinitions($fieldsToRender);

    // We can not just return a render array with a clone of a filtered view
    // because views assigns the view object just before rendering, which
    // results in all fields being rendered in each region.
    // We therefore have to force rendering outside of the render context of
    // this request.
    $renderer = $this
      ->getRenderer();
    $markup = $renderer
      ->executeInRenderContext(new RenderContext(), function () use ($row, $renderer) {

      // @codeCoverageIgnoreStart
      // We can never reach this code in our unit tests because we mocked out
      // the renderer. These two methods are however defined and tested by core.
      // There is no need for them to be tested by our unit tests.
      $render_array = parent::render($row);
      return $renderer
        ->render($render_array);

      // @codeCoverageIgnoreEnd
    });

    // Restore the original fields.
    $this
      ->setViewFieldDefinitions($original_fields);
    if (empty($markup)) {
      throw new NoMarkupGeneratedException();
    }
    return $markup;
  }

  /**
   * Retrieves the field property of the view.
   *
   * @return \Drupal\views\Plugin\views\field\FieldPluginBase[]
   */
  protected function getViewFieldDefinitions() {
    return $this->view->field;
  }

  /**
   * Sets the field property of the view.
   *
   * @param \Drupal\views\Plugin\views\field\FieldPluginBase[] $fieldDefinitions
   */
  protected function setViewFieldDefinitions(array $fieldDefinitions) {
    $this->view->field = $fieldDefinitions;
  }

  /**
   * @return \Drupal\layout_plugin_views\RegionMap
   */
  private function getRegionMap() {
    if (empty($this->regionMap)) {
      $this->regionMap = new RegionMap($this, $this->pluginOptions);
    }
    return $this->regionMap;
  }

  /**
   * Builds a renderable array for the selected layout.
   *
   * @param MarkupInterface[] $rendered_regions
   *  An array of MarkupInterface objects keyed by the machine name of the
   *  region they should be rendered in. @see ::renderFieldsIntoRegions.
   *
   * @return array
   *  Renderable array for the selected layout.
   */
  protected function buildLayoutRenderArray(array $rendered_regions) {
    if (!empty($rendered_regions)) {

      /** @var \Drupal\layout_plugin\Plugin\Layout\LayoutInterface $layout */
      $layout = $this->layoutPluginManager
        ->createInstance($this->pluginOptions
        ->getLayout(), []);
      return $layout
        ->build($rendered_regions);
    }
    return $rendered_regions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
Fields::$layoutPluginManager private property
Fields::$pluginOptions private property
Fields::$regionMap private property
Fields::$usesFields protected property Does the row plugin support to add fields to its output. Overrides RowPluginBase::$usesFields
Fields::buildLayoutRenderArray protected function Builds a renderable array for the selected layout.
Fields::buildOptionsForm public function Provide a form for setting options. Overrides Fields::buildOptionsForm
Fields::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Fields::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides Fields::defineOptions
Fields::getRegionMap private function
Fields::getViewFieldDefinitions protected function Retrieves the field property of the view.
Fields::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
Fields::renderFields protected function Renders the fields.
Fields::renderFieldsIntoRegions protected function Renders the row's fields into the regions specified in the region map.
Fields::setViewFieldDefinitions protected function Sets the field property of the view.
Fields::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides RowPluginBase::submitOptionsForm
Fields::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
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. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
RowPluginBase::preRender public function Allow the style to do stuff before each row is rendered. 4
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 2
RowPluginBase::usesFields public function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.