class PluginAlter in Block Blacklist [Deprecated] 8

Implementation callbacks for plugin alter hooks.

Hierarchy

• class \Drupal\block_blacklist\PluginAlter implements ContainerInjectionInterface

File

src/PluginAlter.php, line 14

Namespace

Drupal\block_blacklist

class PluginAlter implements ContainerInjectionInterface {

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

  /**
   * The Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Blacklist service.
   *
   * @var \Drupal\block_blacklist\Blacklist
   */
  protected $blacklistService;

  /**
   * PluginAlter constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   Configuration factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The Entity Type Manager service.
   * @param \Drupal\block_blacklist\Blacklist $blacklist_service
   *   The Block Blacklist service.
   */
  protected function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, Blacklist $blacklist_service) {
    $this->configFactory = $config_factory;
    $this->entityTypeManager = $entity_type_manager;
    $this->blacklistService = $blacklist_service;
    $this
      ->setUp();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('block_blacklist.blacklist'));
  }

  /**
   * Configure variables based on configuration settings.
   */
  protected function setUp() {
    $settings = $this->configFactory
      ->get('block_blacklist.settings');
    $options = [
      'match' => !empty($settings) ? trim($settings
        ->get('system_match')) : '',
      'prefix' => !empty($settings) ? trim($settings
        ->get('system_prefix')) : '',
      'regex' => !empty($settings) ? trim($settings
        ->get('system_regex')) : '',
    ];
    $this->blacklistService
      ->setUp($options);
  }

  /**
   * Alters block definitions.
   *
   * Speeds up the system performance and the Layout Builder page by removing
   * as many blocks as possible from the system, decreasing the number that it
   * has to parse.
   *
   * @see hook_block_alter()
   * @see hook_plugin_filter_TYPE__CONSUMER_alter()
   */
  public function alterBlocks(&$definitions) {
    if (!$this->blacklistService
      ->hasSettings()) {
      return;
    }
    $callback = [
      $this->blacklistService,
      'blockIsAllowed',
    ];
    $definitions = array_filter($definitions, $callback, ARRAY_FILTER_USE_KEY);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginAlter::$blacklistService	protected	property	Blacklist service.
PluginAlter::$configFactory	protected	property	The Config factory service.
PluginAlter::$entityTypeManager	protected	property	The Entity Type Manager service.
PluginAlter::alterBlocks	public	function	Alters block definitions.
PluginAlter::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
PluginAlter::setUp	protected	function	Configure variables based on configuration settings.	1
PluginAlter::__construct	protected	function	PluginAlter constructor.