Plugin implementation of the 'link_separate' formatter.
@FieldFormatter(
id = "link_separate",
module = "link",
label = @Translation("Separate link text and URL"),
field_types = {
"link"
},
settings = {
"trim_length" = "80",
"rel" = "",
"target" = ""
}
)
Expanded class hierarchy of LinkSeparateFormatter
class LinkSeparateFormatter extends LinkFormatter {
/**
* {@inheritdoc}
*/
public function viewElements(EntityInterface $entity, $langcode, array $items) {
$element = array();
$settings = $this
->getSettings();
foreach ($items as $delta => $item) {
// By default use the full URL as the link text.
$link_title = $item['url'];
// If the link text field value is available, use it for the text.
if (empty($settings['url_only']) && !empty($item['title'])) {
// Unsanitized token replacement here because $options['html'] is FALSE
// by default in theme_link().
$link_title = \Drupal::token()
->replace($item['title'], array(
$entity
->entityType() => $entity,
), array(
'sanitize' => FALSE,
'clear' => TRUE,
));
}
// The link_separate formatter has two titles; the link text (as in the
// field values) and the URL itself. If there is no link text value,
// $link_title defaults to the URL, so it needs to be unset.
// The URL version may need to be trimmed as well.
if (empty($item['title'])) {
$link_title = NULL;
}
$url_title = $item['url'];
if (!empty($settings['trim_length'])) {
$link_title = truncate_utf8($link_title, $settings['trim_length'], FALSE, TRUE);
$url_title = truncate_utf8($item['url'], $settings['trim_length'], FALSE, TRUE);
}
$element[$delta] = array(
'#theme' => 'link_formatter_link_separate',
'#title' => $link_title,
'#url_title' => $url_title,
'#href' => $item['path'],
'#options' => $item['options'],
);
}
return $element;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The field instance definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
public | function |
Builds a renderable array for one field on one entity instance. Overrides FormatterInterface:: |
|
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
|
LinkFormatter:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterBase:: |
|
LinkFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
LinkFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
LinkSeparateFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides LinkFormatter:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
public | function |
Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface:: |