class BlockController
Same name in other branches
- 9 core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController
- 8.9.x core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController
- 11.x core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController
Controller routines for admin block routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\AutowireTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\block\Controller\BlockController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of BlockController
File
-
core/
modules/ block/ src/ Controller/ BlockController.php, line 14
Namespace
Drupal\block\ControllerView source
class BlockController extends ControllerBase {
/**
* The theme handler.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface
*/
protected $themeHandler;
/**
* Constructs a new BlockController instance.
*
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
*/
public function __construct(ThemeHandlerInterface $theme_handler) {
$this->themeHandler = $theme_handler;
}
/**
* Calls a method on a block and reloads the listing page.
*
* @param \Drupal\block\BlockInterface $block
* The block being acted upon.
* @param string $op
* The operation to perform, e.g., 'enable' or 'disable'.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect back to the listing page.
*/
public function performOperation(BlockInterface $block, $op) {
$block->{$op}()
->save();
$this->messenger()
->addStatus($this->t('The block settings have been updated.'));
return $this->redirect('block.admin_display');
}
/**
* Returns a block theme demo page.
*
* @param string $theme
* The name of the theme.
*
* @return array
* A #type 'page' render array containing the block region demo.
*/
public function demo($theme) {
if (!$this->themeHandler
->hasUi($theme)) {
throw new NotFoundHttpException();
}
$page = [
'#title' => Html::escape($this->themeHandler
->getName($theme)),
'#type' => 'page',
'#attached' => [
'drupalSettings' => [
// The block demonstration page is not marked as an administrative
// page by \Drupal::service('router.admin_context')->isAdminRoute()
// function in order to use the frontend theme. Since JavaScript
// relies on a proper separation of admin pages, it needs to know this
// is an actual administrative page.
'path' => [
'currentPathIsAdmin' => TRUE,
],
],
'library' => [
'block/drupal.block.admin',
],
],
];
// Show descriptions in each visible page region, nothing else.
$visible_regions = $this->getVisibleRegionNames($theme);
foreach (array_keys($visible_regions) as $region) {
$page[$region]['block_description'] = [
'#type' => 'inline_template',
'#template' => '<div class="block-region demo-block">{{ region_name }}</div>',
'#context' => [
'region_name' => $visible_regions[$region],
],
];
}
return $page;
}
/**
* Returns the human-readable list of regions keyed by machine name.
*
* @param string $theme
* The name of the theme.
*
* @return array
* An array of human-readable region names keyed by machine name.
*/
protected function getVisibleRegionNames($theme) {
return system_region_list($theme, REGIONS_VISIBLE);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AutowireTrait::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 33 |
BlockController::$themeHandler | protected | property | The theme handler. | |
BlockController::demo | public | function | Returns a block theme demo page. | |
BlockController::getVisibleRegionNames | protected | function | Returns the human-readable list of regions keyed by machine name. | |
BlockController::performOperation | public | function | Calls a method on a block and reloads the listing page. | |
BlockController::__construct | public | function | Constructs a new BlockController instance. | |
ControllerBase::$configFactory | protected | property | The configuration factory. | |
ControllerBase::$currentUser | protected | property | The current user service. | 2 |
ControllerBase::$entityFormBuilder | protected | property | The entity form builder. | |
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | |
ControllerBase::$formBuilder | protected | property | The form builder. | 1 |
ControllerBase::$keyValue | protected | property | The key-value storage. | 1 |
ControllerBase::$languageManager | protected | property | The language manager. | 1 |
ControllerBase::$moduleHandler | protected | property | The module handler. | 1 |
ControllerBase::$stateService | protected | property | The state service. | |
ControllerBase::cache | protected | function | Returns the requested cache bin. | |
ControllerBase::config | protected | function | Retrieves a configuration object. | |
ControllerBase::container | private | function | Returns the service container. | |
ControllerBase::currentUser | protected | function | Returns the current user. | 2 |
ControllerBase::entityFormBuilder | protected | function | Retrieves the entity form builder. | |
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | |
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 1 |
ControllerBase::keyValue | protected | function | Returns a key/value storage collection. | 1 |
ControllerBase::languageManager | protected | function | Returns the language manager service. | 1 |
ControllerBase::moduleHandler | protected | function | Returns the module handler. | 1 |
ControllerBase::redirect | protected | function | Returns a redirect response object for the specified route. | |
ControllerBase::state | protected | function | Returns the state storage service. | |
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | |
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | |
MessengerTrait::$messenger | protected | property | The messenger. | 16 |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 |
MessengerTrait::setMessenger | public | function | Sets the messenger. | |
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 |
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | |
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. | 2 |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.