class View

Same name in this branch
  1. 8.9.x core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
  2. 8.9.x core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
Same name in other branches
  1. 9 core/modules/views/src/Element/View.php \Drupal\views\Element\View
  2. 9 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
  3. 9 core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
  4. 10 core/modules/views/src/Element/View.php \Drupal\views\Element\View
  5. 10 core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
  6. 10 core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View
  7. 11.x core/modules/views/src/Element/View.php \Drupal\views\Element\View
  8. 11.x core/modules/views/src/Entity/View.php \Drupal\views\Entity\View
  9. 11.x core/modules/views/src/Plugin/views/area/View.php \Drupal\views\Plugin\views\area\View

Provides a render element to display a view.

Plugin annotation

@RenderElement("view");

Hierarchy

Expanded class hierarchy of View

1 file declares its use of View
ViewsBlock.php in core/modules/views/src/Plugin/Block/ViewsBlock.php
286 string references to 'View'
Access::query in core/modules/node/src/Plugin/views/filter/Access.php
See _node_access_where_sql() for a non-views query based implementation.
AddFormBase::processInputValues in core/modules/media_library/src/Form/AddFormBase.php
Creates media items from source field input values.
AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php
Form constructor.
aggregator.links.task.yml in core/modules/aggregator/aggregator.links.task.yml
core/modules/aggregator/aggregator.links.task.yml
aggregator_display_configurable_test_entity_base_field_info_alter in core/modules/aggregator/tests/modules/aggregator_display_configurable_test/aggregator_display_configurable_test.module
Implements hook_entity_base_field_info_alter().

... See full list

13 #type uses of View
DisplayPluginBase::buildBasicRenderable in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Builds a basic render array which can be properly render cached.
DisplayPluginBase::buildRenderable in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Builds a renderable array of the view.
FieldRenderedEntityTest::testRenderedEntityWithField in core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php
Tests the rendered entity output with the test field configured to show.
FieldRenderedEntityTest::testRenderedEntityWithoutField in core/modules/views/tests/src/Kernel/Handler/FieldRenderedEntityTest.php
Tests the default rendered entity output.
ViewPageControllerTest::testHandleWithArgumentsOnOverriddenRoute in core/modules/views/tests/src/Unit/Routing/ViewPageControllerTest.php
Tests the page controller with arguments of a overridden page view.

... See full list

File

core/modules/views/src/Element/View.php, line 13

Namespace

Drupal\views\Element
View source
class View extends RenderElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = get_class($this);
        return [
            '#pre_render' => [
                [
                    $class,
                    'preRenderViewElement',
                ],
            ],
            '#name' => NULL,
            '#display_id' => 'default',
            '#arguments' => [],
            '#embed' => TRUE,
            '#cache' => [],
        ];
    }
    
    /**
     * View element pre render callback.
     */
    public static function preRenderViewElement($element) {
        // Allow specific Views displays to explicitly perform pre-rendering, for
        // those displays that need to be able to know the fully built render array.
        if (!empty($element['#pre_rendered'])) {
            return $element;
        }
        if (!isset($element['#view'])) {
            $view = Views::getView($element['#name']);
        }
        else {
            $view = $element['#view'];
        }
        $element += $view->element;
        $view->element =& $element;
        // Mark the element as being prerendered, so other code like
        // \Drupal\views\ViewExecutable::setCurrentPage knows that its no longer
        // possible to manipulate the $element.
        $view->element['#pre_rendered'] = TRUE;
        if (isset($element['#response'])) {
            $view->setResponse($element['#response']);
        }
        if ($view && $view->access($element['#display_id'])) {
            if (!empty($element['#embed'])) {
                $element['view_build'] = $view->preview($element['#display_id'], $element['#arguments']);
            }
            else {
                // Add contextual links to the view. We need to attach them to the dummy
                // $view_array variable, since contextual_preprocess() requires that they
                // be attached to an array (not an object) in order to process them. For
                // our purposes, it doesn't matter what we attach them to, since once they
                // are processed by contextual_preprocess() they will appear in the
                // $title_suffix variable (which we will then render in
                // views-view.html.twig).
                $view->setDisplay($element['#display_id']);
                // Add the result of the executed view as a child element so any
                // #pre_render elements for the view will get processed. A #pre_render
                // element cannot be added to the main element as this is already inside
                // a #pre_render callback.
                $element['view_build'] = $view->executeDisplay($element['#display_id'], $element['#arguments']);
                if (isset($element['view_build']['#title'])) {
                    $element['#title'] =& $element['view_build']['#title'];
                }
                if (empty($view->display_handler
                    ->getPluginDefinition()['returns_response'])) {
                    // views_add_contextual_links() needs the following information in
                    // order to be attached to the view.
                    $element['#view_id'] = $view->storage
                        ->id();
                    $element['#view_display_show_admin_links'] = $view->getShowAdminLinks();
                    $element['#view_display_plugin_id'] = $view->display_handler
                        ->getPluginId();
                    views_add_contextual_links($element, 'view', $view->current_display);
                }
            }
            if (empty($view->display_handler
                ->getPluginDefinition()['returns_response'])) {
                $element['#attributes']['class'][] = 'views-element-container';
                $element['#theme_wrappers'] = [
                    'container',
                ];
            }
        }
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
View::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
View::preRenderViewElement public static function View element pre render callback.

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