Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\migrate_drupal\Annotation;
Chris@0: 
Chris@0: use Drupal\Component\Annotation\Plugin;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a field plugin annotation object.
Chris@0:  *
Chris@0:  * Field plugins are responsible for handling the migration of custom fields
Chris@0:  * (provided by CCK in Drupal 6 and Field API in Drupal 7) to Drupal 8. They are
Chris@0:  * allowed to alter fieldable entity migrations when these migrations are being
Chris@0:  * generated, and can compute destination field types for individual fields
Chris@0:  * during the actual migration process.
Chris@0:  *
Chris@0:  * Plugin Namespace: Plugin\migrate\field
Chris@0:  *
Chris@0:  * @Annotation
Chris@0:  */
Chris@0: class MigrateField extends Plugin {
Chris@0: 
Chris@0:   /**
Chris@0:    * @inheritdoc
Chris@0:    */
Chris@0:   public function __construct($values) {
Chris@0:     parent::__construct($values);
Chris@0:     // Provide default value for core property, in case it's missing.
Chris@0:     if (empty($this->definition['core'])) {
Chris@0:       $this->definition['core'] = [6];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * The plugin ID.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   public $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * Map of D6 and D7 field types to D8 field type plugin IDs.
Chris@0:    *
Chris@0:    * @var string[]
Chris@0:    */
Chris@0:   public $type_map = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * The Drupal core version(s) this plugin applies to.
Chris@0:    *
Chris@0:    * @var int[]
Chris@0:    */
Chris@14:   public $core;
Chris@14: 
Chris@14:   /**
Chris@14:    * Identifies the system providing the data the field plugin will read.
Chris@14:    *
Chris@14:    * The source_module is expected to be the name of a Drupal module that must
Chris@16:    * be installed in the source database.
Chris@14:    *
Chris@14:    * @var string
Chris@14:    */
Chris@14:   public $source_module;
Chris@14: 
Chris@14:   /**
Chris@14:    * Identifies the system handling the data the destination plugin will write.
Chris@14:    *
Chris@14:    * The destination_module is expected to be the name of a Drupal module on the
Chris@14:    * destination site that must be installed.
Chris@14:    *
Chris@14:    * @var string
Chris@14:    */
Chris@14:   public $destination_module;
Chris@0: 
Chris@18:   /**
Chris@18:    * The weight of this plugin relative to other plugins.
Chris@18:    *
Chris@18:    * The weight of this plugin relative to other plugins servicing the same
Chris@18:    * field type and core version.  The lowest weighted applicable plugin will be
Chris@18:    * used for each field.
Chris@18:    *
Chris@18:    * @var int
Chris@18:    */
Chris@18:   public $weight = 0;
Chris@18: 
Chris@0: }