annotate core/modules/migrate/src/Annotation/MultipleProviderAnnotationInterface.php @ 19:fa3358dc1485 tip

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