interface TourTipPluginInterface

Same name and namespace in other branches
  1. 9 core/modules/tour/src/TourTipPluginInterface.php \Drupal\tour\TourTipPluginInterface
  2. 11.x core/modules/tour/src/TourTipPluginInterface.php \Drupal\tour\TourTipPluginInterface

Defines an interface for tour items.

Hierarchy

Expanded class hierarchy of TourTipPluginInterface

All classes that implement TourTipPluginInterface

Deprecated

in drupal:10.1.0 and is removed from drupal:11.0.0. Implements TipPluginInterface instead.

See also

\Drupal\tour\Annotation\Tip

\Drupal\tour\TipPluginBase

\Drupal\tour\TipPluginManager

Plugin API

https://www.drupal.org/node/3340701

1 file declares its use of TourTipPluginInterface
TourTipLegacyTest.php in core/modules/tour/tests/src/Kernel/TourTipLegacyTest.php

File

core/modules/tour/src/TourTipPluginInterface.php, line 20

Namespace

Drupal\tour
View source
interface TourTipPluginInterface extends TipPluginInterface {

}

Members

Title Sort descending Modifiers Object type Summary Overrides
TipPluginInterface::get public function Used for returning values by key. 1
TipPluginInterface::getBody public function Returns the body content of the tooltip. 1
TipPluginInterface::getLabel public function Returns label of the tip. 1
TipPluginInterface::getLocation public function Returns the configured placement of the tip relative to the element. 1
TipPluginInterface::getSelector public function Returns the selector the tour tip will attach to. 1
TipPluginInterface::getWeight public function Returns weight of the tip. 1
TipPluginInterface::id public function Returns id of the tip. 1
TipPluginInterface::set public function Used for returning values by key. 1

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