class BatchController in Drupal 10
Same name and namespace in other branches
- 8 core/modules/system/src/Controller/BatchController.php \Drupal\system\Controller\BatchController
- 9 core/modules/system/src/Controller/BatchController.php \Drupal\system\Controller\BatchController
Controller routines for batch routes.
Hierarchy
- class \Drupal\system\Controller\BatchController implements ContainerInjectionInterface
Expanded class hierarchy of BatchController
File
- core/
modules/ system/ src/ Controller/ BatchController.php, line 14
Namespace
Drupal\system\ControllerView source
class BatchController implements ContainerInjectionInterface {
/**
* The app root.
*
* @var string
*/
protected $root;
/**
* Constructs a new BatchController.
*
* @param string $root
* The app root.
*/
public function __construct($root) {
$this->root = $root;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->getParameter('app.root'));
}
/**
* Returns a system batch page.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request object.
*
* @return \Symfony\Component\HttpFoundation\Response|array
* A \Symfony\Component\HttpFoundation\Response object or render array.
*
* @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
*/
public function batchPage(Request $request) {
require_once $this->root . '/core/includes/batch.inc';
$output = _batch_page($request);
if ($output === FALSE) {
throw new AccessDeniedHttpException();
}
elseif ($output instanceof Response) {
return $output;
}
elseif (isset($output)) {
$title = $output['#title'] ?? NULL;
$page = [
'#type' => 'page',
'#title' => $title,
'#show_messages' => FALSE,
'content' => $output,
];
// Also inject title as a page header (if available).
if ($title) {
$page['header'] = [
'#type' => 'page_title',
'#title' => $title,
];
}
return $page;
}
}
/**
* The _title_callback for the system.batch_page.normal route.
*
* @return string
* The page title.
*/
public function batchPageTitle() {
$current_set = _batch_current_set();
return !empty($current_set['title']) ? $current_set['title'] : '';
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BatchController:: |
protected | property | The app root. | |
BatchController:: |
public | function | Returns a system batch page. | |
BatchController:: |
public | function | The _title_callback for the system.batch_page.normal route. | |
BatchController:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
|
BatchController:: |
public | function | Constructs a new BatchController. |