class TipPluginBase

Same name and namespace in other branches
  1. 9 core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
  2. 8.9.x core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
  3. 11.x core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase

Defines a base tour item implementation.

Hierarchy

Expanded class hierarchy of TipPluginBase

See also

\Drupal\tour\Annotation\Tip

\Drupal\tour\TipPluginInterface

\Drupal\tour\TipPluginManager

Plugin API

5 files declare their use of TipPluginBase
TipPluginBaseTest.php in core/modules/tour/tests/src/Unit/TipPluginBaseTest.php
TipPluginImage.php in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php
TipPluginImageLegacy.php in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImageLegacy.php
TipPluginText.php in core/modules/tour/src/Plugin/tour/tip/TipPluginText.php
TipPluginTextLegacy.php in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginTextLegacy.php

File

core/modules/tour/src/TipPluginBase.php, line 15

Namespace

Drupal\tour
View 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;
  
  /**
   * {@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 get($key) {
    if (!empty($this->configuration[$key])) {
      return $this->configuration[$key];
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function set($key, $value) {
    $this->configuration[$key] = $value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLocation() : ?string {
    $location = $this->get('position');
    // The location values accepted by PopperJS, the library used for
    // positioning the tip.
    assert(in_array(trim($location ?? ''), [
      'auto',
      'auto-start',
      'auto-end',
      'top',
      'top-start',
      'top-end',
      'bottom',
      'bottom-start',
      'bottom-end',
      'right',
      'right-start',
      'right-end',
      'left',
      'left-start',
      'left-end',
      '',
    ], TRUE), "{$location} is not a valid Tour Tip position value");
    return $location;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSelector() : ?string {
    return $this->get('selector');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getBody() : array {
    return [];
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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::getBody public function Returns the body content of the tooltip. Overrides TipPluginInterface::getBody 3
TipPluginBase::getLabel public function Returns label of the tip. Overrides TipPluginInterface::getLabel
TipPluginBase::getLocation public function Returns the configured placement of the tip relative to the element. Overrides TipPluginInterface::getLocation
TipPluginBase::getSelector public function Returns the selector the tour tip will attach to. Overrides TipPluginInterface::getSelector
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.