You are here

public function EntityReferenceExportFormatter::settingsForm in REST Views 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Field/FieldFormatter/EntityReferenceExportFormatter.php \Drupal\rest_views\Plugin\Field\FieldFormatter\EntityReferenceExportFormatter::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 EntityReferenceEntityFormatter::settingsForm

File

src/Plugin/Field/FieldFormatter/EntityReferenceExportFormatter.php, line 125

Class

EntityReferenceExportFormatter
A plugin that creates a serializable form of a rendered entity.

Namespace

Drupal\rest_views\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $elements = parent::settingsForm($form, $form_state);
  $elements['extra'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Export metadata'),
    '#default_value' => $this
      ->getSetting('extra'),
    '#options' => [
      'id' => $this
        ->t('ID'),
      'title' => $this
        ->t('Title'),
      'url' => $this
        ->t('URL'),
      'type' => $this
        ->t('Entity type'),
      'bundle' => $this
        ->t('Entity bundle'),
    ],
  ];
  return $elements;
}