class ViewPageController
Same name in other branches
- 8.9.x core/modules/views/src/Routing/ViewPageController.php \Drupal\views\Routing\ViewPageController
- 10 core/modules/views/src/Routing/ViewPageController.php \Drupal\views\Routing\ViewPageController
- 11.x core/modules/views/src/Routing/ViewPageController.php \Drupal\views\Routing\ViewPageController
Defines a page controller to execute and render a view.
Hierarchy
- class \Drupal\views\Routing\ViewPageController
Expanded class hierarchy of ViewPageController
1 file declares its use of ViewPageController
- ViewPageControllerTest.php in core/
modules/ views/ tests/ src/ Unit/ Routing/ ViewPageControllerTest.php
File
-
core/
modules/ views/ src/ Routing/ ViewPageController.php, line 14
Namespace
Drupal\views\RoutingView source
class ViewPageController {
/**
* Handler a response for a given view and display.
*
* @param string $view_id
* The ID of the view
* @param string $display_id
* The ID of the display.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The route match.
*
* @return array|\Symfony\Component\HttpFoundation\Response
* A render array or a Response object.
*/
public function handle($view_id, $display_id, RouteMatchInterface $route_match) {
$args = [];
$route = $route_match->getRouteObject();
$map = $route->hasOption('_view_argument_map') ? $route->getOption('_view_argument_map') : [];
foreach ($map as $attribute => $parameter_name) {
// Allow parameters be pulled from the request.
// The map stores the actual name of the parameter in the request. Views
// which override existing controller, use for example 'node' instead of
// arg_nid as name.
if (isset($map[$attribute])) {
$attribute = $map[$attribute];
}
if ($arg = $route_match->getRawParameter($attribute)) {
}
else {
$arg = $route_match->getParameter($attribute);
}
if (isset($arg)) {
$args[] = $arg;
}
}
$class = $route->getOption('_view_display_plugin_class');
if ($route->getOption('returns_response')) {
/** @var \Drupal\views\Plugin\views\display\ResponseDisplayPluginInterface $class */
return $class::buildResponse($view_id, $display_id, $args);
}
else {
/** @var \Drupal\views\Plugin\views\display\Page $class */
$build = $class::buildBasicRenderable($view_id, $display_id, $args, $route);
Page::setPageRenderArray($build);
views_add_contextual_links($build, 'page', $display_id, $build);
return $build;
}
}
/**
* Gets the title of the given view's display.
*
* @param string $view_id
* The id of the view.
* @param string $display_id
* The id of the display from the view.
*
* @return string|\Drupal\Component\Render\MarkupInterface
* The title of the display of the view.
*/
public function getTitle($view_id, $display_id = 'default') {
$view = Views::getView($view_id);
$view->setDisplay($display_id);
return ViewsRenderPipelineMarkup::create(Xss::filter($view->getTitle()));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ViewPageController::getTitle | public | function | Gets the title of the given view's display. |
ViewPageController::handle | public | function | Handler a response for a given view and display. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.