class LayoutController 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
    • class \Drupal\block_list_override\Controller\LayoutController

File

src/Controller/LayoutController.php, line 10

Namespace

Drupal\block_list_override\Controller

class LayoutController extends DefaultController {

  /**
   * {@inheritdoc}
   */
  protected function getCaption() {
    return $this
      ->t('This page lists block IDs available to the Layout Builder for all contexts.');
  }

  /**
   * {@inheritdoc}
   */
  protected function getList() {
    $definitions = parent::getList();
    $settings = $this->configFactory
      ->get('block_list_override.settings');
    $options = [
      'match' => !empty($settings) ? trim($settings
        ->get('layout_match')) : '',
      'prefix' => !empty($settings) ? trim($settings
        ->get('layout_prefix')) : '',
      'regex' => !empty($settings) ? trim($settings
        ->get('layout_regex')) : '',
      'negate' => !empty($settings) ? $settings
        ->get('layout_negate') : FALSE,
    ];
    $this->listService
      ->setUp($options);
    if ($this->listService
      ->hasSettings()) {
      $callback = [
        $this->listService,
        'blockIsAllowed',
      ];
      $definitions = array_filter($definitions, $callback, ARRAY_FILTER_USE_KEY);
    }
    return $definitions;
  }

}

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::list	public	function	List.
DefaultController::__construct	public	function	Constructs a new DefaultController object.
LayoutController::getCaption	protected	function	Provide a caption for the table. Overrides DefaultController::getCaption
LayoutController::getList	protected	function	Create the list of block IDs. Overrides DefaultController::getList
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.