1. interface
  2. Drupal
  3. \
  4. tour
  5. \
  6. TipPluginInterface

TipPluginInterface

interface TipPluginInterface (View source)

Defines an interface for tour items.

Methods

string
id()

Returns id of the tip.

string
getLabel()

Returns label of the tip.

string
getWeight()

Returns weight of the tip.

array
getAttributes()

Returns an array of attributes for the tip wrapper.

string
get($key)

Used for returning values by key.

set($key, $value)

Used for returning values by key.

array
getOutput()

Returns a renderable array.

Details

at line 21
string id()

Returns id of the tip.

Return Value

string

The id of the tip.

at line 29
string getLabel()

Returns label of the tip.

Return Value

string

The label of the tip.

at line 37
string getWeight()

Returns weight of the tip.

Return Value

string

The weight of the tip.

at line 45
array getAttributes()

Returns an array of attributes for the tip wrapper.

Return Value

array

An array of classes and values.

at line 56
string get($key)

Used for returning values by key.

Parameters

$key

Return Value

string

Value of the key.

at line 67
set($key, $value)

Used for returning values by key.

Parameters

$key
$value

at line 75
array getOutput()

Returns a renderable array.

Return Value

array

A renderable array.