class TipPluginImage
Same name in other branches
- 9 core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php \Drupal\tour_test\Plugin\tour\tip\TipPluginImage
- 10 core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php \Drupal\tour_test\Plugin\tour\tip\TipPluginImage
- 11.x core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php \Drupal\tour_test\Plugin\tour\tip\TipPluginImage
Displays an image as a tip.
Plugin annotation
@Tip(
id = "image",
title = @Translation("Image")
)
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_test\Plugin\tour\tip\TipPluginImage extends \Drupal\tour\TipPluginBase
- 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 TipPluginImage
File
-
core/
modules/ tour/ tests/ tour_test/ src/ Plugin/ tour/ tip/ TipPluginImage.php, line 16
Namespace
Drupal\tour_test\Plugin\tour\tipView source
class TipPluginImage extends TipPluginBase {
/**
* The url which is used for the image in this Tip.
*
* @var string
* A url used for the image.
*/
protected $url;
/**
* The alt text which is used for the image in this Tip.
*
* @var string
* A alt text used for the image.
*/
protected $alt;
/**
* {@inheritdoc}
*/
public function getOutput() {
$prefix = '<h2 class="tour-tip-label" id="tour-tip-' . $this->get('ariaId') . '-label">' . Html::escape($this->get('label')) . '</h2>';
$prefix .= '<p class="tour-tip-image" id="tour-tip-' . $this->get('ariaId') . '-contents">';
return [
'#prefix' => $prefix,
'#theme' => 'image',
'#uri' => $this->get('url'),
'#alt' => $this->get('alt'),
'#suffix' => '</p>',
];
}
}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 | |
| TipPluginImage::$alt | protected | property | The alt text which is used for the image in this Tip. | ||
| TipPluginImage::$url | protected | property | The url which is used for the image in this Tip. | ||
| TipPluginImage::getOutput | public | function | Returns a renderable array. | Overrides TipPluginInterface::getOutput |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.