You are here

Home » API reference » Telephone Formatter 8 » TelephoneFormatter.php

class TelephoneFormatter in Telephone Formatter 8

Plugin implementation of the 'telephone_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "telephone_formatter",
  label = @Translation("Formatted telephone"),
  field_types = {
    "telephone"
  }
)

Hierarchy

Expanded class hierarchy of TelephoneFormatter

File

src/Plugin/Field/FieldFormatter/TelephoneFormatter.php, line 28

Namespace

Drupal\telephone_formatter\Plugin\Field\FieldFormatter
View source 
class TelephoneFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Formatter service.
   *
   * @var \Drupal\telephone_formatter\FormatterInterface
   */
  protected $formatter;

  /**
   * CountryManager service.
   *
   * @var \Drupal\Core\Locale\CountryManagerInterface
   */
  protected $countryManager;

  /**
   * Constructs a FormatterBase object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\telephone_formatter\FormatterInterface $formatter
   *   Formatter service.
   * @param \Drupal\Core\Locale\CountryManagerInterface $countryManager
   *   CountryManager service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, FormatterInterface $formatter, CountryManagerInterface $countryManager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->formatter = $formatter;
    $this->countryManager = $countryManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('telephone_formatter.formatter'), $container
      ->get('country_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'format' => PhoneNumberFormat::INTERNATIONAL,
      'link' => TRUE,
      'default_country' => NULL,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements['format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#description' => $this
        ->t('List of available formats'),
      '#default_value' => $this
        ->getSetting('format'),
      '#options' => self::availableFormats(),
    ];
    $elements['link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Link'),
      '#description' => $this
        ->t('Format as link'),
      '#default_value' => $this
        ->getSetting('link'),
    ];
    $elements['default_country'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default country'),
      '#description' => $this
        ->t('If field allows internal telephone numbers you can choose which country this number belongs to by default. It is highly advised to enable telephone validation for this field to ensure that telephone number is valid and can be parsed and reformatted.'),
      '#default_value' => $this
        ->getSetting('default_country'),
      '#options' => [
        NULL => $this
          ->t('- Do not use default country -'),
      ] + $this->countryManager
        ->getList(),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $formats = self::availableFormats();
    $summary[] = $this
      ->t('Format: @format', [
      '@format' => $formats[$this
        ->getSetting('format')],
    ]);
    $summary[] = $this
      ->t('Link: @link', [
      '@link' => $this
        ->getSetting('link') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($default_country = $this
      ->getSetting('default_country')) {
      $summary[] = $this
        ->t('Default country: @default_country', [
        '@default_country' => $default_country,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($items as $delta => $item) {
      try {
        if ($this
          ->getSetting('link')) {
          $element[$delta] = $this
            ->viewLinkValue($item);
        }
        else {
          $element[$delta] = $this
            ->viewFormattedValue($item);
        }
      } catch (\Exception $e) {
        $element[$delta] = $this
          ->viewPlainValue($item);
      }
    }
    return $element;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field value.
   *
   * @return array
   *   The textual output generated as a render array.
   */
  protected function viewPlainValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output.
    return [
      '#type' => 'inline_template',
      '#template' => '{{ value }}',
      '#context' => [
        'value' => $item->value,
      ],
    ];
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field value.
   *
   * @return array
   *   The textual output generated as a render array.
   */
  protected function viewFormattedValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output.
    return [
      '#type' => 'inline_template',
      '#template' => '{{ value }}',
      '#context' => [
        'value' => $this
          ->getFormattedValue($item),
      ],
    ];
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field value.
   *
   * @return array
   *   The textual output generated as a render array.
   */
  protected function viewLinkValue(FieldItemInterface $item) {

    // Render each element as link.
    $element = [
      '#type' => 'link',
      '#title' => $this
        ->getFormattedValue($item),
      // Url prepended with 'tel:' schema.
      '#url' => Url::fromUri($this->formatter
        ->format($item->value, PhoneNumberFormat::RFC3966, $this
        ->getSetting('default_country'))),
      '#options' => [
        'external' => TRUE,
      ],
    ];
    if (!empty($item->_attributes)) {
      $element['#options'] += [
        'attributes' => [],
      ];
      $element['#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;
  }

  /**
   * Generate formatted output for one field item.
   *
   * Helper function which helps you get field value formatted based on field
   * formatter settings.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   Field item.
   *
   * @return string
   *   Returns preformatted telephone number.
   */
  protected function getFormattedValue(FieldItemInterface $item) {
    return $this->formatter
      ->format($item->value, $this
      ->getSetting('format'), $this
      ->getSetting('default_country'));
  }

  /**
   * List of available formats.
   */
  public static function availableFormats() {
    return [
      PhoneNumberFormat::INTERNATIONAL => t('International'),
      PhoneNumberFormat::E164 => t('E164'),
      PhoneNumberFormat::NATIONAL => t('National'),
      PhoneNumberFormat::RFC3966 => t('RFC3966'),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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::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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TelephoneFormatter::$countryManager protected property CountryManager service.
TelephoneFormatter::$formatter protected property Formatter service.
TelephoneFormatter::availableFormats public static function List of available formats.
TelephoneFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
TelephoneFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TelephoneFormatter::getFormattedValue protected function Generate formatted output for one field item.
TelephoneFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TelephoneFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TelephoneFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
TelephoneFormatter::viewFormattedValue protected function Generate the output appropriate for one field item.
TelephoneFormatter::viewLinkValue protected function Generate the output appropriate for one field item.
TelephoneFormatter::viewPlainValue protected function Generate the output appropriate for one field item.
TelephoneFormatter::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct