TipPluginImageLegacy.php

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

Namespace

Drupal\tour_test\Plugin\tour\tip

File

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

View source
<?php

namespace Drupal\tour_test\Plugin\tour\tip;

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

/**
 * Displays an image as a tip.
 *
 * @Tip(
 *   id = "image_legacy",
 *   title = @Translation("Image Legacy")
 * )
 */
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')->renderPlain($image)),
        ];
    }
    
    /**
     * {@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>',
        ];
    }

}

Classes

Title Deprecated Summary
TipPluginImageLegacy Displays an image as a tip.

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