class TipPluginImageLegacy

Same name in other branches
  1. 9 core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImageLegacy.php \Drupal\tour_test\Plugin\tour\tip\TipPluginImageLegacy
  2. 11.x core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImageLegacy.php \Drupal\tour_test\Plugin\tour\tip\TipPluginImageLegacy

Displays an image as a tip.

Plugin annotation


@Tip(
  id = "image_legacy",
  title = @Translation("Image Legacy")
)

Hierarchy

Expanded class hierarchy of TipPluginImageLegacy

File

core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImageLegacy.php, line 19

Namespace

Drupal\tour_test\Plugin\tour\tip
View source 
class TipPluginImageLegacy 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 TipPluginImageLegacy 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 getConfigurationOrNot() {
        $image = [
            '#theme' => 'image',
            '#uri' => $this->get('url'),
            '#alt' => $this->get('alt'),
        ];
        return [
            'title' => Html::escape($this->get('label')),
            'body' => $this->token
                ->replace(\Drupal::service('renderer')->renderInIsolation($image)),
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
TipPluginImageLegacy::$alt protected property The alt text which is used for the image in this Tip.
TipPluginImageLegacy::$token protected property Token service.
TipPluginImageLegacy::$url protected property The URL which is used for the image in this Tip.
TipPluginImageLegacy::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TipPluginImageLegacy::getConfigurationOrNot public function
TipPluginImageLegacy::__construct public function Constructs a TipPluginImageLegacy object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.