Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/tour/src/TipPluginInterface.php

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