You are here

Home » API reference » Drupal 8 » MenuLinkParent.php

class MenuLinkParent in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/MenuLinkParent.php \Drupal\migrate\Plugin\migrate\process\MenuLinkParent

This plugin figures out menu link parent plugin IDs.

Plugin annotation


@MigrateProcessPlugin(
  id = "menu_link_parent"
)

Hierarchy

Expanded class hierarchy of MenuLinkParent

1 file declares its use of MenuLinkParent
MenuLinkParentTest.php in core/modules/migrate/tests/src/Unit/process/MenuLinkParentTest.php

File

core/modules/migrate/src/Plugin/migrate/process/MenuLinkParent.php, line 26

Namespace

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

  /**
   * @var \Drupal\Core\Menu\MenuLinkManagerInterface
   */
  protected $menuLinkManager;

  /**
   * The Migration process plugin.
   *
   * @var \Drupal\migrate\Plugin\MigrateProcessInterface
   *
   * @deprecated in drupal:8.8.x and is removed from drupal:9.0.0. Use
   *   the migrate.lookup service instead.
   *
   * @see https://www.drupal.org/node/3047268
   */
  protected $migrationPlugin;

  /**
   * The currently running migration.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;

  /**
   * The migrate lookup service.
   *
   * @var \Drupal\migrate\MigrateLookupInterface
   */
  protected $migrateLookup;

  /**
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $menuLinkStorage;

  /**
   * Constructs a MenuLinkParent object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
   *   The migrate lookup service.
   * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
   *   The menu link manager.
   * @param \Drupal\Core\Entity\EntityStorageInterface $menu_link_storage
   *   The menu link storage object.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The currently running migration.
   */

  // @codingStandardsIgnoreLine
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $migrate_lookup, MenuLinkManagerInterface $menu_link_manager, EntityStorageInterface $menu_link_storage, MigrationInterface $migration = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    if ($migrate_lookup instanceof MigrateProcessInterface) {
      @trigger_error('Passing a migration process plugin as the fourth argument to ' . __METHOD__ . ' is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268', E_USER_DEPRECATED);
      $this->migrationPlugin = $migrate_lookup;
      $migrate_lookup = \Drupal::service('migrate.lookup');
    }
    elseif (!$migrate_lookup instanceof MigrateLookupInterface) {
      throw new \InvalidArgumentException("The fourth argument to " . __METHOD__ . " must be an instance of MigrateLookupInterface.");
    }
    elseif (!$migration instanceof MigrationInterface) {
      throw new \InvalidArgumentException("The seventh argument to " . __METHOD__ . " must be an instance of MigrationInterface.");
    }
    $this->migration = $migration;
    $this->migrateLookup = $migrate_lookup;
    $this->menuLinkManager = $menu_link_manager;
    $this->menuLinkStorage = $menu_link_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $migration_configuration['migration'][] = $migration
      ->id();
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('migrate.lookup'), $container
      ->get('plugin.manager.menu.link'), $container
      ->get('entity_type.manager')
      ->getStorage('menu_link_content'), $migration);
  }

  /**
   * {@inheritdoc}
   *
   * Find the parent link GUID.
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $parent_id = array_shift($value);
    if (!$parent_id) {

      // Top level item.
      return '';
    }

    // This BC layer is included because if the plugin constructor was called
    // in the legacy way with a migration_lookup process plugin, it may have
    // been preconfigured with a different migration to look up against. While
    // this is unlikely, for maximum BC we will continue to use the plugin to do
    // the lookup if it is provided, and support for this will be removed in
    // Drupal 9.
    if ($this->migrationPlugin) {
      try {
        $already_migrated_id = $this->migrationPlugin
          ->transform($parent_id, $migrate_executable, $row, $destination_property);
      } catch (MigrateSkipRowException $e) {
      }
    }
    else {
      $lookup_result = $this->migrateLookup
        ->lookup($this->migration
        ->id(), [
        $parent_id,
      ]);
      if ($lookup_result) {
        $already_migrated_id = $lookup_result[0]['id'];
      }
    }
    if (!empty($already_migrated_id) && ($link = $this->menuLinkStorage
      ->load($already_migrated_id))) {
      return $link
        ->getPluginId();
    }
    if (isset($value[1])) {
      list($menu_name, $parent_link_path) = $value;
      $links = [];
      if (UrlHelper::isExternal($parent_link_path)) {
        $links = $this->menuLinkStorage
          ->loadByProperties([
          'link__uri' => $parent_link_path,
        ]);
      }
      else {
        $url = Url::fromUserInput("/{$parent_link_path}");
        if ($url
          ->isRouted()) {
          $links = $this->menuLinkManager
            ->loadLinksByRoute($url
            ->getRouteName(), $url
            ->getRouteParameters(), $menu_name);
        }
      }
      if (count($links) == 1) {

        /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
        $link = reset($links);
        return $link
          ->getPluginId();
      }
    }
    throw new MigrateSkipRowException(sprintf("No parent link found for plid '%d' in menu '%s'.", $parent_id, $value[0]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
MenuLinkParent::$menuLinkManager protected property
MenuLinkParent::$menuLinkStorage protected property
MenuLinkParent::$migrateLookup protected property The migrate lookup service.
MenuLinkParent::$migration protected property The currently running migration.
MenuLinkParent::$migrationPlugin Deprecated protected property The Migration process plugin.
MenuLinkParent::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MenuLinkParent::transform public function Find the parent link GUID. Overrides ProcessPluginBase::transform
MenuLinkParent::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
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 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.