1. interface
  2. Drupal
  3. \
  4. migrate
  5. \
  6. Annotation
  7. \
  8. MultipleProviderAnnotationInterface

MultipleProviderAnnotationInterface

interface MultipleProviderAnnotationInterface implements AnnotationInterface (View source)

Defines a common interface for classed annotations with multiple providers.

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.

Methods

get()

Gets the value of an annotation.

from  AnnotationInterface
string
getProvider()

Gets the name of the provider of the annotated class.

setProvider(string $provider)

Sets the name of the provider of the annotated class.

from  AnnotationInterface
string
getId()

Gets the unique ID for this annotated class.

from  AnnotationInterface
string
getClass()

Gets the class of the annotated class.

from  AnnotationInterface
setClass(string $class)

Sets the class of the annotated class.

from  AnnotationInterface
string[]
getProviders()

Gets the provider names of the annotated class.

setProviders(array $providers)

Sets the provider names of the annotated class.

Details

in AnnotationInterface at line 13
get()

Gets the value of an annotation.

at line 23
string getProvider()

Gets the name of the provider of the annotated class.

Return Value

string

in AnnotationInterface at line 28
setProvider(string $provider)

Sets the name of the provider of the annotated class.

Parameters

string $provider

The provider of the annotated class.

in AnnotationInterface at line 35
string getId()

Gets the unique ID for this annotated class.

Return Value

string

in AnnotationInterface at line 42
string getClass()

Gets the class of the annotated class.

Return Value

string

in AnnotationInterface at line 50
setClass(string $class)

Sets the class of the annotated class.

Parameters

string $class

The class of the annotated class.

at line 31
string[] getProviders()

Gets the provider names of the annotated class.

Return Value

string[]

The providers of the annotation.

at line 39
setProviders(array $providers)

Sets the provider names of the annotated class.

Parameters

array $providers

The providers of the annotation.