class TipPluginText

Same name and namespace in other branches
  1. 10 core/modules/tour/src/Plugin/tour/tip/TipPluginText.php \Drupal\tour\Plugin\tour\tip\TipPluginText
  2. 8.9.x core/modules/tour/src/Plugin/tour/tip/TipPluginText.php \Drupal\tour\Plugin\tour\tip\TipPluginText

Displays some text as a tip.

Plugin annotation


@Tip(
  id = "text",
  title = @Translation("Text")
)

Hierarchy

Expanded class hierarchy of TipPluginText

File

core/modules/tour/src/Plugin/tour/tip/TipPluginText.php, line 19

Namespace

Drupal\tour\Plugin\tour\tip
View source
class TipPluginText extends TipPluginBase implements ContainerFactoryPluginInterface, TourTipPluginInterface {
  
  /**
   * The body text which is used for render of this Text Tip.
   *
   * @var string
   */
  protected $body;
  
  /**
   * 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 {
    return [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this->token
        ->replace($this->get('body')),
      '#attributes' => [
        'class' => [
          'tour-tip-body',
        ],
      ],
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getOutput() {
    // Call parent to trigger error when calling this function.
    parent::getOutput();
    $output = '<p class="tour-tip-body">' . $this->token
      ->replace($this->get('body')) . '</p>';
    return [
      '#markup' => $output,
    ];
  }

}

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