class TipPluginTextLegacy

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

Displays some text as a tip.

Plugin annotation


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

Hierarchy

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 array
     *   The tip body.
     */
    public function getBody() : array {
        return [
            $this->get('body'),
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
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 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
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::getBody public function Returns body of the text tip. Overrides TipPluginBase::getBody
TipPluginTextLegacy::__construct public function Constructs a TipPluginTextLegacy object.

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