You are here

Home » API reference » Rate 8 » VoteController.php

class VoteController in Rate 8

Returns responses for Rate routes.

Hierarchy

Expanded class hierarchy of VoteController

File

src/Controller/VoteController.php, line 22

Namespace

Drupal\rate\Controller
View source 
class VoteController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The config factory wrapper to fetch settings.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

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

  /**
   * The cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The vote service.
   *
   * @var \Drupal\rate\RateVote
   */
  protected $rateVote;

  /**
   * RateEntityVoteWidget connection object.
   *
   * @var \Drupal\rate\RateEntityVoteWidget
   */
  protected $voteWidget;

  /**
   * Constructs a Vote Controller.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tags_invalidator
   *   The cache tags invalidator.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\rate\RateVote $rate_vote
   *   The bot detector service.
   * @param \Drupal\rate\RateEntityVoteWidget $vote_widget
   *   The vote widget to display.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, CacheTagsInvalidatorInterface $cache_tags_invalidator, RendererInterface $renderer, RateVote $rate_vote, RateEntityVoteWidget $vote_widget) {
    $this->config = $config_factory
      ->get('rate.settings');
    $this->entityTypeManager = $entity_type_manager;
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
    $this->renderer = $renderer;
    $this->rateVote = $rate_vote;
    $this->voteWidget = $vote_widget;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('cache_tags.invalidator'), $container
      ->get('renderer'), $container
      ->get('rate.vote'), $container
      ->get('rate.entity.vote_widget'));
  }

  /**
   * Invalidate cache tags to update vote display.
   *
   * @param string $entity_type_id
   *   The entity type.
   * @param int $entity_id
   *   The entity id.
   * @param string $bundle
   *   The bundle name.
   */
  protected function invalidateCacheTags($entity_type_id, $entity_id, $bundle) {
    $invalidate_tags = [
      $entity_type_id . ':' . $entity_id,
      'vote:' . $bundle . ':' . $entity_id,
    ];
    $this->cacheTagsInvalidator
      ->invalidateTags($invalidate_tags);
  }

  /**
   * Prepare a response object.
   *
   * @param string $entity_type_id
   *   The entity type.
   * @param int $entity_id
   *   The entity id.
   * @param string $bundle
   *   The bundle name.
   * @param string $widget_type
   *   Widget type.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  protected function prepareResponse($entity_type_id, $entity_id, $bundle, $widget_type, Request $request) {
    $use_ajax = $this->config
      ->get('use_ajax');

    // If Request was AJAX and voting on a node, send AJAX response.
    if ($use_ajax) {
      $response = new AjaxResponse();
      $vote_widget = $this->voteWidget
        ->buildRateVotingWidget($entity_id, $entity_type_id, $bundle, $widget_type);
      $widget_id = '[data-drupal-selector=rate-' . $entity_type_id . '-' . $entity_id . ']';
      $html = $this->renderer
        ->render($vote_widget);
      $response
        ->addCommand(new ReplaceCommand($widget_id, $html));
      return $response;
    }
    else {
      $url = $request
        ->getUriForPath($request
        ->getPathInfo());
      return new RedirectResponse($url);
    }
  }

  /**
   * Record a vote.
   *
   * @param string $entity_type_id
   *   Entity type ID such as node.
   * @param int $entity_id
   *   Entity id of the entity type.
   * @param string $vote_type_id
   *   Vote type id.
   * @param int $value
   *   The vote.
   * @param string $widget_type
   *   Widget type.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request object that contains redirect path.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function vote($entity_type_id, $entity_id, $vote_type_id, $value, $widget_type, Request $request) {
    $entity = $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->load($entity_id);
    $this->rateVote
      ->vote($entity_type_id, $entity_id, $vote_type_id, $value, !$this->config
      ->get('use_ajax'));
    $this
      ->invalidateCacheTags($entity_type_id, $entity_id, $entity
      ->bundle());
    return $this
      ->prepareResponse($entity_type_id, $entity_id, $entity
      ->bundle(), $widget_type, $request);
  }

  /**
   * Undo a vote.
   *
   * @param string $entity_type_id
   *   Entity type ID such as node.
   * @param int $entity_id
   *   Entity id of the entity type.
   * @param string $widget_type
   *   Widget type.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request object that contains redirect path.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function undoVote($entity_type_id, $entity_id, $widget_type, Request $request) {
    $entity = $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->load($entity_id);
    $this->rateVote
      ->undoVote($entity_type_id, $entity_id, !$this->config
      ->get('use_ajax'));
    $this
      ->invalidateCacheTags($entity_type_id, $entity_id, $entity
      ->bundle());
    return $this
      ->prepareResponse($entity_type_id, $entity_id, $entity
      ->bundle(), $widget_type, $request);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
VoteController::$cacheTagsInvalidator protected property The cache tags invalidator.
VoteController::$config protected property The config factory wrapper to fetch settings.
VoteController::$entityTypeManager protected property The entity type manager. Overrides ControllerBase::$entityTypeManager
VoteController::$rateVote protected property The vote service.
VoteController::$renderer protected property The renderer service.
VoteController::$voteWidget protected property RateEntityVoteWidget connection object.
VoteController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
VoteController::invalidateCacheTags protected function Invalidate cache tags to update vote display.
VoteController::prepareResponse protected function Prepare a response object.
VoteController::undoVote public function Undo a vote.
VoteController::vote public function Record a vote.
VoteController::__construct public function Constructs a Vote Controller.