vendor/shopware/storefront/Controller/AddressController.php line 89

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Checkout\Cart\Exception\CustomerNotLoggedInException;
  6. use Shopware\Core\Checkout\Cart\Order\Transformer\CustomerTransformer;
  7. use Shopware\Core\Checkout\Customer\Aggregate\CustomerAddress\CustomerAddressEntity;
  8. use Shopware\Core\Checkout\Customer\CustomerEntity;
  9. use Shopware\Core\Checkout\Customer\Exception\AddressNotFoundException;
  10. use Shopware\Core\Checkout\Customer\Exception\CannotDeleteDefaultAddressException;
  11. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractChangeCustomerProfileRoute;
  12. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractDeleteAddressRoute;
  13. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractListAddressRoute;
  14. use Shopware\Core\Checkout\Customer\SalesChannel\AbstractUpsertAddressRoute;
  15. use Shopware\Core\Checkout\Customer\SalesChannel\AccountService;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  18. use Shopware\Core\Framework\Feature;
  19. use Shopware\Core\Framework\Routing\Annotation\LoginRequired;
  20. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  21. use Shopware\Core\Framework\Routing\Annotation\Since;
  22. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  23. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  24. use Shopware\Core\Framework\Uuid\Uuid;
  25. use Shopware\Core\Framework\Validation\DataBag\DataBag;
  26. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  27. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  28. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  29. use Shopware\Storefront\Framework\Routing\Annotation\NoStore;
  30. use Shopware\Storefront\Page\Address\AddressEditorModalStruct;
  31. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoadedHook;
  32. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoader;
  33. use Shopware\Storefront\Page\Address\Listing\AddressBookWidgetLoadedHook;
  34. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoadedHook;
  35. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoader;
  36. use Symfony\Component\HttpFoundation\RedirectResponse;
  37. use Symfony\Component\HttpFoundation\Request;
  38. use Symfony\Component\HttpFoundation\Response;
  39. use Symfony\Component\Routing\Annotation\Route;
  41. /**
  42.  * @RouteScope(scopes={"storefront"})
  43.  */
  44. class AddressController extends StorefrontController
  45. {
  46.     private const ADDRESS_TYPE_BILLING = 'billing';
  47.     private const ADDRESS_TYPE_SHIPPING = 'shipping';
  49.     private AccountService $accountService;
  51.     private AddressListingPageLoader $addressListingPageLoader;
  53.     private AddressDetailPageLoader $addressDetailPageLoader;
  55.     private AbstractListAddressRoute $listAddressRoute;
  57.     private AbstractUpsertAddressRoute $updateAddressRoute;
  59.     private AbstractDeleteAddressRoute $deleteAddressRoute;
  61.     private AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute;
  63.     public function __construct(
  64.         AddressListingPageLoader $addressListingPageLoader,
  65.         AddressDetailPageLoader $addressDetailPageLoader,
  66.         AccountService $accountService,
  67.         AbstractListAddressRoute $listAddressRoute,
  68.         AbstractUpsertAddressRoute $updateAddressRoute,
  69.         AbstractDeleteAddressRoute $deleteAddressRoute,
  70.         AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute
  71.     ) {
  72.         $this->accountService = $accountService;
  73.         $this->addressListingPageLoader = $addressListingPageLoader;
  74.         $this->addressDetailPageLoader = $addressDetailPageLoader;
  75.         $this->listAddressRoute = $listAddressRoute;
  76.         $this->updateAddressRoute = $updateAddressRoute;
  77.         $this->deleteAddressRoute = $deleteAddressRoute;
  78.         $this->updateCustomerProfileRoute = $updateCustomerProfileRoute;
  79.     }
  81.     /**
  82.      * @Since("6.0.0.0")
  83.      * @LoginRequired()
  84.      * @Route("/account/address", name="frontend.account.address.page", options={"seo"="false"}, methods={"GET"})
  85.      * @NoStore
  86.      *
  87.      * @throws CustomerNotLoggedInException
  88.      */
  89.     public function accountAddressOverview(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  90.     {
  91.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  93.         $this->hook(new AddressListingPageLoadedHook($page, $context));
  95.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/index.html.twig', ['page' => $page]);
  96.     }
  98.     /**
  99.      * @Since("6.0.0.0")
  100.      * @LoginRequired()
  101.      * @Route("/account/address/create", name="frontend.account.address.create.page", options={"seo"="false"}, methods={"GET"})
  102.      * @NoStore
  103.      *
  104.      * @throws CustomerNotLoggedInException
  105.      */
  106.     public function accountCreateAddress(Request $request, RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  107.     {
  108.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  110.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  112.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/create.html.twig', [
  113.             'page' => $page,
  114.             'data' => $data,
  115.         ]);
  116.     }
  118.     /**
  119.      * @Since("6.0.0.0")
  120.      * @LoginRequired()
  121.      * @Route("/account/address/{addressId}", name="frontend.account.address.edit.page", options={"seo"="false"}, methods={"GET"})
  122.      * @NoStore
  123.      *
  124.      * @throws CustomerNotLoggedInException
  125.      */
  126.     public function accountEditAddress(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  127.     {
  128.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  130.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  132.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/edit.html.twig', ['page' => $page]);
  133.     }
  135.     /**
  136.      * @Since("6.0.0.0")
  137.      * @LoginRequired()
  138.      * @Route("/account/address/default-{type}/{addressId}", name="frontend.account.address.set-default-address", methods={"POST"})
  139.      *
  140.      * @throws CustomerNotLoggedInException
  141.      * @throws InvalidUuidException
  142.      */
  143.     public function switchDefaultAddress(string $type, string $addressId, SalesChannelContext $context, CustomerEntity $customer): RedirectResponse
  144.     {
  145.         if (!Uuid::isValid($addressId)) {
  146.             throw new InvalidUuidException($addressId);
  147.         }
  149.         $success = true;
  151.         try {
  152.             if ($type === self::ADDRESS_TYPE_SHIPPING) {
  153.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  154.             } elseif ($type === self::ADDRESS_TYPE_BILLING) {
  155.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  156.             } else {
  157.                 $success = false;
  158.             }
  159.         } catch (AddressNotFoundException $exception) {
  160.             $success = false;
  161.         }
  163.         return new RedirectResponse(
  164.             $this->generateUrl('frontend.account.address.page', ['changedDefaultAddress' => $success])
  165.         );
  166.     }
  168.     /**
  169.      * @Since("6.0.0.0")
  170.      * @LoginRequired()
  171.      * @Route("/account/address/delete/{addressId}", name="frontend.account.address.delete", options={"seo"="false"}, methods={"POST"})
  172.      *
  173.      * @throws CustomerNotLoggedInException
  174.      */
  175.     public function deleteAddress(string $addressId, SalesChannelContext $context, CustomerEntity $customer): Response
  176.     {
  177.         $success = true;
  179.         if (!$addressId) {
  180.             throw new MissingRequestParameterException('addressId');
  181.         }
  183.         try {
  184.             $this->deleteAddressRoute->delete($addressId, $context, $customer);
  185.         } catch (InvalidUuidException | AddressNotFoundException | CannotDeleteDefaultAddressException $exception) {
  186.             $success = false;
  187.         }
  189.         return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressDeleted' => $success]));
  190.     }
  192.     /**
  193.      * @Since("6.0.0.0")
  194.      * @LoginRequired()
  195.      * @Route("/account/address/create", name="frontend.account.address.create", options={"seo"="false"}, methods={"POST"})
  196.      * @Route("/account/address/{addressId}", name="frontend.account.address.edit.save", options={"seo"="false"}, methods={"POST"})
  197.      *
  198.      * @throws CustomerNotLoggedInException
  199.      */
  200.     public function saveAddress(RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  201.     {
  202.         /** @var RequestDataBag $address */
  203.         $address = $data->get('address');
  205.         try {
  206.             $this->updateAddressRoute->upsert(
  207.                 $address->get('id'),
  208.                 $address->toRequestDataBag(),
  209.                 $context,
  210.                 $customer
  211.             );
  213.             return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressSaved' => true]));
  214.         } catch (ConstraintViolationException $formViolations) {
  215.         }
  217.         if (!$address->get('id')) {
  218.             return $this->forwardToRoute('frontend.account.address.create.page', ['formViolations' => $formViolations]);
  219.         }
  221.         return $this->forwardToRoute(
  222.             'frontend.account.address.edit.page',
  223.             ['formViolations' => $formViolations],
  224.             ['addressId' => $address->get('id')]
  225.         );
  226.     }
  228.     /**
  229.      * @Since("6.0.0.0")
  230.      * @LoginRequired(allowGuest=true)
  231.      * @Route("/widgets/account/address-book", name="frontend.account.addressbook", options={"seo"=true}, methods={"POST"}, defaults={"XmlHttpRequest"=true})
  232.      */
  233.     public function addressBook(Request $request, RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): Response
  234.     {
  235.         $viewData = new AddressEditorModalStruct();
  236.         $this->handleChangeableAddresses($viewData, $dataBag, $context, $customer);
  237.         $this->handleAddressCreation($viewData, $dataBag, $context, $customer);
  238.         $this->handleAddressSelection($viewData, $dataBag, $context, $customer);
  240.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  242.         $this->hook(new AddressBookWidgetLoadedHook($page, $context));
  244.         $viewData->setPage($page);
  245.         if (Feature::isActive('FEATURE_NEXT_15957')) {
  246.             $this->handleCustomerVatIds($dataBag, $context, $customer);
  247.         }
  249.         if ($request->get('redirectTo') || $request->get('forwardTo')) {
  250.             return $this->createActionResponse($request);
  251.         }
  253.         $response = $this->renderStorefront(
  254.             '@Storefront/storefront/component/address/address-editor-modal.html.twig',
  255.             $viewData->getVars()
  256.         );
  258.         $response->headers->set('x-robots-tag', 'noindex');
  260.         return $response;
  261.     }
  263.     private function handleAddressCreation(
  264.         AddressEditorModalStruct $viewData,
  265.         RequestDataBag $dataBag,
  266.         SalesChannelContext $context,
  267.         CustomerEntity $customer
  268.     ): void {
  269.         /** @var DataBag|null $addressData */
  270.         $addressData = $dataBag->get('address');
  271.         $addressId = null;
  273.         if ($addressData === null) {
  274.             return;
  275.         }
  277.         try {
  278.             $response = $this->updateAddressRoute->upsert(
  279.                 $addressData->get('id'),
  280.                 $addressData->toRequestDataBag(),
  281.                 $context,
  282.                 $customer
  283.             );
  285.             $addressId = $response->getAddress()->getId();
  287.             $addressType = null;
  289.             if ($viewData->isChangeBilling()) {
  290.                 $addressType = self::ADDRESS_TYPE_BILLING;
  291.             } elseif ($viewData->isChangeShipping()) {
  292.                 $addressType = self::ADDRESS_TYPE_SHIPPING;
  293.             }
  295.             // prepare data to set newly created address as customers default
  296.             if ($addressType) {
  297.                 $dataBag->set('selectAddress', new RequestDataBag([
  298.                     'id' => $addressId,
  299.                     'type' => $addressType,
  300.                 ]));
  301.             }
  303.             $success = true;
  304.             $messages = ['type' => 'success', 'text' => $this->trans('account.addressSaved')];
  305.         } catch (\Exception $exception) {
  306.             $success = false;
  307.             $messages = ['type' => 'danger', 'text' => $this->trans('error.message-default')];
  308.         }
  310.         $viewData->setAddressId($addressId);
  311.         $viewData->setSuccess($success);
  312.         $viewData->setMessages($messages);
  313.     }
  315.     private function handleChangeableAddresses(
  316.         AddressEditorModalStruct $viewData,
  317.         RequestDataBag $dataBag,
  318.         SalesChannelContext $context,
  319.         CustomerEntity $customer
  320.     ): void {
  321.         $changeableAddresses = $dataBag->get('changeableAddresses');
  323.         if ($changeableAddresses === null) {
  324.             return;
  325.         }
  327.         $viewData->setChangeShipping((bool) $changeableAddresses->get('changeShipping'));
  328.         $viewData->setChangeBilling((bool) $changeableAddresses->get('changeBilling'));
  330.         $addressId = $dataBag->get('id');
  332.         if (!$addressId) {
  333.             return;
  334.         }
  336.         $viewData->setAddress($this->getById($addressId, $context, $customer));
  337.     }
  339.     /**
  340.      * @throws CustomerNotLoggedInException
  341.      * @throws InvalidUuidException
  342.      */
  343.     private function handleAddressSelection(
  344.         AddressEditorModalStruct $viewData,
  345.         RequestDataBag $dataBag,
  346.         SalesChannelContext $context,
  347.         CustomerEntity $customer
  348.     ): void {
  349.         $selectedAddress = $dataBag->get('selectAddress');
  351.         if ($selectedAddress === null) {
  352.             return;
  353.         }
  355.         $addressType = $selectedAddress->get('type');
  356.         $addressId = $selectedAddress->get('id');
  358.         if (!Uuid::isValid($addressId)) {
  359.             throw new InvalidUuidException($addressId);
  360.         }
  362.         $success = true;
  364.         try {
  365.             if ($addressType === self::ADDRESS_TYPE_SHIPPING) {
  366.                 $address = $this->getById($addressId, $context, $customer);
  367.                 $context->getCustomer()->setDefaultShippingAddress($address);
  368.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  369.             } elseif ($addressType === self::ADDRESS_TYPE_BILLING) {
  370.                 $address = $this->getById($addressId, $context, $customer);
  371.                 $context->getCustomer()->setDefaultBillingAddress($address);
  372.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  373.             } else {
  374.                 $success = false;
  375.             }
  376.         } catch (AddressNotFoundException $exception) {
  377.             $success = false;
  378.         }
  380.         if ($success) {
  381.             $this->addFlash(self::SUCCESS, $this->trans('account.addressDefaultChanged'));
  382.         } else {
  383.             $this->addFlash(self::DANGER, $this->trans('account.addressDefaultNotChanged'));
  384.         }
  386.         $viewData->setSuccess($success);
  387.     }
  389.     private function getById(string $addressId, SalesChannelContext $context, CustomerEntity $customer): CustomerAddressEntity
  390.     {
  391.         if (!Uuid::isValid($addressId)) {
  392.             throw new InvalidUuidException($addressId);
  393.         }
  395.         $criteria = new Criteria();
  396.         $criteria->addFilter(new EqualsFilter('id', $addressId));
  397.         $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  399.         $address = $this->listAddressRoute->load($criteria, $context, $customer)->getAddressCollection()->get($addressId);
  401.         if (!$address) {
  402.             throw new AddressNotFoundException($addressId);
  403.         }
  405.         return $address;
  406.     }
  408.     private function handleCustomerVatIds(RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): void
  409.     {
  410.         if (!$dataBag->has('vatIds')) {
  411.             return;
  412.         }
  414.         $newVatIds = $dataBag->get('vatIds')->all();
  415.         $oldVatIds = $customer->getVatIds() ?? [];
  416.         if (!array_diff($newVatIds, $oldVatIds) && !array_diff($oldVatIds, $newVatIds)) {
  417.             return;
  418.         }
  420.         $dataCustomer = CustomerTransformer::transform($customer);
  421.         $dataCustomer['vatIds'] = $newVatIds;
  422.         $dataCustomer['accountType'] = $customer->getCompany() === null ? CustomerEntity::ACCOUNT_TYPE_PRIVATE : CustomerEntity::ACCOUNT_TYPE_BUSINESS;
  424.         $newDataBag = new RequestDataBag($dataCustomer);
  426.         $this->updateCustomerProfileRoute->change($newDataBag, $context, $customer);
  427.     }
  428. }