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

Defines a tour item annotation object.

Plugin Namespace: Plugin\tour\tip

For a working example, see \Drupal\tour\Plugin\tour\tip\TipPluginText

Hierarchy

Expanded class hierarchy of Tip

See also

\Drupal\tour\TipPluginBase

\Drupal\tour\TipPluginInterface

\Drupal\tour\TipPluginManager

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
4 classes are annotated with Tip
TipPluginImage in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php
Displays an image as a tip.
TipPluginImageLegacy in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImageLegacy.php
Displays an image as a tip.
TipPluginText in core/modules/tour/src/Plugin/tour/tip/TipPluginText.php
Displays some text as a tip.
TipPluginTextLegacy in core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginTextLegacy.php
Displays some text as a tip.

File

core/modules/tour/src/Annotation/Tip.php, line 21

Namespace

Drupal\tour\Annotation
View source 
class Tip extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The title of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

}

Members

Namesort ascending Modifiers Type Description Overrides
Tip::$title public property The title of the plugin.
Tip::$id public property The plugin ID.
Plugin::__construct public function Constructs a Plugin object. 3
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::$definition protected property The plugin definition read from the class annotation. 1