class RateSum in Rate 8.2

An average of a set of votes.

Plugin annotation

@VoteResultFunction(
  id = "rate_sum",
  label = @Translation("Sum"),
  description = @Translation("The total votes."),
  deriver = "Drupal\rate\Plugin\Derivative\RateVoteResultFunction",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\votingapi\VoteResultFunctionBase implements VoteResultFunctionInterface
      • class \Drupal\rate\RateVoteResultBase implements RateVoteResultInterface
        • class \Drupal\rate\Plugin\VoteResultFunction\RateSum

File

src/Plugin/VoteResultFunction/RateSum.php, line 17

Namespace

Drupal\rate\Plugin\VoteResultFunction

class RateSum extends RateVoteResultBase {

  /**
   * {@inheritdoc}
   */
  public function calculateResult($votes) {
    $total = 0;
    $votes = $this
      ->getVotesForField($votes);
    foreach ($votes as $vote) {
      $total += (int) $vote
        ->getValue();
    }
    return $total;
  }

}

Members

Name	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
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RateSum::calculateResult	public	function	Calculate results. Overrides RateVoteResultBase::calculateResult
RateVoteResultBase::getVotesForField	public	function	Get votes for field. Overrides RateVoteResultInterface::getVotesForField
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.
VoteResultFunctionBase::getDescription	public	function	Retrieve the description for the voting result. Overrides VoteResultFunctionInterface::getDescription
VoteResultFunctionBase::getLabel	public	function	Retrieve the label for the voting result. Overrides VoteResultFunctionInterface::getLabel