class VoteController in Like & Dislike 8

Returns responses for Like & Dislikes routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\like_and_dislike\Controller\VoteController

Expanded class hierarchy of VoteController

File

src/Controller/VoteController.php, line 12

Namespace

Drupal\like_and_dislike\Controller

View source

class VoteController extends ControllerBase {

  /**
   * Creates a vote for a given parameters.
   *
   * @param string $entity_type_id
   *   The entity type ID to vote for.
   * @param string $vote_type_id
   *   The vote type (like or dislike).
   * @param string $entity_id
   *   The entity ID to vote for.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   Returns JSON response.
   */
  public function vote($entity_type_id, $vote_type_id, $entity_id) {
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type_id)
      ->load($entity_id);

    // Gets the number of likes and dislikes for the entity.
    list($like, $dislike) = like_and_dislike_get_votes($entity);
    $operation = [
      'like' => FALSE,
      'dislike' => FALSE,
    ];

    /** @var \Drupal\votingapi\VoteStorageInterface $vote_storage */
    $vote_storage = $this
      ->entityTypeManager()
      ->getStorage('vote');
    $user_votes = $vote_storage
      ->getUserVotes($this
      ->currentUser()
      ->id(), $vote_type_id, $entity_type_id, $entity_id);
    if ($vote_type_id === 'like') {
      $opposite_vote_type_id = 'dislike';
    }
    else {
      $opposite_vote_type_id = 'like';
    }
    if (empty($user_votes)) {

      // Increment the value for requested vote type.
      ${$vote_type_id}++;
      $operation[$vote_type_id] = TRUE;

      // @todo: Moving it after vote creation wrongly returns empty array.
      // Get user votes for opposite vote type.
      $user_opposite_votes = $vote_storage
        ->getUserVotes($this
        ->currentUser()
        ->id(), $opposite_vote_type_id, $entity_type_id, $entity_id);

      /** @var \Drupal\votingapi\VoteTypeInterface $vote_type */
      $vote_type = $this
        ->entityTypeManager()
        ->getStorage('vote_type')
        ->load($vote_type_id);

      /** @var \Drupal\votingapi\VoteInterface $vote */
      $vote = $vote_storage
        ->create([
        'type' => $vote_type_id,
      ]);
      $vote
        ->setVotedEntityId($entity_id);
      $vote
        ->setVotedEntityType($entity_type_id);
      $vote
        ->setValueType($vote_type
        ->getValueType());
      $vote
        ->setValue(1);
      $vote
        ->save();

      // Remove the opposite vote, if any.
      if (!empty($user_opposite_votes)) {
        $vote_storage
          ->deleteUserVotes($this
          ->currentUser()
          ->id(), $opposite_vote_type_id, $entity_type_id, $entity_id);

        // Remove opposite vote.
        ${$opposite_vote_type_id}--;
        $operation[$opposite_vote_type_id] = FALSE;
      }

      // Clear the view builder's cache.
      $this
        ->entityTypeManager()
        ->getViewBuilder($entity_type_id)
        ->resetCache([
        $entity,
      ]);
      return new JsonResponse([
        'likes' => $like,
        'dislikes' => $dislike,
        'message_type' => 'status',
        'operation' => $operation,
        'message' => $this
          ->t('Your vote was added.'),
      ]);
    }
    else {
      if ($this
        ->config('like_and_dislike.settings')
        ->get('allow_cancel_vote')) {

        // Decrement the value for requested vote type.
        ${$vote_type_id}--;
        $operation[$vote_type_id] = FALSE;

        // Remove the vote.
        $vote_storage
          ->deleteUserVotes($this
          ->currentUser()
          ->id(), $vote_type_id, $entity_type_id, $entity_id);

        // Clear the view builder's cache.
        $this
          ->entityTypeManager()
          ->getViewBuilder($entity_type_id)
          ->resetCache([
          $entity,
        ]);
        return new JsonResponse([
          'likes' => $like,
          'dislikes' => $dislike,
          'operation' => $operation,
          'message_type' => 'status',
          'message' => $this
            ->t('Your vote was canceled.'),
        ]);
      }
      else {

        // User is not allowed to cancel his vote.
        return new JsonResponse([
          'likes' => $like,
          'dislikes' => $dislike,
          'operation' => $operation,
          'message_type' => 'warning',
          'message' => $this
            ->t('You are not allowed to vote the same way multiple times.'),
        ]);
      }
    }
  }

  /**
   * Checks if the currentUser is allowed to vote.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $vote_type_id
   *   The vote type ID.
   * @param string $entity_id
   *   The entity ID.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function voteAccess($entity_type_id, $vote_type_id, $entity_id) {
    $entity = $this
      ->entityTypeManager()
      ->getStorage($entity_type_id)
      ->load($entity_id);

    // Check if user has permission to vote.
    return AccessResult::allowedIf(like_and_dislike_can_vote($this
      ->currentUser(), $vote_type_id, $entity));
  }

}

Members

Name	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::$entityTypeManager	protected	property	The entity type 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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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::vote	public	function	Creates a vote for a given parameters.
VoteController::voteAccess	public	function	Checks if the currentUser is allowed to vote.

You are here

class VoteController in Like & Dislike 8

Hierarchy

File

Namespace

Members

API Navigation