BlockCollection.php in Context 8.4

Namespace

Drupal\context\Reaction\Blocks

File

src/Reaction/Blocks/BlockCollection.php

<?php

namespace Drupal\context\Reaction\Blocks;

use Drupal\Core\Block\BlockPluginInterface;
use Drupal\Core\Plugin\DefaultLazyPluginCollection;

/**
 * Provide a Block collection.
 */
class BlockCollection extends DefaultLazyPluginCollection {

  /**
   * {@inheritdoc}
   */
  public function &get($instance_id) {
    return parent::get($instance_id);
  }

  /**
   * Returns all blocks keyed by their region.
   *
   * Base code from the ctools block plugin collection.
   *
   * @param string $theme
   *   The theme to get blocks for.
   *
   * @return \Drupal\Core\Block\BlockPluginInterface[]
   *   An associative array keyed by region, containing an associative array of
   *   block plugins.
   */
  public function getAllByRegion($theme) {
    $region_assignments = [];

    /** @var \Drupal\Core\Block\BlockPluginInterface[] $this */
    foreach ($this as $block_id => $block) {
      $configuration = $block
        ->getConfiguration();
      if (isset($configuration['theme']) && $configuration['theme'] !== $theme) {
        continue;
      }
      $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;
  }

}

Classes

Name	Description
BlockCollection	Provide a Block collection.