class TipPluginBase
Same name and namespace in other branches
- 9 core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
- 8.9.x core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
- 11.x core/modules/tour/src/TipPluginBase.php \Drupal\tour\TipPluginBase
Defines a base tour item implementation.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \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 implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\tour\TipPluginBase extends \Drupal\tour\TipPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TipPluginBase
See also
\Drupal\tour\TipPluginInterface
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\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;
/**
* {@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 |
---|---|---|---|---|---|
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 | #[\ReturnTypeWillChange] | 2 | |
MessengerTrait::$messenger | protected | property | The messenger. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | ||
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 | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | ||
PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 6 | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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::$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.