class TipPluginTextLegacy in Drupal 9

Displays some text as a tip.

Plugin annotation


@Tip(
  id = "text_legacy",
  title = @Translation("Text Legacy")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\tour\TipPluginBase implements TipPluginInterface
    class \Drupal\tour_test\Plugin\tour\tip\TipPluginTextLegacy implements ContainerFactoryPluginInterface

Expanded class hierarchy of TipPluginTextLegacy

File

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

Namespace

Drupal\tour_test\Plugin\tour\tip

View source

class TipPluginTextLegacy extends TipPluginBase implements ContainerFactoryPluginInterface {

  /**
   * 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;

  /**
   * The forced position of where the tip will be located.
   *
   * @var string
   */
  protected $location;

  /**
   * Unique aria-id.
   *
   * @var string
   */
  protected $ariaId;

  /**
   * Constructs a TipPluginTextLegacy 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'));
  }

  /**
   * Returns an ID that is guaranteed uniqueness.
   *
   * @return string
   *   A unique id to be used to generate aria attributes.
   */
  public function getAriaId() {
    if (!$this->ariaId) {
      $this->ariaId = Html::getUniqueId($this
        ->get('id'));
    }
    return $this->ariaId;
  }

  /**
   * Returns body of the text tip.
   *
   * @return string
   *   The tip body.
   */
  public function getBody() {
    return $this
      ->get('body');
  }

  /**
   * {@inheritdoc}
   */
  public function getAttributes() {
    $attributes = parent::getAttributes();
    $attributes['data-aria-describedby'] = 'tour-tip-' . $this
      ->getAriaId() . '-contents';
    $attributes['data-aria-labelledby'] = 'tour-tip-' . $this
      ->getAriaId() . '-label';
    if ($location = $this
      ->get('location')) {
      $attributes['data-options'] = 'tipLocation:' . $location;
    }
    return $attributes;
  }

  /**
   * {@inheritdoc}
   */
  public function getOutput() {
    $output = '<h2 class="tour-tip-label" id="tour-tip-' . $this
      ->getAriaId() . '-label">' . Html::escape($this
      ->getLabel()) . '</h2>';
    $output .= '<p class="tour-tip-body" id="tour-tip-' . $this
      ->getAriaId() . '-contents">' . $this->token
      ->replace($this
      ->getBody()) . '</p>';
    return [
      '#markup' => $output,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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::$attributes Deprecated	protected	property	The attributes that will be applied to the markup of this tip.
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::getLabel	public	function	Returns label of the tip. Overrides TipPluginInterface::getLabel
TipPluginBase::getLocation	public	function	Determines the placement of the tip relative to the element.
TipPluginBase::getSelector	public	function	The selector the tour tip will attach to.
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
TipPluginTextLegacy::$ariaId	protected	property	Unique aria-id.
TipPluginTextLegacy::$body	protected	property	The body text which is used for render of this Text Tip.
TipPluginTextLegacy::$location	protected	property	The forced position of where the tip will be located.
TipPluginTextLegacy::$token	protected	property	Token service.
TipPluginTextLegacy::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TipPluginTextLegacy::getAriaId	public	function	Returns an ID that is guaranteed uniqueness.
TipPluginTextLegacy::getAttributes	public	function	@todo remove in https://drupal.org/node/3195193 Overrides TipPluginBase::getAttributes
TipPluginTextLegacy::getBody	public	function	Returns body of the text tip.
TipPluginTextLegacy::getOutput	public	function	This method should not be used. It is deprecated from TipPluginInterface. Overrides TipPluginBase::getOutput
TipPluginTextLegacy::__construct	public	function	Constructs a TipPluginTextLegacy object. Overrides TipPluginBase::__construct

You are here

class TipPluginTextLegacy in Drupal 9

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation