Documentation & API reference
class TelephoneLinkFormatter
Plugin implementation of the 'telephone_link' formatter.
Plugin annotation
@FieldFormatter(
id = "telephone_link",
module = "telephone",
label = @Translation("Telephone link"),
field_types = {
"telephone"
},
settings = {
"title" = ""
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
- class \Drupal\field\Plugin\Type\Formatter\FormatterBase implements FormatterInterface
- class \Drupal\telephone\Plugin\field\formatter\TelephoneLinkFormatter
- class \Drupal\field\Plugin\Type\Formatter\FormatterBase implements FormatterInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
Expanded class hierarchy of TelephoneLinkFormatter
File
- drupal/
core/ modules/ telephone/ lib/ Drupal/ telephone/ Plugin/ field/ formatter/ TelephoneLinkFormatter.php, line 30 - Contains \Drupal\telephone\Plugin\field\formatter\TelephoneLinkFormatter.
Namespace
Drupal\telephone\Plugin\field\formatterView source
class TelephoneLinkFormatter extends FormatterBase {
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, array &$form_state) {
$elements['title'] = array(
'#type' => 'textfield',
'#title' => t('Title to replace basic numeric telephone number display.'),
'#default_value' => $this
->getSetting('title'),
);
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = array();
$settings = $this
->getSettings();
if (!empty($settings['title'])) {
$summary[] = t('Link using text: @title', array(
'@title' => $settings['title'],
));
}
else {
$summary[] = t('Link using provided telephone number.');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function prepareView(array $entities, $langcode, array &$items) {
$settings = $this
->getSettings();
foreach ($entities as $id => $entity) {
foreach ($items[$id] as &$item) {
// If available, set custom link text.
if (!empty($settings['title'])) {
$item['title'] = $settings['title'];
}
else {
$item['title'] = $item['value'];
}
}
}
}
/**
* {@inheritdoc}
*/
public function viewElements(EntityInterface $entity, $langcode, array $items) {
$element = array();
foreach ($items as $delta => $item) {
// Prepend 'tel:' to the telephone number.
$href = 'tel:' . rawurlencode(preg_replace('/\\s+/', '', $item['value']));
// Render each element as link.
$element[$delta] = array(
'#type' => 'link',
'#title' => $item['title'],
'#href' => $href,
'#options' => array(
'external' => TRUE,
),
);
}
return $element;
}
}