class TipPluginText
Same name in other branches
- 8.9.x core/modules/tour/src/Plugin/tour/tip/TipPluginText.php \Drupal\tour\Plugin\tour\tip\TipPluginText
- 10 core/modules/tour/src/Plugin/tour/tip/TipPluginText.php \Drupal\tour\Plugin\tour\tip\TipPluginText
- 11.x core/modules/tour/src/Plugin/tour/tip/TipPluginText.php \Drupal\tour\Plugin\tour\tip\TipPluginText
Displays some text as a tip.
Plugin annotation
@Tip(
id = "text",
title = @Translation("Text")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\tour\TipPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\tour\TipPluginInterface
- class \Drupal\tour\Plugin\tour\tip\TipPluginText extends \Drupal\tour\TipPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\tour\TourTipPluginInterface
- class \Drupal\tour\TipPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\tour\TipPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of TipPluginText
File
-
core/
modules/ tour/ src/ Plugin/ tour/ tip/ TipPluginText.php, line 19
Namespace
Drupal\tour\Plugin\tour\tipView source
class TipPluginText extends TipPluginBase implements ContainerFactoryPluginInterface, TourTipPluginInterface {
/**
* The body text which is used for render of this Text Tip.
*
* @var string
*/
protected $body;
/**
* Token service.
*
* @var \Drupal\Core\Utility\Token
*/
protected $token;
/**
* Constructs a \Drupal\tour\Plugin\tour\tip\TipPluginText object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Utility\Token $token
* The token service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, Token $token) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->token = $token;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('token'));
}
/**
* {@inheritdoc}
*/
public function getBody() : array {
return [
'#type' => 'html_tag',
'#tag' => 'p',
'#value' => $this->token
->replace($this->get('body')),
'#attributes' => [
'class' => [
'tour-tip-body',
],
],
];
}
/**
* {@inheritdoc}
*/
public function getOutput() {
// Call parent to trigger error when calling this function.
parent::getOutput();
$output = '<p class="tour-tip-body">' . $this->token
->replace($this->get('body')) . '</p>';
return [
'#markup' => $output,
];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
TipPluginBase::$attributes | Deprecated | 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 | @todo remove in https://drupal.org/node/3195193 | Overrides TipPluginInterface::getAttributes | 1 | |
TipPluginBase::getLabel | public | function | Returns label of the tip. | Overrides TipPluginInterface::getLabel | ||
TipPluginBase::getLocation | public | function | Determines the placement of the tip relative to the element. | |||
TipPluginBase::getSelector | public | function | The selector the tour tip will attach to. | |||
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 | ||
TipPluginText::$body | protected | property | The body text which is used for render of this Text Tip. | |||
TipPluginText::$token | protected | property | Token service. | |||
TipPluginText::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | ||
TipPluginText::getBody | public | function | Returns the body content of the tooltip. | Overrides TourTipPluginInterface::getBody | ||
TipPluginText::getOutput | public | function | This method should not be used. It is deprecated from TipPluginInterface. | Overrides TipPluginBase::getOutput | ||
TipPluginText::__construct | public | function | Constructs a \Drupal\tour\Plugin\tour\tip\TipPluginText object. | Overrides TipPluginBase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.