class BlockPluginCollection in Chaos Tool Suite (ctools) 8.3

Provides a collection of block plugins.

Hierarchy

• class \Drupal\Component\Plugin\LazyPluginCollection implements \Drupal\Component\Plugin\IteratorAggregate, \Drupal\Component\Plugin\Countable
  • class \Drupal\Core\Plugin\DefaultLazyPluginCollection uses DependencySerializationTrait
    • class \Drupal\ctools\Plugin\BlockPluginCollection

2 files declare their use of BlockPluginCollection

BlockPluginCollectionTest.php in tests/src/Unit/BlockPluginCollectionTest.php

BlockVariantTraitTest.php in tests/src/Unit/BlockVariantTraitTest.php

File

src/Plugin/BlockPluginCollection.php, line 11

Namespace

Drupal\ctools\Plugin

class BlockPluginCollection extends DefaultLazyPluginCollection {

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Block\BlockPluginInterface
   */
  public function &get($instance_id) {
    return parent::get($instance_id);
  }

  /**
   * Returns all blocks keyed by their region.
   *
   * @return array
   *   An associative array keyed by region, containing an associative array of
   *   block plugins.
   */
  public function getAllByRegion() {
    $region_assignments = [];
    foreach ($this as $block_id => $block) {
      $configuration = $block
        ->getConfiguration();
      $region = isset($configuration['region']) ? $configuration['region'] : NULL;
      $region_assignments[$region][$block_id] = $block;
    }
    foreach ($region_assignments as $region => $region_assignment) {

      // @todo Determine the reason this needs error suppression.
      @uasort($region_assignment, function (BlockPluginInterface $a, BlockPluginInterface $b) {
        $a_config = $a
          ->getConfiguration();
        $a_weight = isset($a_config['weight']) ? $a_config['weight'] : 0;
        $b_config = $b
          ->getConfiguration();
        $b_weight = isset($b_config['weight']) ? $b_config['weight'] : 0;
        if ($a_weight == $b_weight) {
          return strcmp($a
            ->label(), $b
            ->label());
        }
        return $a_weight > $b_weight ? 1 : -1;
      });
      $region_assignments[$region] = $region_assignment;
    }
    return $region_assignments;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginCollection::get	public	function	Overrides LazyPluginCollection::get
BlockPluginCollection::getAllByRegion	public	function	Returns all blocks keyed by their region.
DefaultLazyPluginCollection::$configurations	protected	property	The initial configuration for each plugin in the collection.
DefaultLazyPluginCollection::$manager	protected	property	The manager used to instantiate the plugins.
DefaultLazyPluginCollection::$originalOrder	protected	property	The original order of the instances.
DefaultLazyPluginCollection::$pluginKey	protected	property	The key within the plugin configuration that contains the plugin ID.	3
DefaultLazyPluginCollection::addInstanceId	public	function	Adds an instance ID to the available instance IDs. Overrides LazyPluginCollection::addInstanceId
DefaultLazyPluginCollection::getConfiguration	public	function	Gets the current configuration of all plugins in this collection. Overrides LazyPluginCollection::getConfiguration	2
DefaultLazyPluginCollection::initializePlugin	protected	function	Initializes and stores a plugin. Overrides LazyPluginCollection::initializePlugin	2
DefaultLazyPluginCollection::removeInstanceId	public	function	Removes an instance ID. Overrides LazyPluginCollection::removeInstanceId
DefaultLazyPluginCollection::setConfiguration	public	function	Sets the configuration for all plugins in this collection. Overrides LazyPluginCollection::setConfiguration
DefaultLazyPluginCollection::setInstanceConfiguration	public	function	Updates the configuration for a plugin instance.
DefaultLazyPluginCollection::sort	public	function	Sorts all plugin instances in this collection.	1
DefaultLazyPluginCollection::sortHelper	public	function	Provides uasort() callback to sort plugins.	2
DefaultLazyPluginCollection::__construct	public	function	Constructs a new DefaultLazyPluginCollection object.	1
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LazyPluginCollection::$instanceIds	protected	property	Stores the IDs of all potential plugin instances.
LazyPluginCollection::$pluginInstances	protected	property	Stores all instantiated plugins.
LazyPluginCollection::clear	public	function	Clears all instantiated plugins.
LazyPluginCollection::count	public	function
LazyPluginCollection::getInstanceIds	public	function	Gets all instance IDs.
LazyPluginCollection::getIterator	public	function
LazyPluginCollection::has	public	function	Determines if a plugin instance exists.
LazyPluginCollection::remove	public	function	Removes an initialized plugin.
LazyPluginCollection::set	public	function	Stores an initialized plugin.