interface TipPluginInterface

Defines an interface for tour items.

Hierarchy

Expanded class hierarchy of TipPluginInterface

All classes that implement TipPluginInterface

1 file declares its use of TipPluginInterface
TipPluginBase.php in drupal/core/modules/tour/lib/Drupal/tour/TipPluginBase.php
Contains \Drupal\tour\TipPluginBase.

File

drupal/core/modules/tour/lib/Drupal/tour/TipPluginInterface.php, line 13
Contains \Drupal\tour\TipPluginInterface.

Namespace

Drupal\tour
View source
interface TipPluginInterface {

  /**
   * Returns label of the tip.
   *
   * @return string
   *   The label of the tip.
   */
  public function getLabel();

  /**
   * Returns weight of the tip.
   *
   * @return string
   *   The weight of the tip.
   */
  public function getWeight();

  /**
   * Returns an array of attributes for the tip wrapper.
   *
   * @return array
   *   An array of classes and values.
   */
  public function getAttributes();

  /**
   * Used for returning values by key.
   *
   * @var string
   *   Key of the value.
   *
   * @return string
   *   Value of the key.
   */
  public function get($key);

  /**
   * Used for returning values by key.
   *
   * @var string
   *   Key of the value.
   *
   * @var string
   *   Value of the key.
   */
  public function set($key, $value);

  /**
   * Returns a renderable array.
   *
   * @return array
   *   A renderable array.
   */
  public function getOutput();

}

Members

Namesort descending Modifiers Type Description Overrides
TipPluginInterface::get public function Used for returning values by key. 1
TipPluginInterface::getAttributes public function Returns an array of attributes for the tip wrapper. 1
TipPluginInterface::getLabel public function Returns label of the tip. 1
TipPluginInterface::getOutput public function Returns a renderable array. 2
TipPluginInterface::getWeight public function Returns weight of the tip. 1
TipPluginInterface::set public function Used for returning values by key. 1