You are here

public function AudioPlayerHTML5::settingsForm in Media entity audio 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/AudioPlayerHTML5.php \Drupal\media_entity_audio\Plugin\Field\FieldFormatter\AudioPlayerHTML5::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

src/Plugin/Field/FieldFormatter/AudioPlayerHTML5.php, line 34

Class

AudioPlayerHTML5
Plugin implementation of the 'Audio Player (HTML5)' formatter.

Namespace

Drupal\media_entity_audio\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['provide_download_link'] = [
    '#title' => $this
      ->t('Provide Download Link'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getSetting('provide_download_link'),
  ];
  $form['audio_attributes'] = [
    '#title' => $this
      ->t('Audio Tag Attributes'),
    '#type' => 'textfield',
    '#description' => $this
      ->t('Give a space-separeted list of values like: <em>\'controls preload="auto" loop\'</em>. Note that if you remove the <em>\'controls\'</em> tag, your player will not show up.'),
    '#default_value' => $this
      ->getSetting('audio_attributes'),
  ];
  return $form;
}