class BlockContentController

Same name in other branches
  1. 8.9.x core/modules/block_content/src/Controller/BlockContentController.php \Drupal\block_content\Controller\BlockContentController
  2. 10 core/modules/block_content/src/Controller/BlockContentController.php \Drupal\block_content\Controller\BlockContentController
  3. 11.x core/modules/block_content/src/Controller/BlockContentController.php \Drupal\block_content\Controller\BlockContentController

Hierarchy

Expanded class hierarchy of BlockContentController

File

core/modules/block_content/src/Controller/BlockContentController.php, line 13

Namespace

Drupal\block_content\Controller
View source
class BlockContentController extends ControllerBase {
    
    /**
     * The custom block storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $blockContentStorage;
    
    /**
     * The custom block type storage.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $blockContentTypeStorage;
    
    /**
     * The theme handler.
     *
     * @var \Drupal\Core\Extension\ThemeHandlerInterface
     */
    protected $themeHandler;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        $entity_type_manager = $container->get('entity_type.manager');
        return new static($entity_type_manager->getStorage('block_content'), $entity_type_manager->getStorage('block_content_type'), $container->get('theme_handler'));
    }
    
    /**
     * Constructs a BlockContent object.
     *
     * @param \Drupal\Core\Entity\EntityStorageInterface $block_content_storage
     *   The custom block storage.
     * @param \Drupal\Core\Entity\EntityStorageInterface $block_content_type_storage
     *   The custom block type storage.
     * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
     *   The theme handler.
     */
    public function __construct(EntityStorageInterface $block_content_storage, EntityStorageInterface $block_content_type_storage, ThemeHandlerInterface $theme_handler) {
        $this->blockContentStorage = $block_content_storage;
        $this->blockContentTypeStorage = $block_content_type_storage;
        $this->themeHandler = $theme_handler;
    }
    
    /**
     * Displays add custom block links for available types.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request object.
     *
     * @return array
     *   A render array for a list of the custom block types that can be added or
     *   if there is only one custom block type defined for the site, the function
     *   returns the custom block add page for that custom block type.
     */
    public function add(Request $request) {
        $types = $this->blockContentTypeStorage
            ->loadMultiple();
        uasort($types, [
            $this->blockContentTypeStorage
                ->getEntityType()
                ->getClass(),
            'sort',
        ]);
        if ($types && count($types) == 1) {
            $type = reset($types);
            return $this->addForm($type, $request);
        }
        if (count($types) === 0) {
            return [
                '#markup' => $this->t('You have not created any block types yet. Go to the <a href=":url">block type creation page</a> to add a new block type.', [
                    ':url' => Url::fromRoute('block_content.type_add')->toString(),
                ]),
            ];
        }
        return [
            '#theme' => 'block_content_add_list',
            '#content' => $types,
        ];
    }
    
    /**
     * Presents the custom block creation form.
     *
     * @param \Drupal\block_content\BlockContentTypeInterface $block_content_type
     *   The custom block type to add.
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request object.
     *
     * @return array
     *   A form array as expected by
     *   \Drupal\Core\Render\RendererInterface::render().
     */
    public function addForm(BlockContentTypeInterface $block_content_type, Request $request) {
        $block = $this->blockContentStorage
            ->create([
            'type' => $block_content_type->id(),
        ]);
        if (($theme = $request->query
            ->get('theme')) && in_array($theme, array_keys($this->themeHandler
            ->listInfo()))) {
            // We have navigated to this page from the block library and will keep track
            // of the theme for redirecting the user to the configuration page for the
            // newly created block in the given theme.
            $block->setTheme($theme);
        }
        return $this->entityFormBuilder()
            ->getForm($block);
    }
    
    /**
     * Provides the page title for this controller.
     *
     * @param \Drupal\block_content\BlockContentTypeInterface $block_content_type
     *   The custom block type being added.
     *
     * @return string
     *   The page title.
     */
    public function getAddFormTitle(BlockContentTypeInterface $block_content_type) {
        return $this->t('Add %type custom block', [
            '%type' => $block_content_type->label(),
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlockContentController::$blockContentStorage protected property The custom block storage.
BlockContentController::$blockContentTypeStorage protected property The custom block type storage.
BlockContentController::$themeHandler protected property The theme handler.
BlockContentController::add public function Displays add custom block links for available types.
BlockContentController::addForm public function Presents the custom block creation form.
BlockContentController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
BlockContentController::getAddFormTitle public function Provides the page title for this controller.
BlockContentController::__construct public function Constructs a BlockContent object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
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. 3
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. 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. 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.