abstract class AbstractProvider in Synonyms 2.0.x

Good starting point for a synonyms provider plugin.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\synonyms\Plugin\Synonyms\Provider\AbstractProvider implements ContainerFactoryPluginInterface, ConfigurationInterface, FindInterface, FormatWordingInterface, GetInterface, ProviderInterface uses ConfigurationTrait

File

src/Plugin/Synonyms/Provider/AbstractProvider.php, line 21

Namespace

Drupal\synonyms\Plugin\Synonyms\Provider

abstract class AbstractProvider extends PluginBase implements ProviderInterface, ContainerFactoryPluginInterface, ConfigurationInterface, GetInterface, FindInterface, FormatWordingInterface {
  use ConfigurationTrait, GetTrait, FindTrait, FormatWordingTrait;

  /**
   * The container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ContainerInterface $container) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->container = $container;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractProvider::$container	protected	property	The container.
AbstractProvider::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	3
AbstractProvider::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	3
ConfigurationTrait::buildConfigurationForm	public	function
ConfigurationTrait::defaultConfiguration	public	function
ConfigurationTrait::getConfiguration	public	function
ConfigurationTrait::setConfiguration	public	function
ConfigurationTrait::submitConfigurationForm	public	function
ConfigurationTrait::validateConfigurationForm	public	function
FindInterface::COLUMN_ENTITY_ID_PLACEHOLDER		constant	Constant which denotes placeholder of an entity ID column.
FindInterface::COLUMN_SYNONYM_PLACEHOLDER		constant	Constant which denotes placeholder of a synonym column.
FindInterface::synonymsFind	public	function	Look up entities by their synonyms within a behavior implementation.	3
FindInterface::synonymsFindProcessCondition	public	function	Supportive method to process $condition argument in synonymsFind().
FormatWordingInterface::formatWordingAvailableTokens	public	function	Get available tokens for format wording.
FormatWordingInterface::synonymFormatWording	public	function	Format a synonym into wording as requested by configuration.
GetInterface::getSynonyms	public	function	Fetch synonyms from an entity.	3
GetInterface::getSynonymsMultiple	public	function	Fetch synonyms from multiple entities at once.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.