You are here

public function TelephoneLinkFormatter::settingsForm in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

Overrides FormatterBase::settingsForm

File

core/modules/telephone/src/Plugin/Field/FieldFormatter/TelephoneLinkFormatter.php, line 40
Contains \Drupal\telephone\Plugin\Field\FieldFormatter\TelephoneLinkFormatter.

Class

TelephoneLinkFormatter
Plugin implementation of the 'telephone_link' formatter.

Namespace

Drupal\telephone\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $elements['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title to replace basic numeric telephone number display'),
    '#default_value' => $this
      ->getSetting('title'),
  );
  return $elements;
}