1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Annotation
  7. \
  8. Translation

Translation

class Translation extends AnnotationBase (View source)

Defines a translatable annotation object.

Some metadata within an annotation needs to be translatable. This class supports that need by allowing both the translatable string and, if specified, a context for that string. The string (with optional context) is passed into t().

Properties

string $id

The annotated class ID.

 from  AnnotationBase
protected string $class

The class used for this annotated class.

 from  AnnotationBase
protected string $provider

The provider of the annotated class.

 from  AnnotationBase
protected TranslatableMarkup $translation

The string translation object.

Methods

string
getProvider()

Gets the name of the provider of the annotated class.

from  AnnotationBase
setProvider(string $provider)

Sets the name of the provider of the annotated class.

from  AnnotationBase
string
getId()

Gets the unique ID for this annotated class.

from  AnnotationBase
string
getClass()

Gets the class of the annotated class.

from  AnnotationBase
setClass(string $class)

Sets the class of the annotated class.

from  AnnotationBase
__construct(array $values)

Constructs a new class instance.

get()

Gets the value of an annotation.

Details

in AnnotationBase at line 34
string getProvider()

Gets the name of the provider of the annotated class.

Return Value

string

in AnnotationBase at line 41
setProvider(string $provider)

Sets the name of the provider of the annotated class.

Parameters

string $provider

in AnnotationBase at line 48
string getId()

Gets the unique ID for this annotated class.

Return Value

string

in AnnotationBase at line 55
string getClass()

Gets the class of the annotated class.

Return Value

string

in AnnotationBase at line 62
setClass(string $class)

Sets the class of the annotated class.

Parameters

string $class

at line 75
__construct(array $values)

Constructs a new class instance.

Parses values passed into this class through the t() function in Drupal and handles an optional context for the string.

Parameters

array $values

Possible array keys:

  • value (required): the string that is to be translated.
  • arguments (optional): an array with placeholder replacements, keyed by placeholder.
  • context (optional): a string that describes the context of "value";

at line 90
get()

Gets the value of an annotation.