www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/tour/src/TipPluginInterface.php

   1 <?php
   2
   3 namespace Drupal\tour;
   4
   5 /**
   6  * Defines an interface for tour items.
   7  *
   8  * @see \Drupal\tour\Annotation\Tip
   9  * @see \Drupal\tour\TipPluginBase
  10  * @see \Drupal\tour\TipPluginManager
  11  * @see plugin_api
  12  */
  13 interface TipPluginInterface {
  14
  15   /**
  16    * Returns id of the tip.
  17    *
  18    * @return string
  19    *   The id of the tip.
  20    */
  21   public function id();
  22
  23   /**
  24    * Returns label of the tip.
  25    *
  26    * @return string
  27    *   The label of the tip.
  28    */
  29   public function getLabel();
  30
  31   /**
  32    * Returns weight of the tip.
  33    *
  34    * @return string
  35    *   The weight of the tip.
  36    */
  37   public function getWeight();
  38
  39   /**
  40    * Returns an array of attributes for the tip wrapper.
  41    *
  42    * @return array
  43    *   An array of classes and values.
  44    */
  45   public function getAttributes();
  46
  47   /**
  48    * Used for returning values by key.
  49    *
  50    * @var string
  51    *   Key of the value.
  52    *
  53    * @return string
  54    *   Value of the key.
  55    */
  56   public function get($key);
  57
  58   /**
  59    * Used for returning values by key.
  60    *
  61    * @var string
  62    *   Key of the value.
  63    *
  64    * @var string
  65    *   Value of the key.
  66    */
  67   public function set($key, $value);
  68
  69   /**
  70    * Returns a renderable array.
  71    *
  72    * @return array
  73    *   A renderable array.
  74    */
  75   public function getOutput();
  76
  77 }