abstract class SharePluginBase in Share Message 8

Default controller class for source plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\sharemessage\SharePluginBase implements SharePluginInterface uses StringTranslationTrait

4 files declare their use of SharePluginBase

Addthis.php in src/Plugin/sharemessage/Addthis.php

OGHeaders.php in src/Plugin/sharemessage/OGHeaders.php

Sharrre.php in src/Plugin/sharemessage/Sharrre.php

SocialSharePrivacy.php in src/Plugin/sharemessage/SocialSharePrivacy.php

File

src/SharePluginBase.php, line 14

Namespace

Drupal\sharemessage

abstract class SharePluginBase extends PluginBase implements SharePluginInterface {
  use StringTranslationTrait;

  /**
   * Share Message.
   *
   * @var \Drupal\sharemessage\ShareMessageInterface $shareMessage
   */
  protected $shareMessage;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->shareMessage = $configuration['sharemessage'];
  }

  /**
   * Provides the action link plugin's default configuration.
   *
   * Derived classes will want to override this method.
   *
   * @return array
   *   The plugin configuration array.
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * Provides the action link plugin's current configuration array.
   *
   * @return array
   *   An array containing the plugin's current configuration.
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * Updates the plugin's current configuration.
   *
   * @param array $configuration
   *   An array containing the plugin's configuration.
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Nothing to do here by default.
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Nothing to do here by default.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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	3
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.
SharePluginBase::$shareMessage	protected	property	Share Message.
SharePluginBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	3
SharePluginBase::calculateDependencies	public	function
SharePluginBase::defaultConfiguration	public	function	Provides the action link plugin's default configuration. Overrides ConfigurableInterface::defaultConfiguration
SharePluginBase::getConfiguration	public	function	Provides the action link plugin's current configuration array. Overrides ConfigurableInterface::getConfiguration
SharePluginBase::setConfiguration	public	function	Updates the plugin's current configuration. Overrides ConfigurableInterface::setConfiguration
SharePluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
SharePluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
SharePluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
SharePluginInterface::build	public	function	Creates the AddThis toolbar.	4
SharePluginInterface::getSetting	public	function	Gets the setting for $key with overrides if applicable.	4
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.