interface MultipleProviderAnnotationInterface

Same name and namespace in other branches
  1. 11.x core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php \Drupal\migrate\Annotation\MultipleProviderAnnotationInterface
  2. 10 core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php \Drupal\migrate\Annotation\MultipleProviderAnnotationInterface
  3. 9 core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php \Drupal\migrate\Annotation\MultipleProviderAnnotationInterface

Defines a common interface for classed annotations with multiple providers.

@todo This is a temporary solution to the fact that migration source plugins have more than one provider. This functionality will be moved to core in https://www.drupal.org/node/2786355.

Hierarchy

Expanded class hierarchy of MultipleProviderAnnotationInterface

All classes that implement MultipleProviderAnnotationInterface

1 file declares its use of MultipleProviderAnnotationInterface
AnnotatedClassDiscoveryAutomatedProviders.php in core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php

File

core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php, line 14

Namespace

Drupal\migrate\Annotation
View source
interface MultipleProviderAnnotationInterface extends AnnotationInterface {
  
  /**
   * Gets the name of the provider of the annotated class.
   *
   * @return string
   *   The provider of the annotation. If there are multiple providers the first
   *   is returned.
   */
  public function getProvider();
  
  /**
   * Gets the provider names of the annotated class.
   *
   * @return string[]
   *   The providers of the annotation.
   */
  public function getProviders();
  
  /**
   * Sets the provider names of the annotated class.
   *
   * @param string[] $providers
   *   The providers of the annotation.
   */
  public function setProviders(array $providers);

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.