You are here

StarRatingWidget.php in Star Rating 8.4

File

src/Plugin/Field/FieldWidget/StarRatingWidget.php
View source
<?php

namespace Drupal\starrating\Plugin\Field\FieldWidget;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'starrating' widget.
 *
 * @FieldWidget(
 *   id = "starrating",
 *   module = "starrating",
 *   label = @Translation("Star rating"),
 *   field_types = {
 *     "starrating"
 *   }
 * )
 */
class StarRatingWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $value = isset($items[$delta]->value) ? $items[$delta]->value : '';
    $field_settings = $this
      ->getFieldSettings();
    $max_value = $field_settings['max_value'];
    $options = [];

    // Handle "null" as a string so the form will validate.
    $options['null'] = $this
      ->t('Not selected');
    for ($i = 0; $i <= $max_value; $i++) {
      $options[$i] = $i;
    }
    $element += [
      '#type' => 'select',
      '#default_value' => NULL,
      '#options' => $options,
      '#default_value' => $value,
    ];
    return [
      'value' => $element,
    ];
  }

}

Classes

Namesort descending Description
StarRatingWidget Plugin implementation of the 'starrating' widget.