You are here

Home » API reference » Vote Up/Down 8 » YesNo.php

class YesNo in Vote Up/Down 8

Provides the "yesno" Vote Up/Down widget

Plugin annotation


@VoteUpDownWidget(
  id = "yesno",
  admin_label = @Translation("Yes/No"),
  description = @Translation("Provides a yes/no widget, together with a percentage of positive votes.")
 )

Hierarchy

Expanded class hierarchy of YesNo

File

src/Plugin/VoteUpDownWidget/YesNo.php, line 16

Namespace

Drupal\vud\Plugin\VoteUpDownWidget
View source 
class YesNo extends VoteUpDownWidgetBase {

  /**
   * {@inheritdoc}
   */
  public function alterTemplateVariables(&$variables) {
    parent::alterTemplateVariables($variables);
    if ($variables['#unsigned_points'] == 0) {

      // No votes yet.
      $variables['#up_percent'] = 0;
    }
    else {
      $variables['#up_percent'] = $variables['#up_points'] / $variables['#unsigned_points'] * 100;
    }
    $variables['#percent_text'] = $this
      ->t('<em>@up_percent%</em> found this useful', [
      '@up_percent' => $variables['#up_percent'],
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.
VoteUpDownWidgetBase::build public function @fixme Do not use camelcase on variables, and fix coding standards. Overrides VoteUpDownWidgetInterface::build
VoteUpDownWidgetBase::getWidgetId public function Returns the label of the specific plugin instance Overrides VoteUpDownWidgetInterface::getWidgetId
VoteUpDownWidgetBase::getWidgetTemplate public function Returns the widget template for a specific plugin instance Overrides VoteUpDownWidgetInterface::getWidgetTemplate
VoteUpDownWidgetBase::getWidgetTemplateVars public function Returns the path to the widget template to be used. Overrides VoteUpDownWidgetInterface::getWidgetTemplateVars
YesNo::alterTemplateVariables public function Array containing all info for a plugin instance Overrides VoteUpDownWidgetBase::alterTemplateVariables