class SourcePlugin

Defines a Source plugin annotation object.

Hierarchy

  • class \Drupal\tmgmt\Annotation\SourcePlugin extends \Drupal\Component\Annotation\Plugin

Expanded class hierarchy of SourcePlugin

See also

\Drupal\tmgmt\SourceManager

5 classes are annotated with SourcePlugin
ConfigSource in sources/tmgmt_config/src/Plugin/tmgmt/Source/ConfigSource.php
Content entity source plugin controller.
ContentEntitySource in sources/content/src/Plugin/tmgmt/Source/ContentEntitySource.php
Content entity source plugin controller.
LocaleSource in sources/locale/src/Plugin/tmgmt/Source/LocaleSource.php
Translation Source plugin for locale strings.
TestHtmlSource in tmgmt_test/src/Plugin/tmgmt/Source/TestHtmlSource.php
Test source plugin implementation.
TestSource in tmgmt_test/src/Plugin/tmgmt/Source/TestSource.php
Test source plugin implementation.

File

src/Annotation/SourcePlugin.php, line 14

Namespace

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

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

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

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

  /**
   * The name of the source plugin 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 source.
   *
   * @var array
   */
  public $default_settings = array();

}

Members

Namesort descending Modifiers Type Description Overrides
SourcePlugin::$class public property The name of the source plugin class.
SourcePlugin::$default_settings public property An array with default values for this source.
SourcePlugin::$description public property A short description of the source.
SourcePlugin::$id public property The plugin ID.
SourcePlugin::$label public property The human-readable name of the source.