vendor/shopware/platform/src/Storefront/Controller/AddressController.php line 86

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.  * @Route(defaults={"_routeScope"={"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.      * @Route("/account/address", name="frontend.account.address.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  84.      * @NoStore
  85.      */
  86.     public function accountAddressOverview(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  87.     {
  88.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  90.         $this->hook(new AddressListingPageLoadedHook($page, $context));
  92.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/index.html.twig', ['page' => $page]);
  93.     }
  95.     /**
  96.      * @Since("6.0.0.0")
  97.      * @Route("/account/address/create", name="frontend.account.address.create.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  98.      * @NoStore
  99.      */
  100.     public function accountCreateAddress(Request $request, RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  101.     {
  102.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  104.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  106.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/create.html.twig', [
  107.             'page' => $page,
  108.             'data' => $data,
  109.         ]);
  110.     }
  112.     /**
  113.      * @Since("6.0.0.0")
  114.      * @Route("/account/address/{addressId}", name="frontend.account.address.edit.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  115.      * @NoStore
  116.      */
  117.     public function accountEditAddress(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  118.     {
  119.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  121.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  123.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/edit.html.twig', ['page' => $page]);
  124.     }
  126.     /**
  127.      * @Since("6.0.0.0")
  128.      * @Route("/account/address/default-{type}/{addressId}", name="frontend.account.address.set-default-address", methods={"POST"}, defaults={"_loginRequired"=true})
  129.      */
  130.     public function switchDefaultAddress(string $type, string $addressId, SalesChannelContext $context, CustomerEntity $customer): RedirectResponse
  131.     {
  132.         if (!Uuid::isValid($addressId)) {
  133.             throw new InvalidUuidException($addressId);
  134.         }
  136.         $success = true;
  138.         try {
  139.             if ($type === self::ADDRESS_TYPE_SHIPPING) {
  140.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  141.             } elseif ($type === self::ADDRESS_TYPE_BILLING) {
  142.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  143.             } else {
  144.                 $success = false;
  145.             }
  146.         } catch (AddressNotFoundException $exception) {
  147.             $success = false;
  148.         }
  150.         return new RedirectResponse(
  151.             $this->generateUrl('frontend.account.address.page', ['changedDefaultAddress' => $success])
  152.         );
  153.     }
  155.     /**
  156.      * @Since("6.0.0.0")
  157.      * @Route("/account/address/delete/{addressId}", name="frontend.account.address.delete", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  158.      */
  159.     public function deleteAddress(string $addressId, SalesChannelContext $context, CustomerEntity $customer): Response
  160.     {
  161.         $success = true;
  163.         if (!$addressId) {
  164.             throw new MissingRequestParameterException('addressId');
  165.         }
  167.         try {
  168.             $this->deleteAddressRoute->delete($addressId, $context, $customer);
  169.         } catch (InvalidUuidException | AddressNotFoundException | CannotDeleteDefaultAddressException $exception) {
  170.             $success = false;
  171.         }
  173.         return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressDeleted' => $success]));
  174.     }
  176.     /**
  177.      * @Since("6.0.0.0")
  178.      * @Route("/account/address/create", name="frontend.account.address.create", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  179.      * @Route("/account/address/{addressId}", name="frontend.account.address.edit.save", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  180.      */
  181.     public function saveAddress(RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  182.     {
  183.         /** @var RequestDataBag $address */
  184.         $address = $data->get('address');
  186.         try {
  187.             $this->updateAddressRoute->upsert(
  188.                 $address->get('id'),
  189.                 $address->toRequestDataBag(),
  190.                 $context,
  191.                 $customer
  192.             );
  194.             return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressSaved' => true]));
  195.         } catch (ConstraintViolationException $formViolations) {
  196.         }
  198.         if (!$address->get('id')) {
  199.             return $this->forwardToRoute('frontend.account.address.create.page', ['formViolations' => $formViolations]);
  200.         }
  202.         return $this->forwardToRoute(
  203.             'frontend.account.address.edit.page',
  204.             ['formViolations' => $formViolations],
  205.             ['addressId' => $address->get('id')]
  206.         );
  207.     }
  209.     /**
  210.      * @Since("6.0.0.0")
  211.      * @Route("/widgets/account/address-book", name="frontend.account.addressbook", options={"seo"=true}, methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true, "_loginRequiredAllowGuest"=true})
  212.      */
  213.     public function addressBook(Request $request, RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): Response
  214.     {
  215.         $viewData = new AddressEditorModalStruct();
  216.         $this->handleChangeableAddresses($viewData, $dataBag, $context, $customer);
  217.         $this->handleAddressCreation($viewData, $dataBag, $context, $customer);
  218.         $this->handleAddressSelection($viewData, $dataBag, $context, $customer);
  220.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  222.         $this->hook(new AddressBookWidgetLoadedHook($page, $context));
  224.         $viewData->setPage($page);
  225.         if (Feature::isActive('FEATURE_NEXT_15957')) {
  226.             $this->handleCustomerVatIds($dataBag, $context, $customer);
  227.         }
  229.         if ($request->get('redirectTo') || $request->get('forwardTo')) {
  230.             return $this->createActionResponse($request);
  231.         }
  233.         $response = $this->renderStorefront(
  234.             '@Storefront/storefront/component/address/address-editor-modal.html.twig',
  235.             $viewData->getVars()
  236.         );
  238.         $response->headers->set('x-robots-tag', 'noindex');
  240.         return $response;
  241.     }
  243.     private function handleAddressCreation(
  244.         AddressEditorModalStruct $viewData,
  245.         RequestDataBag $dataBag,
  246.         SalesChannelContext $context,
  247.         CustomerEntity $customer
  248.     ): void {
  249.         /** @var DataBag|null $addressData */
  250.         $addressData = $dataBag->get('address');
  251.         $addressId = null;
  253.         if ($addressData === null) {
  254.             return;
  255.         }
  257.         try {
  258.             $response = $this->updateAddressRoute->upsert(
  259.                 $addressData->get('id'),
  260.                 $addressData->toRequestDataBag(),
  261.                 $context,
  262.                 $customer
  263.             );
  265.             $addressId = $response->getAddress()->getId();
  267.             $addressType = null;
  269.             if ($viewData->isChangeBilling()) {
  270.                 $addressType = self::ADDRESS_TYPE_BILLING;
  271.             } elseif ($viewData->isChangeShipping()) {
  272.                 $addressType = self::ADDRESS_TYPE_SHIPPING;
  273.             }
  275.             // prepare data to set newly created address as customers default
  276.             if ($addressType) {
  277.                 $dataBag->set('selectAddress', new RequestDataBag([
  278.                     'id' => $addressId,
  279.                     'type' => $addressType,
  280.                 ]));
  281.             }
  283.             $success = true;
  284.             $messages = ['type' => 'success', 'text' => $this->trans('account.addressSaved')];
  285.         } catch (\Exception $exception) {
  286.             $success = false;
  287.             $messages = ['type' => 'danger', 'text' => $this->trans('error.message-default')];
  288.         }
  290.         $viewData->setAddressId($addressId);
  291.         $viewData->setSuccess($success);
  292.         $viewData->setMessages($messages);
  293.     }
  295.     private function handleChangeableAddresses(
  296.         AddressEditorModalStruct $viewData,
  297.         RequestDataBag $dataBag,
  298.         SalesChannelContext $context,
  299.         CustomerEntity $customer
  300.     ): void {
  301.         $changeableAddresses = $dataBag->get('changeableAddresses');
  303.         if ($changeableAddresses === null) {
  304.             return;
  305.         }
  307.         $viewData->setChangeShipping((bool) $changeableAddresses->get('changeShipping'));
  308.         $viewData->setChangeBilling((bool) $changeableAddresses->get('changeBilling'));
  310.         $addressId = $dataBag->get('id');
  312.         if (!$addressId) {
  313.             return;
  314.         }
  316.         $viewData->setAddress($this->getById($addressId, $context, $customer));
  317.     }
  319.     /**
  320.      * @throws CustomerNotLoggedInException
  321.      * @throws InvalidUuidException
  322.      */
  323.     private function handleAddressSelection(
  324.         AddressEditorModalStruct $viewData,
  325.         RequestDataBag $dataBag,
  326.         SalesChannelContext $context,
  327.         CustomerEntity $customer
  328.     ): void {
  329.         $selectedAddress = $dataBag->get('selectAddress');
  331.         if ($selectedAddress === null) {
  332.             return;
  333.         }
  335.         $addressType = $selectedAddress->get('type');
  336.         $addressId = $selectedAddress->get('id');
  338.         if (!Uuid::isValid($addressId)) {
  339.             throw new InvalidUuidException($addressId);
  340.         }
  342.         $success = true;
  344.         try {
  345.             if ($addressType === self::ADDRESS_TYPE_SHIPPING) {
  346.                 $address = $this->getById($addressId, $context, $customer);
  347.                 $context->getCustomer()->setDefaultShippingAddress($address);
  348.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  349.             } elseif ($addressType === self::ADDRESS_TYPE_BILLING) {
  350.                 $address = $this->getById($addressId, $context, $customer);
  351.                 $context->getCustomer()->setDefaultBillingAddress($address);
  352.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  353.             } else {
  354.                 $success = false;
  355.             }
  356.         } catch (AddressNotFoundException $exception) {
  357.             $success = false;
  358.         }
  360.         if ($success) {
  361.             $this->addFlash(self::SUCCESS, $this->trans('account.addressDefaultChanged'));
  362.         } else {
  363.             $this->addFlash(self::DANGER, $this->trans('account.addressDefaultNotChanged'));
  364.         }
  366.         $viewData->setSuccess($success);
  367.     }
  369.     private function getById(string $addressId, SalesChannelContext $context, CustomerEntity $customer): CustomerAddressEntity
  370.     {
  371.         if (!Uuid::isValid($addressId)) {
  372.             throw new InvalidUuidException($addressId);
  373.         }
  375.         $criteria = new Criteria();
  376.         $criteria->addFilter(new EqualsFilter('id', $addressId));
  377.         $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  379.         $address = $this->listAddressRoute->load($criteria, $context, $customer)->getAddressCollection()->get($addressId);
  381.         if (!$address) {
  382.             throw new AddressNotFoundException($addressId);
  383.         }
  385.         return $address;
  386.     }
  388.     private function handleCustomerVatIds(RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): void
  389.     {
  390.         if (!$dataBag->has('vatIds')) {
  391.             return;
  392.         }
  394.         $newVatIds = $dataBag->get('vatIds')->all();
  395.         $oldVatIds = $customer->getVatIds() ?? [];
  396.         if (!array_diff($newVatIds, $oldVatIds) && !array_diff($oldVatIds, $newVatIds)) {
  397.             return;
  398.         }
  400.         $dataCustomer = CustomerTransformer::transform($customer);
  401.         $dataCustomer['vatIds'] = $newVatIds;
  402.         $dataCustomer['accountType'] = $customer->getCompany() === null ? CustomerEntity::ACCOUNT_TYPE_PRIVATE : CustomerEntity::ACCOUNT_TYPE_BUSINESS;
  404.         $newDataBag = new RequestDataBag($dataCustomer);
  406.         $this->updateCustomerProfileRoute->change($newDataBag, $context, $customer);
  407.     }
  408. }