class BlockVisibility

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

Hierarchy

Expanded class hierarchy of BlockVisibility

1 file declares its use of BlockVisibility
BlockVisibilityTest.php in core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php

File

core/modules/block/src/Plugin/migrate/process/BlockVisibility.php, line 16

Namespace

Drupal\block\Plugin\migrate\process
View source
class BlockVisibility extends ProcessPluginBase implements ContainerFactoryPluginInterface {
  
  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;
  
  /**
   * The migrate lookup service.
   *
   * @var \Drupal\migrate\MigrateLookupInterface
   */
  protected $migrateLookup;
  
  /**
   * Whether or not to skip blocks that use PHP for visibility.
   *
   * Only applies if the PHP module is not enabled.
   *
   * @var bool
   */
  protected $skipPHP = FALSE;
  
  /**
   * Constructs a BlockVisibility object.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
   *   The migrate lookup service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, MigrateLookupInterface $migrate_lookup) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
    $this->migrateLookup = $migrate_lookup;
    if (isset($configuration['skip_php'])) {
      $this->skipPHP = $configuration['skip_php'];
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('module_handler'), $container->get('migrate.lookup'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    [
      $old_visibility,
      $pages,
      $roles,
    ] = $value;
    $visibility = [];
    // If the block is assigned to specific roles, add the user_role condition.
    if ($roles) {
      $visibility['user_role'] = [
        'id' => 'user_role',
        'roles' => [],
        'context_mapping' => [
          'user' => '@user.current_user_context:current_user',
        ],
        'negate' => FALSE,
      ];
      // Legacy generated migrations will not have the destination property
      // '_role_ids'.
      $role_ids = $row->getDestinationProperty('_role_ids');
      foreach ($roles as $key => $role_id) {
        if (!$role_ids) {
          $lookup = $this->migrateLookup
            ->lookup([
            'd6_user_role',
            'd7_user_role',
          ], [
            $role_id,
          ]);
          $lookup_result = $lookup[0]['id'];
        }
        else {
          $lookup_result = $role_ids[$role_id] ?? NULL;
        }
        if ($lookup_result) {
          $roles[$key] = $lookup_result;
        }
      }
      $visibility['user_role']['roles'] = array_combine($roles, $roles);
    }
    if ($pages) {
      // 2 == BLOCK_VISIBILITY_PHP in Drupal 6 and 7.
      if ($old_visibility == 2) {
        // If the PHP module is present, migrate the visibility code unaltered.
        if ($this->moduleHandler
          ->moduleExists('php')) {
          $visibility['php'] = [
            'id' => 'php',
            // PHP code visibility could not be negated in Drupal 6 or 7.
'negate' => FALSE,
            'php' => $pages,
          ];
        }
        elseif ($this->skipPHP) {
          throw new MigrateSkipRowException(sprintf("The block with bid '%d' from module '%s' will have no PHP or request_path visibility configuration.", $row->getSourceProperty('bid'), $row->getSourceProperty('module')));
        }
      }
      else {
        $paths = preg_split("(\r\n?|\n)", $pages);
        foreach ($paths as $key => $path) {
          $paths[$key] = $path === '<front>' ? $path : '/' . ltrim($path, '/');
        }
        $visibility['request_path'] = [
          'id' => 'request_path',
          'negate' => !$old_visibility,
          'pages' => implode("\n", $paths),
        ];
      }
    }
    return $visibility;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlockVisibility::$migrateLookup protected property The migrate lookup service.
BlockVisibility::$moduleHandler protected property The module handler.
BlockVisibility::$skipPHP protected property Whether or not to skip blocks that use PHP for visibility.
BlockVisibility::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockVisibility::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
BlockVisibility::__construct public function Constructs a BlockVisibility object.
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.