View.php
Same filename in this branch
Same filename in other branches
- 8.9.x core/modules/views/src/Element/View.php
- 8.9.x core/modules/views/src/Entity/View.php
- 8.9.x core/modules/views/src/Plugin/views/area/View.php
- 10 core/modules/views/src/Element/View.php
- 10 core/modules/views/src/Entity/View.php
- 10 core/modules/views/src/Plugin/views/area/View.php
- 11.x core/modules/views/src/Element/View.php
- 11.x core/modules/views/src/Entity/View.php
- 11.x core/modules/views/src/Plugin/views/area/View.php
Namespace
Drupal\views\ElementFile
-
core/
modules/ views/ src/ Element/ View.php
View source
<?php
namespace Drupal\views\Element;
use Drupal\Core\Render\Element\RenderElement;
use Drupal\views\Exception\ViewRenderElementException;
use Drupal\views\Views;
/**
* Provides a render element to display a view.
*
* @RenderElement("view")
*/
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;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
View | Provides a render element to display a view. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.