You are here

class TranslatorPlugin in Translation Management Tool 8

Defines a Translator plugin annotation object.

Hierarchy

Expanded class hierarchy of TranslatorPlugin

See also

\Drupal\tmgmt\TranslatorManager

3 classes are annotated with TranslatorPlugin
FileTranslator in translators/tmgmt_file/src/Plugin/tmgmt/Translator/FileTranslator.php
File translator.
LocalTranslator in translators/tmgmt_local/src/Plugin/tmgmt/Translator/LocalTranslator.php
Drupal user provider.
TestTranslator in tmgmt_test/src/Plugin/tmgmt/Translator/TestTranslator.php
Test source plugin implementation.

File

src/Annotation/TranslatorPlugin.php, line 14

Namespace

Drupal\tmgmt\Annotation
View source
class TranslatorPlugin extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the translator.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A short description of the translator.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The name of the field formatter class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

  /**
   * An array with default values for this translator.
   *
   * @var array
   */
  public $default_settings = array();

}

Members

Namesort descending Modifiers Type Description Overrides
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2
TranslatorPlugin::$class public property The name of the field formatter class.
TranslatorPlugin::$default_settings public property An array with default values for this translator.
TranslatorPlugin::$description public property A short description of the translator.
TranslatorPlugin::$id public property The plugin ID.
TranslatorPlugin::$label public property The human-readable name of the translator.