class Tip in Zircon Profile 8

Defines a tour item annotation object.

Plugin Namespace: Plugin\tour\tip

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

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\tour\Annotation\Tip

See also

\Drupal\tour\TipPluginBase

\Drupal\tour\TipPluginInterface

\Drupal\tour\TipPluginManager

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

2 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.

TipPluginText in core/modules/tour/src/Plugin/tour/tip/TipPluginText.php

Displays some text as a tip.

File

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

Contains \Drupal\tour\Annotation\Tip.

Namespace

Drupal\tour\Annotation

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

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