Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\migrate\Annotation;
Chris@0: 
Chris@0: use Drupal\Component\Annotation\Plugin;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a migration source plugin annotation object.
Chris@0:  *
Chris@0:  * Plugin Namespace: Plugin\migrate\source
Chris@0:  *
Chris@0:  * For a working example, check
Chris@0:  * \Drupal\migrate\Plugin\migrate\source\EmptySource
Chris@0:  * \Drupal\migrate_drupal\Plugin\migrate\source\UrlAlias
Chris@0:  *
Chris@0:  * @see \Drupal\migrate\Plugin\MigratePluginManager
Chris@0:  * @see \Drupal\migrate\Plugin\MigrateSourceInterface
Chris@0:  * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
Chris@0:  * @see \Drupal\migrate\Annotation\MigrateProcessPlugin
Chris@0:  * @see \Drupal\migrate\Annotation\MigrateDestination
Chris@0:  * @see plugin_api
Chris@0:  *
Chris@0:  * @ingroup migration
Chris@0:  *
Chris@0:  * @Annotation
Chris@0:  */
Chris@0: class MigrateSource extends Plugin implements MultipleProviderAnnotationInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * A unique identifier for the process plugin.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   public $id;
Chris@0: 
Chris@0:   /**
Chris@0:    * Whether requirements are met.
Chris@0:    *
Chris@0:    * @var bool
Chris@0:    */
Chris@0:   public $requirements_met = TRUE;
Chris@0: 
Chris@0:   /**
Chris@0:    * Identifies the system providing the data the source plugin will read.
Chris@0:    *
Chris@0:    * The source plugin itself determines how the value is used. For example,
Chris@0:    * Migrate Drupal's source plugins expect source_module to be the name of a
Chris@0:    * module that must be installed and enabled in the source database.
Chris@0:    *
Chris@0:    * @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   public $source_module;
Chris@0: 
Chris@0:   /**
Chris@0:    * Specifies the minimum version of the source provider.
Chris@0:    *
Chris@0:    * This can be any type, and the source plugin itself determines how it is
Chris@0:    * used. For example, Migrate Drupal's source plugins expect this to be an
Chris@0:    * integer representing the minimum installed database schema version of the
Chris@0:    * module specified by source_module.
Chris@0:    *
Chris@0:    * @var mixed
Chris@0:    */
Chris@0:   public $minimum_version;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getProvider() {
Chris@0:     if (isset($this->definition['provider'])) {
Chris@0:       return is_array($this->definition['provider']) ? reset($this->definition['provider']) : $this->definition['provider'];
Chris@0:     }
Chris@0:     return FALSE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getProviders() {
Chris@0:     if (isset($this->definition['provider'])) {
Chris@0:       // Ensure that we return an array even if
Chris@0:       // \Drupal\Component\Annotation\AnnotationInterface::setProvider() has
Chris@0:       // been called.
Chris@0:       return (array) $this->definition['provider'];
Chris@0:     }
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setProviders(array $providers) {
Chris@0:     $this->definition['provider'] = $providers;
Chris@0:   }
Chris@0: 
Chris@0: }