You are here

Home » API reference » Fivestar 8 » StarsFormatter.php

class StarsFormatter in Fivestar 8

Plugin implementation of the 'fivestar_stars' formatter.

Plugin annotation


@FieldFormatter(
  id = "fivestar_stars",
  label = @Translation("As stars"),
  field_types = {
    "fivestar"
  },
  weight = 1
)

Hierarchy

Expanded class hierarchy of StarsFormatter

File

src/Plugin/Field/FieldFormatter/StarsFormatter.php, line 21

Namespace

Drupal\fivestar\Plugin\Field\FieldFormatter
View source 
class StarsFormatter extends FivestarFormatterBase implements TrustedCallbackInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'text_format' => 'average',
      'display_format' => 'average',
      'fivestar_widget' => 'basic',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['fivestar_widget'] = [
      '#type' => 'radios',
      '#options' => $this->widgetManager
        ->getWidgetsOptionSet(),
      '#default_value' => $this
        ->getSetting('fivestar_widget'),
      '#attributes' => [
        'class' => [
          'fivestar-widgets',
          'clearfix',
        ],
      ],
      '#pre_render' => [
        [
          $this,
          'previewsExpand',
        ],
      ],
      '#attached' => [
        'library' => [
          'fivestar/fivestar.admin',
        ],
      ],
    ];
    $elements['display_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Value to display as stars'),
      '#options' => [
        'average' => $this
          ->t('Average vote'),
      ],
      '#default_value' => $this
        ->getSetting('display_format'),
    ];
    $elements['text_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Text to display under the stars'),
      '#options' => [
        'none' => $this
          ->t('No text'),
        'average' => $this
          ->t('Average vote'),
      ],
      '#default_value' => $this
        ->getSetting('text_format'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function trustedCallbacks() {
    return [
      'previewsExpand',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary[] = $this
      ->t('Style: @widget', [
      '@widget' => $this->widgetManager
        ->getWidgetLabel($this
        ->getSelectedWidgetKey()),
    ]);
    $summary[] = $this
      ->t('Stars display: @style, Text display: @text', [
      '@style' => $this
        ->getSetting('display_format'),
      '@text' => $this
        ->getSetting('text_format'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $entity = $items
      ->getEntity();
    $form_builder = \Drupal::formBuilder();
    $widget_active_key = $this
      ->getSelectedWidgetKey();
    $display_settings = [
      'name' => $this->widgetManager
        ->getWidgetInfo($widget_active_key) ? $widget_active_key : 'default',
    ] + $this
      ->getSettings();
    if (!$items
      ->isEmpty()) {

      /** @var \Drupal\fivestar\Plugin\Field\FieldType\FivestarItem $item */
      foreach ($items as $delta => $item) {
        $context = [
          'entity' => $entity,
          'field_definition' => $item
            ->getFieldDefinition(),
          'display_settings' => $display_settings,
        ];
        $elements[$delta] = $form_builder
          ->getForm('\\Drupal\\fivestar\\Form\\FivestarForm', $context);
      }
    }
    else {
      $bundle_fields = \Drupal::getContainer()
        ->get('entity_field.manager')
        ->getFieldDefinitions($entity
        ->getEntityType()
        ->id(), $entity
        ->bundle());
      $field_definition = $bundle_fields[$items
        ->getName()];
      $context = [
        'entity' => $entity,
        'field_definition' => $field_definition,
        'display_settings' => $display_settings,
      ];
      $elements[] = $form_builder
        ->getForm('\\Drupal\\fivestar\\Form\\FivestarForm', $context);
    }
    return $elements;
  }

  /**
   * Gets the selected widget key.
   *
   * Sites that used an older version of the module will have
   * a stale key set for their selected widget. This returns
   * the proper, cleaned up version if that's the case.
   *
   * @return string
   *   The active widget's key
   */
  protected function getSelectedWidgetKey() {
    $setting = $this
      ->getSetting('fivestar_widget') ?: 'default';
    if (strpos($setting, '.css') === FALSE) {
      return $setting;
    }
    $file_name = basename($setting);
    $file_name_exploded = explode('.', $file_name);
    $setting = reset($file_name_exploded);
    return $setting;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FivestarFormatterBase::$widgetManager protected property The widget manager.
FivestarFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FivestarFormatterBase::previewsExpand public function Prepares the widget's render element for rendering.
FivestarFormatterBase::__construct public function Constructs a FivestarFormatterBase object. Overrides FormatterBase::__construct
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StarsFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
StarsFormatter::getSelectedWidgetKey protected function Gets the selected widget key.
StarsFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
StarsFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
StarsFormatter::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
StarsFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.