You are here

BlockRepositoryInterface.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 core/modules/block/src/BlockRepositoryInterface.php

Namespace

Drupal\block

File

core/modules/block/src/BlockRepositoryInterface.php
View source
<?php

/**
 * @file
 * Contains \Drupal\block\BlockRepositoryInterface.
 */
namespace Drupal\block;

interface BlockRepositoryInterface {

  /**
   * Returns an array of regions and their block entities.
   *
   * @param \Drupal\Core\Cache\CacheableMetadata[] $cacheable_metadata
   *   (optional) List of CacheableMetadata objects, keyed by region. This is
   *   by reference and is used to pass this information back to the caller.
   *
   * @return array
   *   The array is first keyed by region machine name, with the values
   *   containing an array keyed by block ID, with block entities as the values.
   */
  public function getVisibleBlocksPerRegion(array &$cacheable_metadata = []);

}

Interfaces