Drupal 8  8.0.2
TipPluginText Class Reference
Inheritance diagram for TipPluginText:

Public Member Functions

 __construct (array $configuration, $plugin_id, $plugin_definition, Token $token)
 
 getAriaId ()
 
 getBody ()
 
 getLocation ()
 
 getAttributes ()
 
 getOutput ()
 
- Public Member Functions inherited from TipPluginBase
 id ()
 
 getLabel ()
 
 getWeight ()
 
 getAttributes ()
 
 get ($key)
 
 set ($key, $value)
 

Static Public Member Functions

static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
 

Protected Attributes

 $body
 
 $token
 
 $location
 
- Protected Attributes inherited from TipPluginBase
 $label
 
 $weight
 
 $attributes
 

Detailed Description

Displays some text as a tip.

( id = "text", title = ("Text") )

Constructor & Destructor Documentation

__construct ( array  $configuration,
  $plugin_id,
  $plugin_definition,
Token  $token 
)

Constructs a object.

Parameters
array$configurationA configuration array containing information about the plugin instance.
string$plugin_idThe plugin_id for the plugin instance.
mixed$plugin_definitionThe plugin implementation definition.
\Drupal\Core\Utility\Token$tokenThe token service.

References Drupal\token().

Here is the call graph for this function:

Member Function Documentation

static create ( ContainerInterface  $container,
array  $configuration,
  $plugin_id,
  $plugin_definition 
)
static

{Creates an instance of the plugin.

Parameters
\Symfony\Component\DependencyInjection\ContainerInterface$containerThe container to pull out services used in the plugin.
array$configurationA configuration array containing information about the plugin instance.
string$plugin_idThe plugin ID for the plugin instance.
mixed$plugin_definitionThe plugin implementation definition.
Returns
static Returns an instance of this plugin.
}

Implements ContainerFactoryPluginInterface.

getAriaId ( )

Returns a ID that is guaranteed uniqueness.

Returns
string A unique id to be used to generate aria attributes.

References Html\getUniqueId().

Referenced by TipPluginText\getAttributes(), and TipPluginText\getOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

getAttributes ( )

{Returns an array of attributes for the tip wrapper.

Returns
array An array of classes and values.
}

Implements TipPluginInterface.

References TipPluginText\getAriaId().

Here is the call graph for this function:

getBody ( )

Returns body of the text tip.

Returns
string The tip body.

Referenced by TipPluginText\getOutput().

Here is the caller graph for this function:

getLocation ( )

Returns location of the text tip.

Returns
string The tip location.
getOutput ( )

{Returns a renderable array.

Returns
array A renderable array.
}

Implements TipPluginInterface.

References Html\escape(), TipPluginText\getAriaId(), TipPluginText\getBody(), TipPluginBase\getLabel(), and Drupal\token().

Here is the call graph for this function:


The documentation for this class was generated from the following file: