class DefaultController in Block List Override 1.0.x

Class DefaultController.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\block_list_override\Controller\DefaultController

File

src/Controller/DefaultController.php, line 15

Namespace

Drupal\block_list_override\Controller

class DefaultController extends ControllerBase {

  /**
   * Drupal\Core\Block\BlockManagerInterface.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * Drupal\Core\Plugin\Context\LazyContextRepository.
   *
   * @var \Drupal\Core\Plugin\Context\LazyContextRepository
   */
  protected $contextRepository;

  /**
   * The Config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * List service.
   *
   * @var \Drupal\block_list_override\BlockListOverride
   */
  protected $listService;

  /**
   * Constructs a new DefaultController object.
   *
   * @param Drupal\Core\Block\BlockManagerInterface $block_manager
   *  The Block Manager service.
   * @param Drupal\Core\Plugin\Context\LazyContextRepository $context_repository
   *  The Context Repository service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Configuration factory.
   * @param \Drupal\block_list_override\BlockListOverride $list_service
   *   The Block List Override service.
   */
  public function __construct(BlockManagerInterface $block_manager, LazyContextRepository $context_repository, ConfigFactoryInterface $config_factory, BlockListOverride $list_service) {
    $this->blockManager = $block_manager;
    $this->contextRepository = $context_repository;
    $this->configFactory = $config_factory;
    $this->listService = $list_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.block'), $container
      ->get('context.repository'), $container
      ->get('config.factory'), $container
      ->get('block_list_override.list'));
  }

  /**
   * List.
   *
   * @return string
   *   Return list of all available block ids after processing.
   */
  public function list() {
    $definitions = $this
      ->getList();
    $header = [
      $this
        ->t('Module'),
      $this
        ->t('Label'),
      $this
        ->t('Block ID'),
    ];
    $rows = [];
    foreach ($definitions as $id => $definition) {
      $rows[] = [
        $definition['provider'],
        $definition['admin_label'],
        $id,
      ];
    }
    return [
      '#type' => 'table',
      '#caption' => $this
        ->getCaption(),
      '#header' => $header,
      '#rows' => $rows,
    ];
  }

  /**
   * Provide a caption for the table.
   *
   * @return array
   *   Formatted text for the caption.
   */
  protected function getCaption() {
    return $this
      ->t('This page lists all system-wide block IDs for all contexts.');
  }

  /**
   * Create the list of block IDs.
   *
   * @return array
   *   An array of block definitions.
   */
  protected function getList() {
    $contexts = $this->contextRepository
      ->getAvailableContexts();
    return $this->blockManager
      ->getDefinitionsForContexts($contexts);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
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::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.
ControllerBase::state	protected	function	Returns the state storage service.
DefaultController::$blockManager	protected	property	Drupal\Core\Block\BlockManagerInterface.
DefaultController::$configFactory	protected	property	The Config factory service. Overrides ControllerBase::$configFactory
DefaultController::$contextRepository	protected	property	Drupal\Core\Plugin\Context\LazyContextRepository.
DefaultController::$listService	protected	property	List service.
DefaultController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DefaultController::getCaption	protected	function	Provide a caption for the table.	1
DefaultController::getList	protected	function	Create the list of block IDs.	1
DefaultController::list	public	function	List.
DefaultController::__construct	public	function	Constructs a new DefaultController object.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	4
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.