class TipPluginBase

Same name in other branches
  1. 9 core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
  2. 10 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

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\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;
    
    /**
     * 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
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.