src/Storefront/Controller/AddressController.php line 55

  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\Log\Package;
  19. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  20. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  21. use Shopware\Core\Framework\Uuid\Uuid;
  22. use Shopware\Core\Framework\Validation\DataBag\DataBag;
  23. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  24. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  25. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  26. use Shopware\Storefront\Page\Address\AddressEditorModalStruct;
  27. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoadedHook;
  28. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoader;
  29. use Shopware\Storefront\Page\Address\Listing\AddressBookWidgetLoadedHook;
  30. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoadedHook;
  31. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoader;
  32. use Symfony\Component\HttpFoundation\RedirectResponse;
  33. use Symfony\Component\HttpFoundation\Request;
  34. use Symfony\Component\HttpFoundation\Response;
  35. use Symfony\Component\Routing\Annotation\Route;
  37. /**
  38.  * @internal
  39.  */
  40. #[Route(defaults: ['_routeScope' => ['storefront']])]
  41. #[Package('storefront')]
  42. class AddressController extends StorefrontController
  43. {
  44.     private const ADDRESS_TYPE_BILLING = 'billing';
  45.     private const ADDRESS_TYPE_SHIPPING = 'shipping';
  47.     /**
  48.      * @internal
  49.      */
  50.     public function __construct(private readonly AddressListingPageLoader $addressListingPageLoader, private readonly AddressDetailPageLoader $addressDetailPageLoader, private readonly AccountService $accountService, private readonly AbstractListAddressRoute $listAddressRoute, private readonly AbstractUpsertAddressRoute $updateAddressRoute, private readonly AbstractDeleteAddressRoute $deleteAddressRoute, private readonly AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute)
  51.     {
  52.     }
  54.     #[Route(path: '/account/address', name: 'frontend.account.address.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  55.     public function accountAddressOverview(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  56.     {
  57.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  59.         $this->hook(new AddressListingPageLoadedHook($page, $context));
  61.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/index.html.twig', ['page' => $page]);
  62.     }
  64.     #[Route(path: '/account/address/create', name: 'frontend.account.address.create.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  65.     public function accountCreateAddress(Request $request, RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  66.     {
  67.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  69.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  71.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/create.html.twig', [
  72.             'page' => $page,
  73.             'data' => $data,
  74.         ]);
  75.     }
  77.     #[Route(path: '/account/address/{addressId}', name: 'frontend.account.address.edit.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  78.     public function accountEditAddress(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  79.     {
  80.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  82.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  84.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/edit.html.twig', ['page' => $page]);
  85.     }
  87.     #[Route(path: '/account/address/default-{type}/{addressId}', name: 'frontend.account.address.set-default-address', defaults: ['_loginRequired' => true], methods: ['POST'])]
  88.     public function switchDefaultAddress(string $type, string $addressId, SalesChannelContext $context, CustomerEntity $customer): RedirectResponse
  89.     {
  90.         if (!Uuid::isValid($addressId)) {
  91.             throw new InvalidUuidException($addressId);
  92.         }
  94.         $success = true;
  96.         try {
  97.             if ($type === self::ADDRESS_TYPE_SHIPPING) {
  98.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  99.             } elseif ($type === self::ADDRESS_TYPE_BILLING) {
  100.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  101.             } else {
  102.                 $success = false;
  103.             }
  104.         } catch (AddressNotFoundException) {
  105.             $success = false;
  106.         }
  108.         return new RedirectResponse(
  109.             $this->generateUrl('frontend.account.address.page', ['changedDefaultAddress' => $success])
  110.         );
  111.     }
  113.     #[Route(path: '/account/address/delete/{addressId}', name: 'frontend.account.address.delete', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  114.     public function deleteAddress(string $addressId, SalesChannelContext $context, CustomerEntity $customer): Response
  115.     {
  116.         $success = true;
  118.         if (!$addressId) {
  119.             throw new MissingRequestParameterException('addressId');
  120.         }
  122.         try {
  123.             $this->deleteAddressRoute->delete($addressId, $context, $customer);
  124.         } catch (InvalidUuidException | AddressNotFoundException | CannotDeleteDefaultAddressException) {
  125.             $success = false;
  126.         }
  128.         return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressDeleted' => $success]));
  129.     }
  131.     #[Route(path: '/account/address/create', name: 'frontend.account.address.create', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  132.     #[Route(path: '/account/address/{addressId}', name: 'frontend.account.address.edit.save', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  133.     public function saveAddress(RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  134.     {
  135.         /** @var RequestDataBag $address */
  136.         $address = $data->get('address');
  138.         try {
  139.             $this->updateAddressRoute->upsert(
  140.                 $address->get('id'),
  141.                 $address->toRequestDataBag(),
  142.                 $context,
  143.                 $customer
  144.             );
  146.             return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressSaved' => true]));
  147.         } catch (ConstraintViolationException $formViolations) {
  148.         }
  150.         if (!$address->get('id')) {
  151.             return $this->forwardToRoute('frontend.account.address.create.page', ['formViolations' => $formViolations]);
  152.         }
  154.         return $this->forwardToRoute(
  155.             'frontend.account.address.edit.page',
  156.             ['formViolations' => $formViolations],
  157.             ['addressId' => $address->get('id')]
  158.         );
  159.     }
  161.     #[Route(path: '/widgets/account/address-book', name: 'frontend.account.addressbook', options: ['seo' => true], defaults: ['XmlHttpRequest' => true, '_loginRequired' => true, '_loginRequiredAllowGuest' => true], methods: ['POST'])]
  162.     public function addressBook(Request $request, RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): Response
  163.     {
  164.         $viewData = new AddressEditorModalStruct();
  165.         $params = [];
  167.         try {
  168.             $this->handleChangeableAddresses($viewData, $dataBag, $context, $customer);
  169.             $this->handleAddressCreation($viewData, $dataBag, $context, $customer);
  170.             $this->handleAddressSelection($viewData, $dataBag, $context, $customer);
  172.             $page = $this->addressListingPageLoader->load($request, $context, $customer);
  174.             $this->hook(new AddressBookWidgetLoadedHook($page, $context));
  176.             $viewData->setPage($page);
  177.             $this->handleCustomerVatIds($dataBag, $context, $customer);
  178.         } catch (ConstraintViolationException $formViolations) {
  179.             $params['formViolations'] = $formViolations;
  180.             $params['postedData'] = $dataBag->get('address');
  181.         } catch (\Exception) {
  182.             $viewData->setSuccess(false);
  183.             $viewData->setMessages([
  184.                 'type' => self::DANGER,
  185.                 'text' => $this->trans('error.message-default'),
  186.             ]);
  187.         }
  189.         if ($request->get('redirectTo') || $request->get('forwardTo')) {
  190.             return $this->createActionResponse($request);
  191.         }
  192.         $params = array_merge($params, $viewData->getVars());
  194.         $response = $this->renderStorefront(
  195.             '@Storefront/storefront/component/address/address-editor-modal.html.twig',
  196.             $params
  197.         );
  199.         $response->headers->set('x-robots-tag', 'noindex');
  201.         return $response;
  202.     }
  204.     private function handleAddressCreation(
  205.         AddressEditorModalStruct $viewData,
  206.         RequestDataBag $dataBag,
  207.         SalesChannelContext $context,
  208.         CustomerEntity $customer
  209.     ): void {
  210.         /** @var DataBag|null $addressData */
  211.         $addressData = $dataBag->get('address');
  213.         if ($addressData === null) {
  214.             return;
  215.         }
  217.         $response = $this->updateAddressRoute->upsert(
  218.             $addressData->get('id'),
  219.             $addressData->toRequestDataBag(),
  220.             $context,
  221.             $customer
  222.         );
  224.         $addressId = $response->getAddress()->getId();
  226.         $addressType = null;
  228.         if ($viewData->isChangeBilling()) {
  229.             $addressType = self::ADDRESS_TYPE_BILLING;
  230.         } elseif ($viewData->isChangeShipping()) {
  231.             $addressType = self::ADDRESS_TYPE_SHIPPING;
  232.         }
  234.         // prepare data to set newly created address as customers default
  235.         if ($addressType) {
  236.             $dataBag->set('selectAddress', new RequestDataBag([
  237.                 'id' => $addressId,
  238.                 'type' => $addressType,
  239.             ]));
  240.         }
  242.         $viewData->setAddressId($addressId);
  243.         $viewData->setSuccess(true);
  244.         $viewData->setMessages(['type' => 'success', 'text' => $this->trans('account.addressSaved')]);
  245.     }
  247.     private function handleChangeableAddresses(
  248.         AddressEditorModalStruct $viewData,
  249.         RequestDataBag $dataBag,
  250.         SalesChannelContext $context,
  251.         CustomerEntity $customer
  252.     ): void {
  253.         $changeableAddresses = $dataBag->get('changeableAddresses');
  255.         if ($changeableAddresses === null) {
  256.             return;
  257.         }
  259.         $viewData->setChangeShipping((bool) $changeableAddresses->get('changeShipping'));
  260.         $viewData->setChangeBilling((bool) $changeableAddresses->get('changeBilling'));
  262.         $addressId = $dataBag->get('id');
  264.         if (!$addressId) {
  265.             return;
  266.         }
  268.         $viewData->setAddress($this->getById($addressId, $context, $customer));
  269.     }
  271.     /**
  272.      * @throws CustomerNotLoggedInException
  273.      * @throws InvalidUuidException
  274.      */
  275.     private function handleAddressSelection(
  276.         AddressEditorModalStruct $viewData,
  277.         RequestDataBag $dataBag,
  278.         SalesChannelContext $context,
  279.         CustomerEntity $customer
  280.     ): void {
  281.         $selectedAddress = $dataBag->get('selectAddress');
  283.         if ($selectedAddress === null) {
  284.             return;
  285.         }
  287.         $addressType = $selectedAddress->get('type');
  288.         $addressId = $selectedAddress->get('id');
  290.         if (!Uuid::isValid($addressId)) {
  291.             throw new InvalidUuidException($addressId);
  292.         }
  294.         $success = true;
  296.         try {
  297.             if ($addressType === self::ADDRESS_TYPE_SHIPPING) {
  298.                 $address = $this->getById($addressId, $context, $customer);
  299.                 $customer->setDefaultShippingAddress($address);
  300.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  301.             } elseif ($addressType === self::ADDRESS_TYPE_BILLING) {
  302.                 $address = $this->getById($addressId, $context, $customer);
  303.                 $customer->setDefaultBillingAddress($address);
  304.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  305.             } else {
  306.                 $success = false;
  307.             }
  308.         } catch (AddressNotFoundException) {
  309.             $success = false;
  310.         }
  312.         if ($success) {
  313.             $this->addFlash(self::SUCCESS, $this->trans('account.addressDefaultChanged'));
  314.         } else {
  315.             $this->addFlash(self::DANGER, $this->trans('account.addressDefaultNotChanged'));
  316.         }
  318.         $viewData->setSuccess($success);
  319.     }
  321.     private function getById(string $addressId, SalesChannelContext $context, CustomerEntity $customer): CustomerAddressEntity
  322.     {
  323.         if (!Uuid::isValid($addressId)) {
  324.             throw new InvalidUuidException($addressId);
  325.         }
  327.         $criteria = new Criteria();
  328.         $criteria->addFilter(new EqualsFilter('id', $addressId));
  329.         $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  331.         $address = $this->listAddressRoute->load($criteria, $context, $customer)->getAddressCollection()->get($addressId);
  333.         if (!$address) {
  334.             throw new AddressNotFoundException($addressId);
  335.         }
  337.         return $address;
  338.     }
  340.     private function handleCustomerVatIds(RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): void
  341.     {
  342.         if (!$dataBag->has('vatIds')) {
  343.             return;
  344.         }
  346.         $newVatIds = $dataBag->get('vatIds')->all();
  347.         $oldVatIds = $customer->getVatIds() ?? [];
  348.         if (!array_diff($newVatIds, $oldVatIds) && !array_diff($oldVatIds, $newVatIds)) {
  349.             return;
  350.         }
  352.         $dataCustomer = CustomerTransformer::transform($customer);
  353.         $dataCustomer['vatIds'] = $newVatIds;
  354.         $dataCustomer['accountType'] = $customer->getCompany() === null ? CustomerEntity::ACCOUNT_TYPE_PRIVATE : CustomerEntity::ACCOUNT_TYPE_BUSINESS;
  356.         $newDataBag = new RequestDataBag($dataCustomer);
  358.         $this->updateCustomerProfileRoute->change($newDataBag, $context, $customer);
  359.     }
  360. }