www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/block/src/BlockRepositoryInterface.php

   1 <?php
   2
   3 namespace Drupal\block;
   4
   5 interface BlockRepositoryInterface {
   6
   7   /**
   8    * Return only visible regions.
   9    *
  10    * @see system_region_list()
  11    */
  12   const REGIONS_VISIBLE = 'visible';
  13
  14   /**
  15    * Return all regions.
  16    *
  17    * @see system_region_list()
  18    */
  19   const REGIONS_ALL = 'all';
  20
  21   /**
  22    * Returns an array of regions and their block entities.
  23    *
  24    * @param \Drupal\Core\Cache\CacheableMetadata[] $cacheable_metadata
  25    *   (optional) List of CacheableMetadata objects, keyed by region. This is
  26    *   by reference and is used to pass this information back to the caller.
  27    *
  28    * @return array
  29    *   The array is first keyed by region machine name, with the values
  30    *   containing an array keyed by block ID, with block entities as the values.
  31    */
  32   public function getVisibleBlocksPerRegion(array &$cacheable_metadata = []);
  33
  34 }