You are here

Home » API reference » Commerce Add To Cart Link 2.x » AddToWishlistController.php

class AddToWishlistController in Commerce Add To Cart Link 2.x

Same name and namespace in other branches
  1. 8 modules/wishlist/src/Controller/AddToWishlistController.php \Drupal\commerce_add_to_wishlist_link\Controller\AddToWishlistController

Defines the add to wishlist controller.

The controller enables product variations to be added via GET requests.

Hierarchy

Expanded class hierarchy of AddToWishlistController

File

modules/wishlist/src/Controller/AddToWishlistController.php, line 22

Namespace

Drupal\commerce_add_to_wishlist_link\Controller
View source 
class AddToWishlistController extends ControllerBase {

  /**
   * The cart link token service.
   *
   * @var \Drupal\commerce_add_to_cart_link\CartLinkTokenInterface
   */
  protected $cartLinkToken;

  /**
   * The wishlist manager.
   *
   * @var \Drupal\commerce_wishlist\WishlistManagerInterface
   */
  protected $wishlistManager;

  /**
   * The wishlist provider.
   *
   * @var \Drupal\commerce_wishlist\WishlistProviderInterface
   */
  protected $wishlistProvider;

  /**
   * The path validator.
   *
   * @var \Drupal\Core\Path\PathValidatorInterface
   */
  protected $pathValidator;

  /**
   * Constructs a new AddToWishlistController object.
   *
   * @param \Drupal\commerce_add_to_cart_link\CartLinkTokenInterface $cart_link_token
   *   The cart link token service.
   * @param \Drupal\commerce_wishlist\WishlistManagerInterface $wishlist_manager
   *   The wishlist manager.
   * @param \Drupal\commerce_wishlist\WishlistProviderInterface $wishlist_provider
   *   The wishlist provider.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   The path validator.
   */
  public function __construct(CartLinkTokenInterface $cart_link_token, WishlistManagerInterface $wishlist_manager, WishlistProviderInterface $wishlist_provider, PathValidatorInterface $path_validator) {
    $this->cartLinkToken = $cart_link_token;
    $this->wishlistManager = $wishlist_manager;
    $this->wishlistProvider = $wishlist_provider;
    $this->pathValidator = $path_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('commerce_add_to_cart_link.token'), $container
      ->get('commerce_wishlist.wishlist_manager'), $container
      ->get('commerce_wishlist.wishlist_provider'), $container
      ->get('path.validator'));
  }

  /**
   * Performs the add to wishlist action and redirects to wishlist.
   *
   * @param \Drupal\commerce_product\Entity\ProductInterface $commerce_product
   *   The product entity.
   * @param \Drupal\commerce_product\Entity\ProductVariationInterface $commerce_product_variation
   *   The product variation to add.
   * @param string $token
   *   The CSRF token.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect to the wishlist after adding the product.
   *
   * @throws \Exception
   *   When the call to self::selectStore() throws an exception because the
   *   entity can't be purchased from the current store.
   */
  public function action(ProductInterface $commerce_product, ProductVariationInterface $commerce_product_variation, $token, Request $request) {
    $quantity = $request->query
      ->get('quantity', 1);

    // Determine the wishlist type to use.
    $wishlist_type = $this
      ->config('commerce_wishlist.settings')
      ->get('default_type') ?: 'default';
    $wishlist = $this->wishlistProvider
      ->getWishlist($wishlist_type);
    if (!$wishlist) {
      $wishlist = $this->wishlistProvider
        ->createWishlist($wishlist_type);
    }
    $this->wishlistManager
      ->addEntity($wishlist, $commerce_product_variation, $quantity);
    if ($this
      ->config('commerce_add_to_cart_link.settings')
      ->get('redirect_back')) {
      $referer = $request->server
        ->get('HTTP_REFERER');
      $fake_request = Request::create($referer);
      $referer_url = $this->pathValidator
        ->getUrlIfValid($fake_request
        ->getRequestUri());
      if ($referer_url && $referer_url
        ->isRouted() && $referer_url
        ->getRouteName() !== 'user.login') {
        $referer_url
          ->setAbsolute();
        return new RedirectResponse($referer_url
          ->toString());
      }
    }
    return $this
      ->redirect('commerce_wishlist.page');
  }

  /**
   * Access callback for the action route.
   *
   * @param \Drupal\commerce_product\Entity\ProductInterface $commerce_product
   *   The product entity.
   * @param \Drupal\commerce_product\Entity\ProductVariationInterface $commerce_product_variation
   *   The product variation to add.
   * @param string $token
   *   The CSRF token.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(ProductInterface $commerce_product, ProductVariationInterface $commerce_product_variation, $token) {
    if (!$commerce_product
      ->isPublished() || !$commerce_product
      ->access('view')) {

      // If product is disabled or the user has no view access, deny.
      return AccessResult::forbidden();
    }
    if (!$commerce_product_variation
      ->isPublished() || !$commerce_product_variation
      ->access('view')) {

      // If the variation is inactive, deny.
      return AccessResult::forbidden();
    }
    if ((int) $commerce_product
      ->id() !== (int) $commerce_product_variation
      ->getProductId()) {

      // Deny, if the product ID and variation's parent product ID don't match.
      return AccessResult::forbidden();
    }
    return AccessResult::allowedIf($this->cartLinkToken
      ->validate($commerce_product_variation, $token));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddToWishlistController::$cartLinkToken protected property The cart link token service.
AddToWishlistController::$pathValidator protected property The path validator.
AddToWishlistController::$wishlistManager protected property The wishlist manager.
AddToWishlistController::$wishlistProvider protected property The wishlist provider.
AddToWishlistController::access public function Access callback for the action route.
AddToWishlistController::action public function Performs the add to wishlist action and redirects to wishlist.
AddToWishlistController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
AddToWishlistController::__construct public function Constructs a new AddToWishlistController object.
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::$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::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
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.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.