You are here

Home » API reference » Views Parity Row 8 » EntityRow.php

class EntityRow in Views Parity Row 8

Generic entity row plugin to provide a common base for all entity types.

Plugin annotation


@ViewsRow(
    id="views_parity_row_entity",
    deriver="Drupal\views_parity_row\Plugin\Derivative\ViewsParityRowEntityRow"
)

Hierarchy

Expanded class hierarchy of EntityRow

File

src/Plugin/views/row/EntityRow.php, line 19

Namespace

Drupal\views_parity_row\Plugin\views\row
View source 
class EntityRow extends ViewsEntityRow {

  /**
   * The renderer to be used to render the entity row.
   *
   * @var \Drupal\views_parity_row\Plugin\views\Entity\Render\RendererBase
   */
  protected $entityLanguageRenderer;

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = $this->options['views_parity_row'];
    $default = $this
      ->defineOptions();
    $form['views_parity_row_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Alternate with a different view mode every X rows ?'),
      '#default_value' => isset($this->options['views_parity_row_enable']) ? $this->options['views_parity_row_enable'] : $default['views_parity_row_enable'],
    ];
    $form['views_parity_row'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Configuration of Views Parity Row'),
      '#states' => [
        'visible' => [
          ':input[name="row_options[views_parity_row_enable]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      'frequency' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Frequency of view mode change.'),
        '#description' => $this
          ->t('Enter a positive integer number. This number will be the frequency of change of the content view mode. Example, if you chose <em>3</em>, it means that every 3 rows, the content will use the other View mode.'),
        '#size' => 6,
        '#maxlength' => 6,
        '#default_value' => isset($options['frequency']) ? (int) $options['frequency'] : $default['views_parity_row']['frequency']['default'],
      ],
      'start' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Start'),
        '#description' => $this
          ->t('Start at which row ?'),
        '#min' => 0,
        '#size' => 6,
        '#maxlength' => 6,
        '#default_value' => isset($options['start']) ? (int) $options['start'] : $default['views_parity_row']['start']['default'],
      ],
      'end' => [
        '#type' => 'number',
        '#title' => $this
          ->t('End'),
        '#description' => $this
          ->t('End at which row ? Set <em>0</em> to disable.'),
        '#min' => 0,
        '#size' => 6,
        '#maxlength' => 6,
        '#default_value' => isset($options['end']) ? (int) $options['end'] : $default['views_parity_row']['end']['default'],
      ],
      'view_mode' => [
        '#type' => 'select',
        '#options' => $this->entityDisplayRepository
          ->getViewModeOptions($this->entityTypeId),
        '#title' => $this
          ->t('Alternate view mode'),
        '#default_value' => isset($options['view_mode']) ? $options['view_mode'] : $default['views_parity_row']['view_mode']['default'],
      ],
    ];
    $form['views_parity_row_per_row_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Alternate with a different view mode per row'),
      '#default_value' => isset($this->options['views_parity_row_per_row_enable']) ? $this->options['views_parity_row_per_row_enable'] : $default['views_parity_row_per_row_enable'],
    ];
    $form['views_parity_row_per_row'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Configuration of Views Parity Row Per Row'),
      '#states' => [
        'visible' => [
          ':input[name="row_options[views_parity_row_per_row_enable]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $options = $this->options['views_parity_row_per_row'];
    for ($i = 1; $i <= 20; $i++) {
      $form['views_parity_row_per_row']['view_mode_' . $i] = [
        '#type' => 'select',
        '#options' => [
          '' => $this
            ->t('- No alternate view mode -'),
        ] + $this->entityDisplayRepository
          ->getViewModeOptions($this->entityTypeId),
        '#title' => $this
          ->t('Alternate view mode for row @row', [
          '@row' => $i,
        ]),
        '#default_value' => isset($options['view_mode_' . $i]) ? $options['view_mode_' . $i] : '',
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityTypeManager() {
    return $this->entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    $options = $this->entityDisplayRepository
      ->getViewModeOptions($this->entityTypeId);
    if (isset($this->options['views_parity_row_enable']) && $this->options['views_parity_row_enable'] === TRUE) {
      $string = $options[$this->options['view_mode']] . ' | ' . $this->options['views_parity_row']['frequency'] . ' | ' . $options[$this->options['views_parity_row']['view_mode']];
    }
    else {
      $string = $options[$this->options['view_mode']];
    }
    return $string;
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['views_parity_row_enable'] = [
      'default' => FALSE,
    ];
    $options['views_parity_row']['contains']['frequency'] = [
      'default' => 2,
    ];
    $options['views_parity_row']['contains']['start'] = [
      'default' => 0,
    ];
    $options['views_parity_row']['contains']['end'] = [
      'default' => 0,
    ];
    $options['views_parity_row']['contains']['view_mode'] = [
      'default' => 'default',
    ];
    $options['views_parity_row_per_row_enable'] = [
      'default' => FALSE,
    ];
    return $options;
  }

  /**
   * Returns the current renderer.
   *
   * @return \Drupal\views_parity_row\Plugin\views\Entity\Render\RendererBase
   *   The configured renderer.
   */
  protected function getEntityTranslationRenderer() {
    if (!isset($this->entityLanguageRenderer)) {
      $view = $this
        ->getView();
      $rendering_language = $view->display_handler
        ->getOption('rendering_language');
      $langcode = NULL;
      $dynamic_renderers = [
        '***LANGUAGE_entity_translation***' => 'TranslationLanguageRenderer',
        '***LANGUAGE_entity_default***' => 'DefaultLanguageRenderer',
        '***LANGUAGE_language_interface***' => 'CurrentLanguageRenderer',
      ];
      if (isset($dynamic_renderers[$rendering_language])) {

        // Dynamic language set based on result rows or instance defaults.
        $renderer = $dynamic_renderers[$rendering_language];
      }
      else {
        if (mb_strpos($rendering_language, '***LANGUAGE_') !== FALSE) {
          $langcode = PluginBase::queryLanguageSubstitutions()[$rendering_language];
        }
        else {

          // Specific langcode set.
          $langcode = $rendering_language;
        }
        $renderer = 'ConfigurableLanguageRenderer';
      }
      $class = '\\Drupal\\views_parity_row\\Plugin\\views\\Entity\\Render\\' . $renderer;
      $this->entityLanguageRenderer = new $class($view, $this
        ->getLanguageManager(), $this->entityType, $langcode);
    }
    return $this->entityLanguageRenderer;
  }

}

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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityRow::$base_field public property The actual field which is used for the entity id.
EntityRow::$base_table public property The table the entity is using for storage.
EntityRow::$deprecatedProperties protected property
EntityRow::$entityDisplayRepository protected property The entity display repository.
EntityRow::$entityLanguageRenderer protected property The renderer to be used to render the entity row.
EntityRow::$entityRepository protected property The entity repository service.
EntityRow::$entityType protected property Contains the entity type of this row plugin instance.
EntityRow::$entityTypeId protected property Stores the entity type ID of the result entities.
EntityRow::$entityTypeManager protected property The entity type manager.
EntityRow::$languageManager protected property The language manager.
EntityRow::buildOptionsForm public function Provide a form for setting options. Overrides EntityRow::buildOptionsForm
EntityRow::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
EntityRow::create public static function Creates an instance of the plugin. Overrides PluginBase::create
EntityRow::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides EntityRow::defineOptions
EntityRow::getEntityManager protected function
EntityRow::getEntityRepository protected function Returns the entity repository. Overrides EntityTranslationRenderTrait::getEntityRepository
EntityRow::getEntityTranslationRenderer protected function Returns the current renderer. Overrides EntityTranslationRenderTrait::getEntityTranslationRenderer
EntityRow::getEntityTypeId public function Returns the entity type identifier. Overrides EntityTranslationRenderTrait::getEntityTypeId
EntityRow::getEntityTypeManager public function Returns the entity type manager. Overrides EntityRow::getEntityTypeManager
EntityRow::getLanguageManager protected function Returns the language manager. Overrides EntityTranslationRenderTrait::getLanguageManager
EntityRow::getView protected function Returns the top object of a view. Overrides EntityTranslationRenderTrait::getView
EntityRow::init public function Initialize the plugin. Overrides PluginBase::init
EntityRow::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
EntityRow::query public function Add anything to the query that we might need to. Overrides RowPluginBase::query
EntityRow::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
EntityRow::summaryTitle public function Returns the summary of the settings in the display. Overrides EntityRow::summaryTitle
EntityRow::__construct public function Constructs a new EntityRow object. Overrides PluginBase::__construct
EntityTranslationRenderTrait::$entityTranslationRenderer protected property The renderer to be used to render the entity row.
EntityTranslationRenderTrait::getEntityTranslation public function Returns the entity translation matching the configured row language.
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::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::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::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::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
RowPluginBase::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 PluginBase::submitOptionsForm 1
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.