class TipPluginImage
Displays an image as a tip.
Plugin annotation
@Tip(
id = "image",
title = @Translation("Image")
)
Hierarchy
- class \Drupal\tour_test\Plugin\tour\tip\TipPluginImage implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\tour\TipPluginBase
Expanded class hierarchy of TipPluginImage
File
-
core/
modules/ tour/ tests/ tour_test/ src/ Plugin/ tour/ tip/ TipPluginImage.php, line 18
Namespace
Drupal\tour_test\Plugin\tour\tipView source
class TipPluginImage extends TipPluginBase implements ContainerFactoryPluginInterface {
/**
* 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
* An alt text used for the image.
*/
protected $alt;
/**
* 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 {
$image = [
'#theme' => 'image',
'#uri' => $this->get('url'),
'#alt' => $this->get('alt'),
];
return [
'#type' => 'html_tag',
'#tag' => 'p',
'#attributes' => [
'class' => [
'tour-tip-image',
],
],
'image' => $image,
];
}
}
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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| 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 | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| 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 | Overrides TipPluginInterface::get | ||
| TipPluginBase::getLabel | public | function | Overrides TipPluginInterface::getLabel | ||
| TipPluginBase::getLocation | public | function | Overrides TipPluginInterface::getLocation | ||
| TipPluginBase::getSelector | public | function | Overrides TipPluginInterface::getSelector | ||
| TipPluginBase::getWeight | public | function | Overrides TipPluginInterface::getWeight | ||
| TipPluginBase::id | public | function | Overrides TipPluginInterface::id | ||
| TipPluginBase::set | public | function | Overrides TipPluginInterface::set | ||
| TipPluginImage::$alt | protected | property | The alt text which is used for the image in this Tip. | ||
| TipPluginImage::$token | protected | property | Token service. | ||
| TipPluginImage::$url | protected | property | The URL which is used for the image in this Tip. | ||
| TipPluginImage::create | public static | function | Overrides ContainerFactoryPluginInterface::create | ||
| TipPluginImage::getBody | public | function | Overrides TipPluginBase::getBody | ||
| TipPluginImage::__construct | public | function | Constructs a \Drupal\tour\Plugin\tour\tip\TipPluginText object. | Overrides PluginBase::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.