You are here

Home » API reference » Voting API Reaction 8 » VotingApiReactionFormatter.php

class VotingApiReactionFormatter in Voting API Reaction 8

Plugin implementation of the 'votingapi_reaction_default' formatter.

Plugin annotation


@FieldFormatter(
  id = "votingapi_reaction_default",
  module = "votingapi_reaction",
  label = @Translation("Default"),
  field_types = {
    "votingapi_reaction"
  },
  quickedit = {
    "editor" = "disabled"
  }
)

Hierarchy

Expanded class hierarchy of VotingApiReactionFormatter

File

src/Plugin/Field/FieldFormatter/VotingApiReactionFormatter.php, line 29

Namespace

Drupal\votingapi_reaction\Plugin\Field\FieldFormatter
View source 
class VotingApiReactionFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Form builder service.
   *
   * @var \Drupal\Core\Entity\EntityFormBuilder
   */
  protected $formBuilder;

  /**
   * Constructs an VotingApiReactionFormatter 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\Core\Entity\EntityFormBuilder $form_builder
   *   Form builder service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityFormBuilder $form_builder) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->formBuilder = $form_builder;
  }

  /**
   * {@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('entity.form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'show_summary' => TRUE,
      'show_icon' => TRUE,
      'show_label' => TRUE,
      'show_count' => TRUE,
      'sort_reactions' => 'desc',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [
      'show_summary' => [
        '#title' => $this
          ->t('Show reactions summary'),
        '#type' => 'checkbox',
        '#default_value' => $this
          ->getSetting('show_summary'),
      ],
      'show_icon' => [
        '#title' => $this
          ->t('Show reaction icon'),
        '#type' => 'checkbox',
        '#default_value' => $this
          ->getSetting('show_icon'),
      ],
      'show_label' => [
        '#title' => $this
          ->t('Show reaction label'),
        '#type' => 'checkbox',
        '#default_value' => $this
          ->getSetting('show_label'),
      ],
      'show_count' => [
        '#title' => $this
          ->t('Show reaction count'),
        '#type' => 'checkbox',
        '#default_value' => $this
          ->getSetting('show_count'),
      ],
      'sort_reactions' => [
        '#title' => $this
          ->t('Sort reactions'),
        '#type' => 'select',
        '#options' => [
          'none' => $this
            ->t('No sorting'),
          'asc' => $this
            ->t('Asc'),
          'desc' => $this
            ->t('Desc'),
        ],
        '#default_value' => $this
          ->getSetting('sort_reactions'),
      ],
    ] + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    return [
      $this
        ->t('Reactions summary: @status', [
        '@status' => $this
          ->getSetting('show_summary') ? $this
          ->t('yes') : $this
          ->t('no'),
      ]),
      $this
        ->t('Reaction icon: @status', [
        '@status' => $this
          ->getSetting('show_icon') ? $this
          ->t('yes') : $this
          ->t('no'),
      ]),
      $this
        ->t('Reaction label: @status', [
        '@status' => $this
          ->getSetting('show_label') ? $this
          ->t('yes') : $this
          ->t('no'),
      ]),
      $this
        ->t('Reaction count: @status', [
        '@status' => $this
          ->getSetting('show_count') ? $this
          ->t('yes') : $this
          ->t('no'),
      ]),
      $this
        ->t('Sort reactions: @status', [
        '@status' => $this
          ->getSetting('sort_reactions'),
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    if (is_null($items->status)) {
      $default_value = $items
        ->getFieldDefinition()
        ->getDefaultValue($items
        ->getEntity());
      $items->status = $default_value[0]['status'];
    }
    $extras = [
      'field_items' => $items,
      'formatter_settings' => $this
        ->getSettings(),
    ];
    $entity = Vote::create([
      'type' => '',
      'entity_id' => $items
        ->getEntity()
        ->id(),
      'entity_type' => $items
        ->getEntity()
        ->getEntityTypeId(),
      'value_type' => 'option',
      'value' => 1,
      'field_name' => $items
        ->getName(),
    ]);
    $form = $this->formBuilder
      ->getForm($entity, 'votingapi_reaction', $extras);
    if ($form['#access']) {
      $elements[] = [
        'form' => $form,
      ];
    }
    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.
VotingApiReactionFormatter::$formBuilder protected property Form builder service.
VotingApiReactionFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
VotingApiReactionFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
VotingApiReactionFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
VotingApiReactionFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
VotingApiReactionFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
VotingApiReactionFormatter::__construct public function Constructs an VotingApiReactionFormatter object. Overrides FormatterBase::__construct