DefaultDisplay.php
Same filename in other branches
Namespace
Drupal\views\Plugin\views\displayFile
-
core/
modules/ views/ src/ Plugin/ views/ display/ DefaultDisplay.php
View source
<?php
namespace Drupal\views\Plugin\views\display;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\views\Attribute\ViewsDisplay;
/**
* A plugin to handle defaults on a view.
*
* @ingroup views_display_plugins
*/
class DefaultDisplay extends DisplayPluginBase {
/**
* Whether the display allows attachments.
*
* @var bool
*/
protected $usesAttachments = TRUE;
/**
* Determine if this display is the default which contains fallback settings.
*/
public function isDefaultDisplay() {
return TRUE;
}
/**
* The default execute handler fully renders the view.
*
* For the simplest use:
* @code
* $output = $view->executeDisplay('default', $args);
* @endcode
*
* For more complex usages, a view can be partially built:
* @code
* $view->setArguments($args);
* $view->build('default'); // Build the query
* $view->preExecute(); // Pre-execute the query.
* $view->execute(); // Run the query
* $output = $view->render(); // Render the view
* @endcode
*
* If short circuited at any point, look in $view->build_info for
* information about the query. After execute, look in $view->result
* for the array of objects returned from \Drupal::database()->query().
*
* You can also do:
* @code
* $view->setArguments($args);
* $output = $view->render('default'); // Render the view
* @endcode
*
* This illustrates that render is smart enough to call build and execute
* if these items have not already been accomplished.
*
* Note that execute also must accomplish other tasks, such as setting page
* titles, and generating exposed filter data if necessary.
*/
public function execute() {
return $this->view
->render($this->display['id']);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
DefaultDisplay | A plugin to handle defaults on a view. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.