class BlockController

Same name in other branches
  1. 9 core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController
  2. 10 core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController
  3. 11.x core/modules/block/src/Controller/BlockController.php \Drupal\block\Controller\BlockController

Controller routines for admin block routes.

Hierarchy

Expanded class hierarchy of BlockController

File

core/modules/block/src/Controller/BlockController.php, line 15

Namespace

Drupal\block\Controller
View 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;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('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 Deprecated Modifiers Object type Summary Overriden Title Overrides
BlockController::$themeHandler protected property The theme handler.
BlockController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
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. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
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. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
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. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator 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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.