class BlockRegion

Same name in other branches
  1. 9 core/modules/block/src/Plugin/migrate/process/BlockRegion.php \Drupal\block\Plugin\migrate\process\BlockRegion
  2. 8.9.x core/modules/block/src/Plugin/migrate/process/BlockRegion.php \Drupal\block\Plugin\migrate\process\BlockRegion
  3. 11.x core/modules/block/src/Plugin/migrate/process/BlockRegion.php \Drupal\block\Plugin\migrate\process\BlockRegion

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

File

core/modules/block/src/Plugin/migrate/process/BlockRegion.php, line 12

Namespace

Drupal\block\Plugin\migrate\process
View source
class BlockRegion extends StaticMap 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 = [];
        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.
        [
            $source_theme,
            $destination_theme,
            $region,
        ] = $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;
            }
        }
        // Fall back to static mapping.
        return parent::transform($value, $migrate_executable, $row, $destination_property);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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 StaticMap::transform
BlockRegion::__construct public function Constructs a BlockRegion plugin instance.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.