aleph1.co.uk Git - yaffs-website/blob - web/core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php

   1 <?php
   2
   3 namespace Drupal\migrate\Annotation;
   4
   5 use Drupal\Component\Annotation\AnnotationInterface;
   6
   7 /**
   8  * Defines a common interface for classed annotations with multiple providers.
   9  *
  10  * @todo This is a temporary solution to the fact that migration source plugins
  11  *   have more than one provider. This functionality will be moved to core in
  12  *   https://www.drupal.org/node/2786355.
  13  */
  14 interface MultipleProviderAnnotationInterface extends AnnotationInterface {
  15
  16   /**
  17    * Gets the name of the provider of the annotated class.
  18    *
  19    * @return string
  20    *   The provider of the annotation. If there are multiple providers the first
  21    *   is returned.
  22    */
  23   public function getProvider();
  24
  25   /**
  26    * Gets the provider names of the annotated class.
  27    *
  28    * @return string[]
  29    *   The providers of the annotation.
  30    */
  31   public function getProviders();
  32
  33   /**
  34    * Sets the provider names of the annotated class.
  35    *
  36    * @param string[] $providers
  37    *   The providers of the annotation.
  38    */
  39   public function setProviders(array $providers);
  40
  41 }