D7FieldablePanelsPaneDeriver.php in Fieldable Panels Panes (FPP) 1.0.x

Namespace

Drupal\fieldable_panels_panes\Plugin\migrate

File

src/Plugin/migrate/D7FieldablePanelsPaneDeriver.php

<?php

namespace Drupal\fieldable_panels_panes\Plugin\migrate;

use Drupal\Component\Plugin\Derivative\DeriverBase;
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\migrate\Exception\RequirementsException;
use Drupal\migrate\Plugin\MigrationDeriverTrait;
use Drupal\migrate_drupal\FieldDiscoveryInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Deriver for Drupal 7 fieldable panel panes based on pane types.
 */
class D7FieldablePanelsPaneDeriver extends DeriverBase implements ContainerDeriverInterface {
  use MigrationDeriverTrait;
  use StringTranslationTrait;

  /**
   * The base plugin ID this derivative is for.
   *
   * @var string
   */
  protected $basePluginId;

  /**
   * Whether or not to include translations.
   *
   * @var bool
   */
  protected $includeTranslations;

  /**
   * The migration field discovery service.
   *
   * @var \Drupal\migrate_drupal\FieldDiscoveryInterface
   */
  protected $fieldDiscovery;

  /**
   * D7NodeDeriver constructor.
   *
   * @param string $base_plugin_id
   *   The base plugin ID for the plugin ID.
   * @param bool $translations
   *   Whether or not to include translations.
   * @param \Drupal\migrate_drupal\FieldDiscoveryInterface $field_discovery
   *   The migration field discovery service.
   */
  public function __construct($base_plugin_id, $translations, FieldDiscoveryInterface $field_discovery) {
    $this->basePluginId = $base_plugin_id;
    $this->includeTranslations = $translations;
    $this->fieldDiscovery = $field_discovery;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {

    // Translations don't make sense unless we have content_translation.
    return new static($base_plugin_id, $container
      ->get('module_handler')
      ->moduleExists('content_translation'), $container
      ->get('migrate_drupal.field_discovery'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    if (in_array('translation', $base_plugin_definition['migration_tags']) && !$this->includeTranslations) {

      // Refuse to generate anything.
      return $this->derivatives;
    }
    $types = static::getSourcePlugin('d7_fieldable_panels_pane_type');
    try {
      $types
        ->checkRequirements();
    } catch (RequirementsException $e) {

      // If the d7_node_type requirements failed, that means we do not have a
      // Drupal source database configured - there is nothing to generate.
      return $this->derivatives;
    }
    try {
      foreach ($types as $row) {
        $bundle = $row
          ->getSourceProperty('name');
        $values = $base_plugin_definition;
        $values['label'] = $this
          ->t('@label (@type)', [
          '@label' => $values['label'],
          '@type' => $row
            ->getSourceProperty('name'),
        ]);
        $values['source']['bundle'] = $bundle;
        $values['destination']['default_bundle'] = $bundle;

        // If this migration is based on the d7_fieldable_panels_pane_revision
        // migration or is for translations of fieldable panel panes, it should
        // explicitly depend on the corresponding d7_fieldable_panels_pane
        // variant.
        if ($base_plugin_definition['id'] == [
          'd7_fieldable_panels_pane_revision',
        ] || in_array('translation', $base_plugin_definition['migration_tags'])) {
          $values['migration_dependencies']['required'][] = 'd7_fieldable_panels_pane:' . $bundle;
        }

        /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
        $migration = \Drupal::service('plugin.manager.migration')
          ->createStubMigration($values);
        $this->fieldDiscovery
          ->addBundleFieldProcesses($migration, 'fieldable_panels_pane', $bundle);
        $this->derivatives[$bundle] = $migration
          ->getPluginDefinition();
      }
    } catch (DatabaseExceptionWrapper $e) {

      // Once we begin iterating the source plugin it is possible that the
      // source tables will not exist. This can happen when the
      // MigrationPluginManager gathers up the migration definitions but we do
      // not actually have a Drupal 7 source database.
    }
    return $this->derivatives;
  }

}

Classes

Name	Description
D7FieldablePanelsPaneDeriver	Deriver for Drupal 7 fieldable panel panes based on pane types.