You are here

Home » API reference » Votingapi Widgets 8 » VotingApiFormatter.php

class VotingApiFormatter in Votingapi Widgets 8

Plugin implementation of the 'voting_api_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "voting_api_formatter",
  label = @Translation("Voting api formatter"),
  field_types = {
    "voting_api_field"
  }
)

Hierarchy

Expanded class hierarchy of VotingApiFormatter

File

src/Plugin/Field/FieldFormatter/VotingApiFormatter.php, line 25

Namespace

Drupal\votingapi_widgets\Plugin\Field\FieldFormatter
View source 
class VotingApiFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'readonly' => FALSE,
      'style' => 'default',
      'show_results' => FALSE,
      'values' => [],
      'show_own_vote' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * Vote result function manager service.
   *
   * @var \Drupal\votingapi\VoteResultFunctionManager
   */
  protected $votingapiResult;

  /**
   * The votingapi_widget widget manager.
   *
   * @var \Drupal\votingapi_widgets\Plugin\VotingApiWidgetManager
   */
  protected $votingapiWidgetProcessor;

  /**
   * Constructs an VotingApiFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\votingapi\VoteResultFunctionManager $vote_result
   *   Vote result function.
   * @param \Drupal\votingapi_widgets\Plugin\VotingApiWidgetManager $widget_manager
   *   The votingapi_widget widget manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, VoteResultFunctionManager $vote_result, VotingApiWidgetManager $widget_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->votingapiResult = $vote_result;
    $this->votingapiWidgetProcessor = $widget_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.votingapi.resultfunction'), $container
      ->get('plugin.manager.voting_api_widget.processor'));
  }

  /**
   * {@inheritdoc}
   */
  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);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Styles: @styles', [
      '@styles' => $this
        ->getSetting('style'),
    ]);
    $summary[] = $this
      ->t('Readonly: @readonly', [
      '@readonly' => $this
        ->getSetting('readonly') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Show results: @results', [
      '@results' => $this
        ->getSetting('show_results') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Show own vote: @show_own_vote', [
      '@show_own_vote' => $this
        ->getSetting('show_own_vote') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $entity = $items
      ->getEntity();

    // Do not continue if the entity is being previewed.
    if (!empty($entity->in_preview)) {
      return $elements;
    }
    $field_settings = $this
      ->getFieldSettings();
    $field_name = $this->fieldDefinition
      ->getName();
    $vote_type = $field_settings['vote_type'];
    $vote_plugin = $field_settings['vote_plugin'];
    $show_own_vote = $this
      ->getSetting('show_own_vote') ? TRUE : FALSE;
    $elements[] = [
      'vote_form' => [
        '#lazy_builder' => [
          'voting_api.lazy_loader:buildForm',
          [
            $vote_plugin,
            $entity
              ->getEntityTypeId(),
            $entity
              ->bundle(),
            $entity
              ->id(),
            $vote_type,
            $field_name,
            serialize($this
              ->getSettings()),
          ],
        ],
        '#create_placeholder' => TRUE,
      ],
      'results' => [],
    ];
    return $elements;
  }

}

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
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
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.
VotingApiFormatter::$votingapiResult protected property Vote result function manager service.
VotingApiFormatter::$votingapiWidgetProcessor protected property The votingapi_widget widget manager.
VotingApiFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
VotingApiFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
VotingApiFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
VotingApiFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
VotingApiFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
VotingApiFormatter::__construct public function Constructs an VotingApiFormatter object. Overrides FormatterBase::__construct