<?php declare(strict_types=1);
namespace Shopware\Storefront\Controller;
use Shopware\Core\Checkout\Customer\CustomerEntity;
use Shopware\Core\Checkout\Customer\Exception\CustomerWishlistNotFoundException;
use Shopware\Core\Checkout\Customer\Exception\DuplicateWishlistProductException;
use Shopware\Core\Checkout\Customer\SalesChannel\AbstractAddWishlistProductRoute;
use Shopware\Core\Checkout\Customer\SalesChannel\AbstractLoadWishlistRoute;
use Shopware\Core\Checkout\Customer\SalesChannel\AbstractMergeWishlistProductRoute;
use Shopware\Core\Checkout\Customer\SalesChannel\AbstractRemoveWishlistProductRoute;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
use Shopware\Core\Framework\Log\Package;
use Shopware\Core\Framework\Routing\Annotation\LoginRequired;
use Shopware\Core\Framework\Routing\Annotation\RouteScope;
use Shopware\Core\Framework\Routing\Annotation\Since;
use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
use Shopware\Core\System\SalesChannel\SalesChannelContext;
use Shopware\Storefront\Framework\Routing\Annotation\NoStore;
use Shopware\Storefront\Page\Wishlist\GuestWishlistPageLoadedHook;
use Shopware\Storefront\Page\Wishlist\GuestWishlistPageLoader;
use Shopware\Storefront\Page\Wishlist\WishlistPageLoadedHook;
use Shopware\Storefront\Page\Wishlist\WishlistPageLoader;
use Shopware\Storefront\Page\Wishlist\WishListPageProductCriteriaEvent;
use Shopware\Storefront\Page\Wishlist\WishlistWidgetLoadedHook;
use Shopware\Storefront\Pagelet\Wishlist\GuestWishlistPageletLoadedHook;
use Shopware\Storefront\Pagelet\Wishlist\GuestWishlistPageletLoader;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
/**
* @Route(defaults={"_routeScope"={"storefront"}})
*
* @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
*/
#[Package('storefront')]
class WishlistController extends StorefrontController
{
private WishlistPageLoader $wishlistPageLoader;
private AbstractLoadWishlistRoute $wishlistLoadRoute;
private AbstractAddWishlistProductRoute $addWishlistRoute;
private AbstractRemoveWishlistProductRoute $removeWishlistProductRoute;
private AbstractMergeWishlistProductRoute $mergeWishlistProductRoute;
private GuestWishlistPageLoader $guestPageLoader;
private GuestWishlistPageletLoader $guestPageletLoader;
private EventDispatcherInterface $eventDispatcher;
/**
* @internal
*/
public function __construct(
WishlistPageLoader $wishlistPageLoader,
AbstractLoadWishlistRoute $wishlistLoadRoute,
AbstractAddWishlistProductRoute $addWishlistRoute,
AbstractRemoveWishlistProductRoute $removeWishlistProductRoute,
AbstractMergeWishlistProductRoute $mergeWishlistProductRoute,
GuestWishlistPageLoader $guestPageLoader,
GuestWishlistPageletLoader $guestPageletLoader,
EventDispatcherInterface $eventDispatcher
) {
$this->wishlistPageLoader = $wishlistPageLoader;
$this->wishlistLoadRoute = $wishlistLoadRoute;
$this->addWishlistRoute = $addWishlistRoute;
$this->removeWishlistProductRoute = $removeWishlistProductRoute;
$this->mergeWishlistProductRoute = $mergeWishlistProductRoute;
$this->guestPageLoader = $guestPageLoader;
$this->guestPageletLoader = $guestPageletLoader;
$this->eventDispatcher = $eventDispatcher;
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist", name="frontend.wishlist.page", options={"seo"="false"}, methods={"GET"})
* @NoStore
*/
public function index(Request $request, SalesChannelContext $context): Response
{
$customer = $context->getCustomer();
if ($customer !== null && $customer->getGuest() === false) {
$page = $this->wishlistPageLoader->load($request, $context, $customer);
$this->hook(new WishlistPageLoadedHook($page, $context));
} else {
$page = $this->guestPageLoader->load($request, $context);
$this->hook(new GuestWishlistPageLoadedHook($page, $context));
}
return $this->renderStorefront('@Storefront/storefront/page/wishlist/index.html.twig', ['page' => $page]);
}
/**
* @Since("6.3.5.0")
* @Route("/wishlist/guest-pagelet", name="frontend.wishlist.guestPage.pagelet", options={"seo"="false"}, methods={"POST"}, defaults={"XmlHttpRequest"=true})
*/
public function guestPagelet(Request $request, SalesChannelContext $context): Response
{
$customer = $context->getCustomer();
if ($customer !== null && $customer->getGuest() === false) {
throw new NotFoundHttpException();
}
$pagelet = $this->guestPageletLoader->load($request, $context);
$this->hook(new GuestWishlistPageletLoadedHook($pagelet, $context));
return $this->renderStorefront(
'@Storefront/storefront/page/wishlist/wishlist-pagelet.html.twig',
['page' => $pagelet, 'searchResult' => $pagelet->getSearchResult()->getObject()]
);
}
/**
* @Since("6.3.4.0")
* @Route("/widgets/wishlist", name="widgets.wishlist.pagelet", options={"seo"="false"}, methods={"GET", "POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxPagination(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
{
$request->request->set('no-aggregations', true);
$page = $this->wishlistPageLoader->load($request, $context, $customer);
$this->hook(new WishlistPageLoadedHook($page, $context));
$response = $this->renderStorefront('@Storefront/storefront/page/wishlist/index.html.twig', ['page' => $page]);
$response->headers->set('x-robots-tag', 'noindex');
return $response;
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/list", name="frontend.wishlist.product.list", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxList(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
{
$criteria = new Criteria();
$this->eventDispatcher->dispatch(new WishListPageProductCriteriaEvent($criteria, $context, $request));
try {
$res = $this->wishlistLoadRoute->load($request, $context, $criteria, $customer);
} catch (CustomerWishlistNotFoundException $exception) {
return new JsonResponse([]);
}
return new JsonResponse($res->getProductListing()->getIds());
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/product/delete/{id}", name="frontend.wishlist.product.delete", methods={"POST", "DELETE"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function remove(string $id, Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
{
if (!$id) {
throw new MissingRequestParameterException('Parameter id missing');
}
try {
$this->removeWishlistProductRoute->delete($id, $context, $customer);
$this->addFlash(self::SUCCESS, $this->trans('wishlist.itemDeleteSuccess'));
} catch (\Throwable $exception) {
$this->addFlash(self::DANGER, $this->trans('error.message-default'));
}
return $this->createActionResponse($request);
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/add/{productId}", name="frontend.wishlist.product.add", options={"seo"="false"}, methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxAdd(string $productId, SalesChannelContext $context, CustomerEntity $customer): JsonResponse
{
try {
$this->addWishlistRoute->add($productId, $context, $customer);
$success = true;
} catch (\Throwable $exception) {
$success = false;
}
return new JsonResponse([
'success' => $success,
]);
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/remove/{productId}", name="frontend.wishlist.product.remove", options={"seo"="false"}, methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxRemove(string $productId, SalesChannelContext $context, CustomerEntity $customer): JsonResponse
{
try {
$this->removeWishlistProductRoute->delete($productId, $context, $customer);
$success = true;
} catch (\Throwable $exception) {
$success = false;
}
return new JsonResponse([
'success' => $success,
]);
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/add-after-login/{productId}", name="frontend.wishlist.add.after.login", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
*/
public function addAfterLogin(string $productId, SalesChannelContext $context, CustomerEntity $customer): Response
{
try {
$this->addWishlistRoute->add($productId, $context, $customer);
$this->addFlash(self::SUCCESS, $this->trans('wishlist.itemAddedSuccess'));
} catch (DuplicateWishlistProductException $exception) {
$this->addFlash(self::WARNING, $this->trans('wishlist.duplicateItemError'));
} catch (\Throwable $exception) {
$this->addFlash(self::DANGER, $this->trans('error.message-default'));
}
return $this->redirectToRoute('frontend.home.page');
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/merge", name="frontend.wishlist.product.merge", options={"seo"="false"}, methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxMerge(RequestDataBag $requestDataBag, Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
{
try {
$this->mergeWishlistProductRoute->merge($requestDataBag, $context, $customer);
return $this->renderStorefront('@Storefront/storefront/utilities/alert.html.twig', [
'type' => 'info', 'content' => $this->trans('wishlist.wishlistMergeHint'),
]);
} catch (\Throwable $exception) {
$this->addFlash(self::DANGER, $this->trans('error.message-default'));
}
return $this->createActionResponse($request);
}
/**
* @Since("6.3.4.0")
* @Route("/wishlist/merge/pagelet", name="frontend.wishlist.product.merge.pagelet", methods={"GET", "POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true})
*/
public function ajaxPagelet(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
{
$request->request->set('no-aggregations', true);
$page = $this->wishlistPageLoader->load($request, $context, $customer);
$this->hook(new WishlistWidgetLoadedHook($page, $context));
return $this->renderStorefront('@Storefront/storefront/page/wishlist/wishlist-pagelet.html.twig', [
'page' => $page,
'searchResult' => $page->getWishlist()->getProductListing(),
]);
}
}