abstract class VotingApiWidgetBase in Votingapi Widgets 8

Base class for Voting api widget plugins.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\votingapi_widgets\Plugin\VotingApiWidgetBase implements ContainerFactoryPluginInterface, VotingApiWidgetInterface

Expanded class hierarchy of VotingApiWidgetBase

3 files declare their use of VotingApiWidgetBase

FiveStarWidget.php in src/Plugin/votingapi_widget/FiveStarWidget.php
LikeWidget.php in src/Plugin/votingapi_widget/LikeWidget.php
UsefulWidget.php in src/Plugin/votingapi_widget/UsefulWidget.php

File

src/Plugin/VotingApiWidgetBase.php, line 21

Namespace

Drupal\votingapi_widgets\Plugin

View source

abstract class VotingApiWidgetBase extends PluginBase implements VotingApiWidgetInterface, ContainerFactoryPluginInterface {

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

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

  /**
   * The entity form builder service.
   *
   * @var \Drupal\Core\Entity\EntityFormBuilderInterface
   */
  protected $entityFormBuilder;

  /**
   * The user account.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a new class instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager service.
   * @param \Drupal\votingapi\VoteResultFunctionManager $vote_result
   *   Vote result function manager service.
   * @param \Drupal\Core\Entity\EntityFormBuilderInterface $form_builder
   *   The form builder service.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user account.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, VoteResultFunctionManager $vote_result, EntityFormBuilderInterface $form_builder, AccountInterface $account, RequestStack $request_stack, ConfigFactoryInterface $config_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->votingapiResult = $vote_result;
    $this->entityFormBuilder = $form_builder;
    $this->account = $account;
    $this->requestStack = $request_stack;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.votingapi.resultfunction'), $container
      ->get('entity.form_builder'), $container
      ->get('current_user'), $container
      ->get('request_stack'), $container
      ->get('config.factory'));
  }

  /**
   * Return label.
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * Return minimal value.
   */
  public function getValues() {
    return $this
      ->getPluginDefinition()['values'];
  }

  /**
   * Gets the widget form as configured for given parameters.
   *
   * @return array
   *   Configured vote form.
   */
  public function getForm($entity_type, $entity_bundle, $entity_id, $vote_type, $field_name, $settings) {
    $vote = $this
      ->getEntityForVoting($entity_type, $entity_bundle, $entity_id, $vote_type, $field_name);

    /*
     * @todo Remove custom entity_form_builder once
     * https://www.drupal.org/node/766146 is fixed.
     */
    return $this->entityFormBuilder
      ->getForm($vote, 'votingapi_' . $this
      ->getPluginId(), [
      'options' => $this
        ->getPluginDefinition()['values'],
      'settings' => $settings,
      'plugin' => $this,
      // @todo The following keys can be removed once #766146 is fixed.
      // @see https://www.drupal.org/node/766146
      'entity_type' => $entity_type,
      'entity_bundle' => $entity_bundle,
      'entity_id' => $entity_id,
      'vote_type' => $vote_type,
      'field_name' => $field_name,
    ]);
  }

  /**
   * Get initial element.
   */
  public abstract function getInitialVotingElement(array &$form);

  /**
   * Checks whether currentUser is allowed to vote.
   *
   * @return bool
   *   True if user is allowed to vote
   */
  public function canVote($vote, $account = FALSE) {
    if (!$account) {
      $account = $this->account;
    }
    $entity = $this->entityTypeManager
      ->getStorage($vote
      ->getVotedEntityType())
      ->load($vote
      ->getVotedEntityId());
    if (!$entity) {
      return FALSE;
    }
    $perm = 'vote on ' . $vote
      ->getVotedEntityType() . ':' . $entity
      ->bundle() . ':' . $vote->field_name->value;
    if (!$vote
      ->isNew()) {
      $perm = 'edit own vote on ' . $vote
        ->getVotedEntityType() . ':' . $entity
        ->bundle() . ':' . $vote->field_name->value;
    }
    return $account
      ->hasPermission($perm);
  }

  /**
   * Returns a Vote entity.
   *
   * Checks whether a vote was already done and if this vote should be reused
   * instead of adding a new one.
   *
   * @return \Drupal\votingapi\Entity\Vote
   *   The Vote entity.
   */
  public function getEntityForVoting($entity_type, $entity_bundle, $entity_id, $vote_type, $field_name) {
    $storage = $this->entityTypeManager
      ->getStorage('vote');
    $voteData = [
      'entity_type' => $entity_type,
      'entity_id' => $entity_id,
      'type' => $vote_type,
      'field_name' => $field_name,
      'user_id' => $this->account
        ->id(),
    ];
    $vote = $storage
      ->create($voteData);
    $timestamp_offset = $this
      ->getWindow('user_window', $entity_type, $entity_bundle, $field_name);
    if ($this->account
      ->isAnonymous()) {
      $voteData['vote_source'] = Vote::getCurrentIp();
      $timestamp_offset = $this
        ->getWindow('anonymous_window', $entity_type, $entity_bundle, $field_name);
    }
    $query = $this->entityTypeManager
      ->getStorage('vote')
      ->getQuery();
    foreach ($voteData as $key => $value) {
      $query
        ->condition($key, $value);
    }

    // Check for rollover 'never' setting.
    if (!empty($timestamp_offset)) {
      $query
        ->condition('timestamp', time() - $timestamp_offset, '>=');
    }
    $votes = $query
      ->execute();
    if ($votes && count($votes) > 0) {
      $vote = $storage
        ->load(array_shift($votes));
    }
    return $vote;
  }

