/core/modules/migrate/src/Plugin/migrate/process/MenuLinkParent.php
PHP | 177 lines | 94 code | 15 blank | 68 comment | 14 complexity | 37779fb3acc664aca4aa407d86b1fcb7 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1
- <?php
- namespace Drupal\migrate\Plugin\migrate\process;
- use Drupal\Component\Utility\UrlHelper;
- use Drupal\Core\Entity\EntityStorageInterface;
- use Drupal\Core\Menu\MenuLinkManagerInterface;
- use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
- use Drupal\Core\Url;
- use Drupal\migrate\MigrateLookupInterface;
- use Drupal\migrate\Plugin\MigrationInterface;
- use Drupal\migrate\MigrateExecutableInterface;
- use Drupal\migrate\MigrateSkipRowException;
- use Drupal\migrate\Plugin\MigrateProcessInterface;
- use Drupal\migrate\ProcessPluginBase;
- use Drupal\migrate\Row;
- use Symfony\Component\DependencyInjection\ContainerInterface;
- /**
- * This plugin figures out menu link parent plugin IDs.
- *
- * @MigrateProcessPlugin(
- * id = "menu_link_parent"
- * )
- */
- 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]));
- }
- }