TipPluginImage.php

Same filename in other branches
  1. 8.9.x core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php
  2. 10 core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php
  3. 11.x core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php

Namespace

Drupal\tour_test\Plugin\tour\tip

File

core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php

View source
<?php

namespace Drupal\tour_test\Plugin\tour\tip;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Utility\Token;
use Drupal\tour\TipPluginBase;
use Drupal\tour\TourTipPluginInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Displays an image as a tip.
 *
 * @Tip(
 *   id = "image",
 *   title = @Translation("Image")
 * )
 */
class TipPluginImage extends TipPluginBase implements ContainerFactoryPluginInterface, TourTipPluginInterface {
    
    /**
     * 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,
        ];
    }

}

Classes

Title Deprecated Summary
TipPluginImage Displays an image as a tip.

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