  /**
   * Get results.
   */
  public function getResults($entity, $result_function = FALSE, $reset = FALSE) {
    if ($reset) {
      drupal_static_reset(__FUNCTION__);
    }
    $resultCache =& drupal_static(__FUNCTION__);
    if (!$resultCache) {
      $resultCache = $this->votingapiResult
        ->getResults($entity
        ->getVotedEntityType(), $entity
        ->getVotedEntityId());
    }
    if ($result_function) {
      if (!$resultCache[$entity
        ->getEntityTypeId()][$entity
        ->getVotedEntityId()][$result_function]) {
        return [];
      }
      return $resultCache[$entity
        ->getEntityTypeId()][$entity
        ->getVotedEntityId()][$result_function];
    }
    if (!$result_function) {
      if (!isset($resultCache[$entity
        ->getEntityTypeId()][$entity
        ->getVotedEntityId()])) {
        return [];
      }
      return $resultCache[$entity
        ->getEntityTypeId()][$entity
        ->getVotedEntityId()];
    }
    return [];
  }

  /**
   * Get time window settings.
   */
  public function getWindow($window_type, $entity_type_id, $entity_bundle, $field_name) {
    $config = FieldConfig::loadByName($entity_type_id, $entity_bundle, $field_name);
    $window_field_setting = $config
      ->getSetting($window_type);
    $use_site_default = FALSE;
    if ($window_field_setting === NULL || $window_field_setting === "-1") {
      $use_site_default = TRUE;
    }
    $window = $window_field_setting;
    if ($use_site_default) {

      /** @var \Drupal\Core\Config\ImmutableConfig $voting_configuration */
      $voting_configuration = $this->configFactory
        ->get('votingapi.settings');
      $window = $voting_configuration
        ->get($window_type);
    }
    return $window;
  }

  /**
   * Generate summary.
   */
  public function getVoteSummary(ContentEntityInterface $vote) {
    $results = $this
      ->getResults($vote);
    $field_name = $vote->field_name->value;
    $fieldResults = [];
    foreach ($results as $key => $result) {
      if (strrpos($key, $field_name) !== FALSE) {
        $key = explode(':', $key);
        $fieldResults[$key[0]] = $result != 0 ? ceil($result * 10) / 10 : 0;
      }
    }
    return [
      '#theme' => 'votingapi_widgets_summary',
      '#vote' => $vote,
      '#results' => $fieldResults,
      '#field_name' => $vote->field_name->value,
    ];
  }

}

Members

Name	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.
VotingApiWidgetBase::$account	protected	property	The user account.
VotingApiWidgetBase::$configFactory	protected	property	The config factory service.
VotingApiWidgetBase::$entityFormBuilder	protected	property	The entity form builder service.
VotingApiWidgetBase::$entityTypeManager	protected	property	The entity type manager service.
VotingApiWidgetBase::$requestStack	protected	property	The request stack.
VotingApiWidgetBase::$votingapiResult	protected	property	Vote result function manager service.
VotingApiWidgetBase::canVote	public	function	Checks whether currentUser is allowed to vote.
VotingApiWidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
VotingApiWidgetBase::getEntityForVoting	public	function	Returns a Vote entity.
VotingApiWidgetBase::getForm	public	function	Gets the widget form as configured for given parameters.
VotingApiWidgetBase::getInitialVotingElement	abstract public	function	Get initial element.	3
VotingApiWidgetBase::getLabel	public	function	Return label.
VotingApiWidgetBase::getResults	public	function	Get results.
VotingApiWidgetBase::getValues	public	function	Return minimal value.
VotingApiWidgetBase::getVoteSummary	public	function	Generate summary.
VotingApiWidgetBase::getWindow	public	function	Get time window settings.
VotingApiWidgetBase::__construct	public	function	Constructs a new class instance. Overrides PluginBase::__construct
VotingApiWidgetInterface::buildForm	public	function	Build form.	3
VotingApiWidgetInterface::getStyles	public	function	Get available styles.	3

You are here

abstract class VotingApiWidgetBase in Votingapi Widgets 8

Hierarchy

File

Namespace

Members

API Navigation