You are here

class BlockRegion in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/block/src/Plugin/migrate/process/BlockRegion.php \Drupal\block\Plugin\migrate\process\BlockRegion

Plugin annotation


@MigrateProcessPlugin(
  id = "block_region"
)

Hierarchy

Expanded class hierarchy of BlockRegion

1 file declares its use of BlockRegion
BlockRegionTest.php in core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockRegionTest.php
Contains \Drupal\Tests\block\Unit\Plugin\migrate\process\BlockRegionTest.

File

core/modules/block/src/Plugin/migrate/process/BlockRegion.php, line 21
Contains \Drupal\block\Plugin\migrate\process\BlockRegion.

Namespace

Drupal\block\Plugin\migrate\process
View source
class BlockRegion extends ProcessPluginBase implements ContainerFactoryPluginInterface {

  /**
   * List of regions, keyed by theme.
   *
   * @var array[]
   */
  protected $regions;

  /**
   * Constructs a BlockRegion plugin instance.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param array $regions
   *   Array of region maps, keyed by theme.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $regions) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->regions = $regions;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $regions = array();
    foreach ($container
      ->get('theme_handler')
      ->listInfo() as $key => $theme) {
      $regions[$key] = $theme->info['regions'];
    }
    return new static($configuration, $plugin_id, $plugin_definition, $regions);
  }

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {

    // Set the destination region, based on the source region and theme as well
    // as the current destination default theme.
    list($region, $source_theme, $destination_theme) = $value;

    // Theme is the same on both source and destination, so ensure that the
    // region exists in the destination theme.
    if (strtolower($source_theme) == strtolower($destination_theme)) {
      if (isset($this->regions[$destination_theme][$region])) {
        return $region;
      }
    }

    // If the source and destination theme are different, try to use the
    // mappings defined in the configuration.
    $region_map = $this->configuration['region_map'];
    if (isset($region_map[$region])) {
      return $region_map[$region];
    }

    // Oh well, we tried. Put the block in the main content region.
    return 'content';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockRegion::$regions protected property List of regions, keyed by theme.
BlockRegion::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockRegion::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
BlockRegion::__construct public function Constructs a BlockRegion plugin instance. Overrides PluginBase::__construct
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
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 2
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.