class View in Drupal 10

Provides a render element to display a view.

Plugin annotation

@RenderElement("view");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\views\Element\View

1 file declares its use of View

ViewsBlock.php in core/modules/views/src/Plugin/Block/ViewsBlock.php

29 string references to 'View'

BookAdminEditForm::bookAdminTableTree in core/modules/book/src/Form/BookAdminEditForm.php

Helps build the main table in the book administration page form.

BookAdminEditForm::submitForm in core/modules/book/src/Form/BookAdminEditForm.php

Form submission handler.

BookTest::testAdminBookNodeListing in core/modules/book/tests/src/Functional/BookTest.php

Tests the administrative listing of all book pages in a book.

CommentForm::save in core/modules/comment/src/CommentForm.php

Form submission handler for the 'save' action.

contact.links.task.yml in core/modules/contact/contact.links.task.yml

core/modules/contact/contact.links.task.yml

... See full list

12 #type uses of 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.

ViewElementTest::testInvalidView in core/modules/views/tests/src/Kernel/ViewElementTest.php

Tests that an exception is thrown when an invalid View is passed.

ViewPageControllerTest::testHandleWithArgumentsOnOverriddenRoute in core/modules/views/tests/src/Unit/Routing/ViewPageControllerTest.php

Tests the page controller with arguments of an overridden page view.

ViewPageControllerTest::testHandleWithArgumentsOnOverriddenRouteWithUpcasting in core/modules/views/tests/src/Unit/Routing/ViewPageControllerTest.php

Tests the page controller with arguments of an overridden page view.

... See full list

File

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

Namespace

Drupal\views\Element

class View extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    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']);
      if (!$view) {
        throw new ViewRenderElementException("Invalid View name ({$element['#name']}) given.");
      }
    }
    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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	53
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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
View::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
View::preRenderViewElement	public static	function	View element pre render callback.