class TelephoneLinkFormatter

Same name in other branches
  1. 8.9.x core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter
  2. 10 core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter
  3. 11.x core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter

Plugin implementation of the 'telephone_link' formatter.

Plugin annotation


@FieldFormatter(
  id = "telephone_link",
  label = @Translation("Telephone link"),
  field_types = {
    "telephone"
  }
)

Hierarchy

Expanded class hierarchy of TelephoneLinkFormatter

File

core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php, line 21

Namespace

Drupal\telephone\Plugin\Field\FieldFormatter
View source
class TelephoneLinkFormatter extends FormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'title' => '',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $elements['title'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Title to replace basic numeric telephone number display'),
            '#default_value' => $this->getSetting('title'),
        ];
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $settings = $this->getSettings();
        if (!empty($settings['title'])) {
            $summary[] = $this->t('Link using text: @title', [
                '@title' => $settings['title'],
            ]);
        }
        else {
            $summary[] = $this->t('Link using provided telephone number.');
        }
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $element = [];
        $title_setting = $this->getSetting('title');
        foreach ($items as $delta => $item) {
            // If the telephone number is 5 or less digits, parse_url() will think
            // it's a port number rather than a phone number which causes the link
            // formatter to throw an InvalidArgumentException. Avoid this by inserting
            // a dash (-) after the first digit - RFC 3966 defines the dash as a
            // visual separator character and so will be removed before the phone
            // number is used. See https://bugs.php.net/bug.php?id=70588 for more.
            // While the bug states this only applies to numbers <= 65535, a 5 digit
            // number greater than 65535 will cause parse_url() to return FALSE so
            // we need the work around on any 5 digit (or less) number.
            // First we strip whitespace so we're counting actual digits.
            $phone_number = preg_replace('/\\s+/', '', $item->value);
            if (strlen($phone_number) <= 5) {
                $phone_number = substr_replace($phone_number, '-', 1, 0);
            }
            // Render each element as link.
            $element[$delta] = [
                '#type' => 'link',
                // Use custom title if available, otherwise use the telephone number
                // itself as title.
'#title' => $title_setting ?: $item->value,
                // Prepend 'tel:' to the telephone number.
'#url' => Url::fromUri('tel:' . rawurlencode($phone_number)),
                '#options' => [
                    'external' => TRUE,
                ],
            ];
            if (!empty($item->_attributes)) {
                $element[$delta]['#options'] += [
                    'attributes' => [],
                ];
                $element[$delta]['#options']['attributes'] += $item->_attributes;
                // Unset field item attributes since they have been included in the
                // formatter output and should not be rendered in the field template.
                unset($item->_attributes);
            }
        }
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 13
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. 13
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
TelephoneLinkFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TelephoneLinkFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TelephoneLinkFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TelephoneLinkFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.