ShortcutSetUsers.php

Same filename in this branch
  1. 8.9.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php
Same filename in other branches
  1. 9 core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php
  2. 9 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php
  3. 10 core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php
  4. 10 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php
  5. 11.x core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php
  6. 11.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php

Namespace

Drupal\shortcut\Plugin\migrate\destination

File

core/modules/shortcut/src/Plugin/migrate/destination/ShortcutSetUsers.php

View source
<?php

namespace Drupal\shortcut\Plugin\migrate\destination;

use Drupal\shortcut\ShortcutSetStorageInterface;
use Drupal\user\Entity\User;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Row;
use Drupal\migrate\Plugin\migrate\destination\DestinationBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

/**
 * @MigrateDestination(
 *   id = "shortcut_set_users"
 * )
 */
class ShortcutSetUsers extends DestinationBase implements ContainerFactoryPluginInterface {
    
    /**
     * The shortcut set storage handler.
     *
     * @var \Drupal\shortcut\ShortcutSetStorageInterface
     */
    protected $shortcutSetStorage;
    
    /**
     * Constructs an entity destination plugin.
     *
     * @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\Plugin\MigrationInterface $migration
     *   The migration.
     * @param \Drupal\shortcut\ShortcutSetStorageInterface $shortcut_set_storage
     *   The shortcut_set entity storage handler.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, ShortcutSetStorageInterface $shortcut_set_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
        $this->shortcutSetStorage = $shortcut_set_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('entity_type.manager')
            ->getStorage('shortcut_set'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        return [
            'set_name' => [
                'type' => 'string',
            ],
            'uid' => [
                'type' => 'integer',
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields(MigrationInterface $migration = NULL) {
        return [
            'uid' => 'The users.uid for this set.',
            'source' => 'The shortcut_set.set_name that will be displayed for this user.',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function import(Row $row, array $old_destination_id_values = []) {
        
        /** @var \Drupal\shortcut\ShortcutSetInterface $set */
        $set = $this->shortcutSetStorage
            ->load($row->getDestinationProperty('set_name'));
        
        /** @var \Drupal\user\UserInterface $account */
        $account = User::load($row->getDestinationProperty('uid'));
        $this->shortcutSetStorage
            ->assignUser($set, $account);
        return [
            $set->id(),
            $account->id(),
        ];
    }

}

Classes

Title Deprecated Summary
ShortcutSetUsers Plugin annotation @MigrateDestination( id = "shortcut_set_users" )

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