Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\migrate_drupal\Plugin;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\Exception\PluginNotFoundException;
Chris@14: use Drupal\migrate\Plugin\Exception\BadPluginDefinitionException;
Chris@0: use Drupal\migrate\Plugin\MigratePluginManager;
Chris@0: use Drupal\migrate\Plugin\MigrationInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Plugin manager for migrate field plugins.
Chris@0:  *
Chris@0:  * @see \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
Chris@0:  * @see \Drupal\migrate\Annotation\MigrateField
Chris@0:  * @see plugin_api
Chris@0:  *
Chris@0:  * @ingroup migration
Chris@0:  */
Chris@0: class MigrateFieldPluginManager extends MigratePluginManager implements MigrateFieldPluginManagerInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The default version of core to use for field plugins.
Chris@0:    *
Chris@0:    * These plugins were initially only built and used for Drupal 6 fields.
Chris@0:    * Having been extended for Drupal 7 with a "core" annotation, we fall back to
Chris@0:    * Drupal 6 where none exists.
Chris@0:    */
Chris@0:   const DEFAULT_CORE_VERSION = 6;
Chris@0: 
Chris@0:   /**
Chris@18:    * Get the plugin ID from the field type.
Chris@18:    *
Chris@18:    * This method determines which field plugin should be used for a given field
Chris@18:    * type and Drupal core version, returning the lowest weighted plugin
Chris@18:    * supporting the provided core version, and which matches the field type
Chris@18:    * either by plugin ID, or in the type_map annotation keys.
Chris@18:    *
Chris@18:    * @param string $field_type
Chris@18:    *   The field type being migrated.
Chris@18:    * @param array $configuration
Chris@18:    *   (optional) An array of configuration relevant to the plugin instance.
Chris@18:    * @param \Drupal\migrate\Plugin\MigrationInterface $migration
Chris@18:    *   (optional) The current migration instance.
Chris@18:    *
Chris@18:    * @return string
Chris@18:    *   The ID of the plugin for the field type if available.
Chris@18:    *
Chris@18:    * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
Chris@18:    *   If the plugin cannot be determined, such as if the field type is invalid.
Chris@18:    *
Chris@18:    * @see \Drupal\migrate_drupal\Annotation\MigrateField
Chris@0:    */
Chris@0:   public function getPluginIdFromFieldType($field_type, array $configuration = [], MigrationInterface $migration = NULL) {
Chris@0:     $core = static::DEFAULT_CORE_VERSION;
Chris@0:     if (!empty($configuration['core'])) {
Chris@0:       $core = $configuration['core'];
Chris@0:     }
Chris@0:     elseif (!empty($migration->getPluginDefinition()['migration_tags'])) {
Chris@0:       foreach ($migration->getPluginDefinition()['migration_tags'] as $tag) {
Chris@0:         if ($tag == 'Drupal 7') {
Chris@0:           $core = 7;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     $definitions = $this->getDefinitions();
Chris@0:     foreach ($definitions as $plugin_id => $definition) {
Chris@0:       if (in_array($core, $definition['core'])) {
Chris@0:         if (array_key_exists($field_type, $definition['type_map']) || $field_type === $plugin_id) {
Chris@0:           return $plugin_id;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     throw new PluginNotFoundException($field_type);
Chris@0:   }
Chris@0: 
Chris@14:   /**
Chris@14:    * {@inheritdoc}
Chris@14:    */
Chris@14:   public function processDefinition(&$definition, $plugin_id) {
Chris@14:     parent::processDefinition($definition, $plugin_id);
Chris@14: 
Chris@14:     foreach (['core', 'source_module', 'destination_module'] as $required_property) {
Chris@14:       if (empty($definition[$required_property])) {
Chris@14:         throw new BadPluginDefinitionException($plugin_id, $required_property);
Chris@14:       }
Chris@14:     }
Chris@14:   }
Chris@14: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function findDefinitions() {
Chris@18:     $definitions = parent::findDefinitions();
Chris@18:     $this->sortDefinitions($definitions);
Chris@18:     return $definitions;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Sorts a definitions array.
Chris@18:    *
Chris@18:    * This sorts the definitions array first by the weight column, and then by
Chris@18:    * the plugin ID, ensuring a stable, deterministic, and testable ordering of
Chris@18:    * plugins.
Chris@18:    *
Chris@18:    * @param array $definitions
Chris@18:    *   The definitions array to sort.
Chris@18:    */
Chris@18:   protected function sortDefinitions(array &$definitions) {
Chris@18:     array_multisort(array_column($definitions, 'weight'), SORT_ASC, SORT_NUMERIC, array_keys($definitions), SORT_ASC, SORT_NATURAL, $definitions);
Chris@18:   }
Chris@18: 
Chris@0: }