class TipPluginBase
Defines a base tour item implementation.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\tour\TipPluginBase implements \Drupal\tour\TipPluginInterface extends \Drupal\Core\Plugin\PluginBase
 
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TipPluginBase
See also
\Drupal\tour\TipPluginInterface
2 files declare their use of TipPluginBase
- TipPluginImage.php in core/modules/ tour/ tests/ tour_test/ src/ Plugin/ tour/ tip/ TipPluginImage.php 
- TipPluginText.php in core/modules/ tour/ src/ Plugin/ tour/ tip/ TipPluginText.php 
File
- 
              core/modules/ tour/ src/ TipPluginBase.php, line 15 
Namespace
Drupal\tourView source
abstract class TipPluginBase extends PluginBase implements TipPluginInterface {
  
  /**
   * The label which is used for render of this tip.
   *
   * @var string
   */
  protected $label;
  
  /**
   * Allows tips to take more priority that others.
   *
   * @var string
   */
  protected $weight;
  
  /**
   * The attributes that will be applied to the markup of this tip.
   *
   * @var array
   */
  protected $attributes;
  
  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->get('id');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->get('label');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->get('weight');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getAttributes() {
    return $this->get('attributes') ?: [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function get($key) {
    if (!empty($this->configuration[$key])) {
      return $this->configuration[$key];
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function set($key, $value) {
    $this->configuration[$key] = $value;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 1 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 29 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 29 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| 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. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 78 | |
| 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. | ||
| TipPluginBase::$attributes | protected | property | The attributes that will be applied to the markup of this tip. | ||
| TipPluginBase::$label | protected | property | The label which is used for render of this tip. | ||
| TipPluginBase::$weight | protected | property | Allows tips to take more priority that others. | ||
| TipPluginBase::get | public | function | Used for returning values by key. | Overrides TipPluginInterface::get | |
| TipPluginBase::getAttributes | public | function | Returns an array of attributes for the tip wrapper. | Overrides TipPluginInterface::getAttributes | 1 | 
| TipPluginBase::getLabel | public | function | Returns label of the tip. | Overrides TipPluginInterface::getLabel | |
| TipPluginBase::getWeight | public | function | Returns weight of the tip. | Overrides TipPluginInterface::getWeight | |
| TipPluginBase::id | public | function | Returns id of the tip. | Overrides TipPluginInterface::id | |
| TipPluginBase::set | public | function | Used for returning values by key. | Overrides TipPluginInterface::set | |
| TipPluginInterface::getOutput | public | function | Returns a renderable array. | 2 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
