You are here

Home » API reference » Synonyms 8 » SynonymsProvider.php

class SynonymsProvider in Synonyms 8

Annotation for synonyms provider plugin instance.

Hierarchy

Expanded class hierarchy of SynonymsProvider

1 file declares its use of SynonymsProvider
SynonymsProviderPluginManager.php in src/SynonymsProviderPluginManager.php
3 classes are annotated with SynonymsProvider
BaseField in src/Plugin/Synonyms/Provider/BaseField.php
Provide synonyms from base fields.
EntityReferenceField in src/Plugin/Synonyms/Provider/EntityReferenceField.php
Provide synonyms from entity reference field type.
Field in src/Plugin/Synonyms/Provider/Field.php
Provide synonyms from attached simple fields.

File

src/Annotation/SynonymsProvider.php, line 12

Namespace

Drupal\synonyms\Annotation
View source 
class SynonymsProvider extends Plugin {

  /**
   * Machine readable name of this plugin.
   *
   * @var string
   */
  public $id;

  /**
   * Human readable name of this plugin.
   *
   * @var string
   */
  public $label;

  /**
   * Synonyms behavior service ID into which this plugin provides synonyms.
   *
   * Synonyms behaviors are the services with the tag 'synonyms_behavior'.
   *
   * @var string
   */
  public $synonyms_behavior_service;

  /**
   * Entity type which is controlled by ths plugin.
   *
   * Entity type into which this plugin provides synonyms.
   *
   * @var string
   */
  public $controlled_entity_type;

  /**
   * Bundle which is controlled by this plugin.
   *
   * Bundle into which this plugin provides synonyms. If the entity type does
   * not support bundles, just put here the entity type.
   *
   * @var string
   */
  public $controlled_bundle;

}

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
SynonymsProvider::$controlled_bundle public property Bundle which is controlled by this plugin.
SynonymsProvider::$controlled_entity_type public property Entity type which is controlled by ths plugin.
SynonymsProvider::$id public property Machine readable name of this plugin.
SynonymsProvider::$label public property Human readable name of this plugin.
SynonymsProvider::$synonyms_behavior_service public property Synonyms behavior service ID into which this plugin provides synonyms.