public function VotingApiFormatter::settingsForm in Votingapi Widgets 8

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/VotingApiFormatter.php, line 103

Class

VotingApiFormatter

Plugin implementation of the 'voting_api_formatter' formatter.

Namespace

Drupal\votingapi_widgets\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $plugins = $this->votingapiResult
    ->getDefinitions();
  $options = [];
  $styles = [];
  $votePlugin = $this->votingapiWidgetProcessor
    ->createInstance($this
    ->getFieldSetting('vote_plugin'));
  $styles = $votePlugin
    ->getStyles();
  foreach ($plugins as $plugin_id => $plugin) {
    $plugin = $this->votingapiResult
      ->createInstance($plugin_id, $plugin);
    if ($plugin
      ->getDerivativeId()) {
      $options[$plugin_id] = $plugin_id;
    }
  }
  return [
    // Implement settings form.
    'style' => [
      '#title' => $this
        ->t('Styles'),
      '#type' => 'select',
      '#options' => $styles,
      '#default_value' => $this
        ->getSetting('style'),
    ],
    'readonly' => [
      '#title' => $this
        ->t('Readonly'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('readonly'),
    ],
    'show_results' => [
      '#title' => $this
        ->t('Show results'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('show_results'),
    ],
    'show_own_vote' => [
      '#title' => $this
        ->t('Show own vote'),
      '#description' => $this
        ->t('Show own cast vote instead of results. (Useful on add/ edit forms with rate widget).'),
      '#type' => 'checkbox',
      '#return_value' => 1,
      '#default_value' => $this
        ->getSetting('show_own_vote'),
    ],
  ] + parent::settingsForm($form, $form_state);
}