class RowPluginBase

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/row/RowPluginBase.php \Drupal\views\Plugin\views\row\RowPluginBase
  2. 10 core/modules/views/src/Plugin/views/row/RowPluginBase.php \Drupal\views\Plugin\views\row\RowPluginBase
  3. 11.x core/modules/views/src/Plugin/views/row/RowPluginBase.php \Drupal\views\Plugin\views\row\RowPluginBase

Base class for Views row plugins.

This is really just a wrapper around a theme hook. It renders a row of the result table by putting it into a render array with the set theme hook.

Hierarchy

Expanded class hierarchy of RowPluginBase

Related topics

5 files declare their use of RowPluginBase
DataEntityRow.php in core/modules/rest/src/Plugin/views/row/DataEntityRow.php
DataFieldRow.php in core/modules/rest/src/Plugin/views/row/DataFieldRow.php
DisplayKernelTest.php in core/modules/views/tests/src/Kernel/Plugin/DisplayKernelTest.php
RowTest.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php
SearchRow.php in core/modules/search/src/Plugin/views/row/SearchRow.php

File

core/modules/views/src/Plugin/views/row/RowPluginBase.php, line 38

Namespace

Drupal\views\Plugin\views\row
View source
abstract class RowPluginBase extends PluginBase {
    
    /**
     * {@inheritdoc}
     */
    protected $usesOptions = TRUE;
    
    /**
     * Does the row plugin support to add fields to its output.
     *
     * @var bool
     */
    protected $usesFields = FALSE;
    
    /**
     * Returns the usesFields property.
     *
     * @return bool
     */
    public function usesFields() {
        return $this->usesFields;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        if (isset($this->base_table)) {
            $options['relationship'] = [
                'default' => 'none',
            ];
        }
        return $options;
    }
    
    /**
     * Provide a form for setting options.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        if (isset($this->base_table)) {
            $executable = $form_state->get('view')
                ->getExecutable();
            // A whole bunch of code to figure out what relationships are valid for
            // this item.
            $relationships = $executable->display_handler
                ->getOption('relationships');
            $relationship_options = [];
            foreach ($relationships as $relationship) {
                $relationship_handler = Views::handlerManager('relationship')->getHandler($relationship);
                // If this relationship is valid for this type, add it to the list.
                $data = Views::viewsData()->get($relationship['table']);
                $base = $data[$relationship['field']]['relationship']['base'];
                if ($base == $this->base_table) {
                    $relationship_handler->init($executable, $relationship);
                    $relationship_options[$relationship['id']] = $relationship_handler->adminLabel();
                }
            }
            if (!empty($relationship_options)) {
                $relationship_options = array_merge([
                    'none' => $this->t('Do not use a relationship'),
                ], $relationship_options);
                $rel = empty($this->options['relationship']) ? 'none' : $this->options['relationship'];
                if (empty($relationship_options[$rel])) {
                    // Pick the first relationship.
                    $rel = key($relationship_options);
                }
                $form['relationship'] = [
                    '#type' => 'select',
                    '#title' => $this->t('Relationship'),
                    '#options' => $relationship_options,
                    '#default_value' => $rel,
                ];
            }
            else {
                $form['relationship'] = [
                    '#type' => 'value',
                    '#value' => 'none',
                ];
            }
        }
    }
    
    /**
     * Validate the options form.
     */
    public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    }
    
    /**
     * Perform any necessary changes to the form values prior to storage.
     * There is no need for this function to actually store the data.
     */
    public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        if (isset($this->base_table)) {
            if (isset($this->options['relationship']) && isset($this->view->relationship[$this->options['relationship']])) {
                $relationship = $this->view->relationship[$this->options['relationship']];
                $this->field_alias = $this->view->query
                    ->addField($relationship->alias, $this->base_field);
            }
            else {
                $this->field_alias = $this->view->query
                    ->addField($this->base_table, $this->base_field);
            }
        }
    }
    
    /**
     * Allow the style to do stuff before each row is rendered.
     *
     * @param $result
     *   The full array of results from the query.
     */
    public function preRender($result) {
    }
    
    /**
     * Render a row object. This usually passes through to a theme template
     * of some form, but not always.
     *
     * @param object $row
     *   A single row of the query result, so an element of $view->result.
     *
     * @return string
     *   The rendered output of a single row, used by the style plugin.
     */
    public function render($row) {
        return [
            '#theme' => $this->themeFunctions(),
            '#view' => $this->view,
            '#options' => $this->options,
            '#row' => $row,
            '#field_alias' => isset($this->field_alias) ? $this->field_alias : '',
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 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::$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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
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::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::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.
PluginBase::__construct public function Constructs a PluginBase object. 19
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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::buildOptionsForm public function Provide a form for setting options. Overrides PluginBase::buildOptionsForm 8
RowPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions 8
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::render public function Render a row object. This usually passes through to a theme template
of some form, but not always.
10
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
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.