RatingFormatter.php in Fivestar 8

Namespace

Drupal\fivestar\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/RatingFormatter.php

<?php

namespace Drupal\fivestar\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;

/**
 * Plugin implementation of the 'fivestar_rating' formatter.
 *
 * @FieldFormatter(
 *   id = "fivestar_rating",
 *   label = @Translation("Rating (i.e. 4.2/5)"),
 *   field_types = {
 *     "fivestar"
 *   },
 *   weight = 3
 * )
 */
class RatingFormatter extends FivestarFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $values = [
      'user' => 0,
      'average' => 0,
      'count' => 0,
    ];
    $rating = [];
    $users = [];
    $elements = [];
    if (!$items
      ->isEmpty()) {

      /** @var \Drupal\fivestar\Plugin\Field\FieldType\FivestarItem $item */
      foreach ($items as $delta => $item) {
        $value = $item
          ->getValue();
        $rating[] = $value['rating'];
        $users[] = $value['target'];
        $values['count'] += 1;
      }
      if (!empty($rating)) {
        $values['average'] = array_sum($rating) / $values['count'];
        $users = array_unique($users);
        $values['user'] = count($users);
      }
      $elements[] = [
        '#theme' => 'fivestar_formatter_rating',
        '#instance_settings' => $item
          ->getFieldDefinition()
          ->getSettings(),
        '#item' => $values,
      ];
    }
    else {
      $elements[] = [
        '#markup' => $this
          ->t('No votes yet'),
      ];
    }
    return $elements;
  }

}

Classes

Name	Description
RatingFormatter	Plugin implementation of the 'fivestar_rating' formatter.