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

  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.  * Do not use direct or indirect repository calls in a controller. Always use a store-api route to get or put data
  40.  */
  41. #[Route(defaults: ['_routeScope' => ['storefront']])]
  42. #[Package('storefront')]
  43. class AddressController extends StorefrontController
  44. {
  45.     private const ADDRESS_TYPE_BILLING = 'billing';
  46.     private const ADDRESS_TYPE_SHIPPING = 'shipping';
  48.     /**
  49.      * @internal
  50.      */
  51.     public function __construct(
  52.         private readonly AddressListingPageLoader $addressListingPageLoader,
  53.         private readonly AddressDetailPageLoader $addressDetailPageLoader,
  54.         private readonly AccountService $accountService,
  55.         private readonly AbstractListAddressRoute $listAddressRoute,
  56.         private readonly AbstractUpsertAddressRoute $updateAddressRoute,
  57.         private readonly AbstractDeleteAddressRoute $deleteAddressRoute,
  58.         private readonly AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute
  59.     ) {
  60.     }
  62.     #[Route(path: '/account/address', name: 'frontend.account.address.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  63.     public function accountAddressOverview(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  64.     {
  65.         $page = $this->addressListingPageLoader->load($request, $context, $customer);
  67.         $this->hook(new AddressListingPageLoadedHook($page, $context));
  69.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/index.html.twig', ['page' => $page]);
  70.     }
  72.     #[Route(path: '/account/address/create', name: 'frontend.account.address.create.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  73.     public function accountCreateAddress(Request $request, RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  74.     {
  75.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  77.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  79.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/create.html.twig', [
  80.             'page' => $page,
  81.             'data' => $data,
  82.         ]);
  83.     }
  85.     #[Route(path: '/account/address/{addressId}', name: 'frontend.account.address.edit.page', options: ['seo' => false], defaults: ['_loginRequired' => true, '_noStore' => true], methods: ['GET'])]
  86.     public function accountEditAddress(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  87.     {
  88.         $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  90.         $this->hook(new AddressDetailPageLoadedHook($page, $context));
  92.         return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/edit.html.twig', ['page' => $page]);
  93.     }
  95.     #[Route(path: '/account/address/default-{type}/{addressId}', name: 'frontend.account.address.set-default-address', defaults: ['_loginRequired' => true], methods: ['POST'])]
  96.     public function switchDefaultAddress(string $type, string $addressId, SalesChannelContext $context, CustomerEntity $customer): RedirectResponse
  97.     {
  98.         if (!Uuid::isValid($addressId)) {
  99.             throw new InvalidUuidException($addressId);
  100.         }
  102.         $success = true;
  104.         try {
  105.             if ($type === self::ADDRESS_TYPE_SHIPPING) {
  106.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  107.             } elseif ($type === self::ADDRESS_TYPE_BILLING) {
  108.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  109.             } else {
  110.                 $success = false;
  111.             }
  112.         } catch (AddressNotFoundException) {
  113.             $success = false;
  114.         }
  116.         return new RedirectResponse(
  117.             $this->generateUrl('frontend.account.address.page', ['changedDefaultAddress' => $success])
  118.         );
  119.     }
  121.     #[Route(path: '/account/address/delete/{addressId}', name: 'frontend.account.address.delete', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  122.     public function deleteAddress(string $addressId, SalesChannelContext $context, CustomerEntity $customer): Response
  123.     {
  124.         $success = true;
  126.         if (!$addressId) {
  127.             throw new MissingRequestParameterException('addressId');
  128.         }
  130.         try {
  131.             $this->deleteAddressRoute->delete($addressId, $context, $customer);
  132.         } catch (InvalidUuidException | AddressNotFoundException | CannotDeleteDefaultAddressException) {
  133.             $success = false;
  134.         }
  136.         return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressDeleted' => $success]));
  137.     }
  139.     #[Route(path: '/account/address/create', name: 'frontend.account.address.create', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  140.     #[Route(path: '/account/address/{addressId}', name: 'frontend.account.address.edit.save', options: ['seo' => false], defaults: ['_loginRequired' => true], methods: ['POST'])]
  141.     public function saveAddress(RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  142.     {
  143.         /** @var RequestDataBag $address */
  144.         $address = $data->get('address');
  146.         try {
  147.             $this->updateAddressRoute->upsert(
  148.                 $address->get('id'),
  149.                 $address->toRequestDataBag(),
  150.                 $context,
  151.                 $customer
  152.             );
  154.             return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressSaved' => true]));
  155.         } catch (ConstraintViolationException $formViolations) {
  156.         }
  158.         if (!$address->get('id')) {
  159.             return $this->forwardToRoute('frontend.account.address.create.page', ['formViolations' => $formViolations]);
  160.         }
  162.         return $this->forwardToRoute(
  163.             'frontend.account.address.edit.page',
  164.             ['formViolations' => $formViolations],
  165.             ['addressId' => $address->get('id')]
  166.         );
  167.     }
  169.     #[Route(path: '/widgets/account/address-book', name: 'frontend.account.addressbook', options: ['seo' => true], defaults: ['XmlHttpRequest' => true, '_loginRequired' => true, '_loginRequiredAllowGuest' => true], methods: ['POST'])]
  170.     public function addressBook(Request $request, RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): Response
  171.     {
  172.         $viewData = new AddressEditorModalStruct();
  173.         $params = [];
  175.         try {
  176.             $this->handleChangeableAddresses($viewData, $dataBag, $context, $customer);
  177.             $this->handleAddressCreation($viewData, $dataBag, $context, $customer);
  178.             $this->handleAddressSelection($viewData, $dataBag, $context, $customer);
  180.             $page = $this->addressListingPageLoader->load($request, $context, $customer);
  182.             $this->hook(new AddressBookWidgetLoadedHook($page, $context));
  184.             $viewData->setPage($page);
  185.             $this->handleCustomerVatIds($dataBag, $context, $customer);
  186.         } catch (ConstraintViolationException $formViolations) {
  187.             $params['formViolations'] = $formViolations;
  188.             $params['postedData'] = $dataBag->get('address');
  189.         } catch (\Exception) {
  190.             $viewData->setSuccess(false);
  191.             $viewData->setMessages([
  192.                 'type' => self::DANGER,
  193.                 'text' => $this->trans('error.message-default'),
  194.             ]);
  195.         }
  197.         if ($request->get('redirectTo') || $request->get('forwardTo')) {
  198.             return $this->createActionResponse($request);
  199.         }
  200.         $params = array_merge($params, $viewData->getVars());
  202.         $response = $this->renderStorefront(
  203.             '@Storefront/storefront/component/address/address-editor-modal.html.twig',
  204.             $params
  205.         );
  207.         $response->headers->set('x-robots-tag', 'noindex');
  209.         return $response;
  210.     }
  212.     private function handleAddressCreation(
  213.         AddressEditorModalStruct $viewData,
  214.         RequestDataBag $dataBag,
  215.         SalesChannelContext $context,
  216.         CustomerEntity $customer
  217.     ): void {
  218.         /** @var DataBag|null $addressData */
  219.         $addressData = $dataBag->get('address');
  221.         if ($addressData === null) {
  222.             return;
  223.         }
  225.         $response = $this->updateAddressRoute->upsert(
  226.             $addressData->get('id'),
  227.             $addressData->toRequestDataBag(),
  228.             $context,
  229.             $customer
  230.         );
  232.         $addressId = $response->getAddress()->getId();
  234.         $addressType = null;
  236.         if ($viewData->isChangeBilling()) {
  237.             $addressType = self::ADDRESS_TYPE_BILLING;
  238.         } elseif ($viewData->isChangeShipping()) {
  239.             $addressType = self::ADDRESS_TYPE_SHIPPING;
  240.         }
  242.         // prepare data to set newly created address as customers default
  243.         if ($addressType) {
  244.             $dataBag->set('selectAddress', new RequestDataBag([
  245.                 'id' => $addressId,
  246.                 'type' => $addressType,
  247.             ]));
  248.         }
  250.         $viewData->setAddressId($addressId);
  251.         $viewData->setSuccess(true);
  252.         $viewData->setMessages(['type' => 'success', 'text' => $this->trans('account.addressSaved')]);
  253.     }
  255.     private function handleChangeableAddresses(
  256.         AddressEditorModalStruct $viewData,
  257.         RequestDataBag $dataBag,
  258.         SalesChannelContext $context,
  259.         CustomerEntity $customer
  260.     ): void {
  261.         $changeableAddresses = $dataBag->get('changeableAddresses');
  263.         if ($changeableAddresses === null) {
  264.             return;
  265.         }
  267.         $viewData->setChangeShipping((bool) $changeableAddresses->get('changeShipping'));
  268.         $viewData->setChangeBilling((bool) $changeableAddresses->get('changeBilling'));
  270.         $addressId = $dataBag->get('id');
  272.         if (!$addressId) {
  273.             return;
  274.         }
  276.         $viewData->setAddress($this->getById($addressId, $context, $customer));
  277.     }
  279.     /**
  280.      * @throws CustomerNotLoggedInException
  281.      * @throws InvalidUuidException
  282.      */
  283.     private function handleAddressSelection(
  284.         AddressEditorModalStruct $viewData,
  285.         RequestDataBag $dataBag,
  286.         SalesChannelContext $context,
  287.         CustomerEntity $customer
  288.     ): void {
  289.         $selectedAddress = $dataBag->get('selectAddress');
  291.         if ($selectedAddress === null) {
  292.             return;
  293.         }
  295.         $addressType = $selectedAddress->get('type');
  296.         $addressId = $selectedAddress->get('id');
  298.         if (!Uuid::isValid($addressId)) {
  299.             throw new InvalidUuidException($addressId);
  300.         }
  302.         $success = true;
  304.         try {
  305.             if ($addressType === self::ADDRESS_TYPE_SHIPPING) {
  306.                 $address = $this->getById($addressId, $context, $customer);
  307.                 $customer->setDefaultShippingAddress($address);
  308.                 $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  309.             } elseif ($addressType === self::ADDRESS_TYPE_BILLING) {
  310.                 $address = $this->getById($addressId, $context, $customer);
  311.                 $customer->setDefaultBillingAddress($address);
  312.                 $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  313.             } else {
  314.                 $success = false;
  315.             }
  316.         } catch (AddressNotFoundException) {
  317.             $success = false;
  318.         }
  320.         if ($success) {
  321.             $this->addFlash(self::SUCCESS, $this->trans('account.addressDefaultChanged'));
  322.         } else {
  323.             $this->addFlash(self::DANGER, $this->trans('account.addressDefaultNotChanged'));
  324.         }
  326.         $viewData->setSuccess($success);
  327.     }
  329.     private function getById(string $addressId, SalesChannelContext $context, CustomerEntity $customer): CustomerAddressEntity
  330.     {
  331.         if (!Uuid::isValid($addressId)) {
  332.             throw new InvalidUuidException($addressId);
  333.         }
  335.         $criteria = new Criteria();
  336.         $criteria->addFilter(new EqualsFilter('id', $addressId));
  337.         $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  339.         $address = $this->listAddressRoute->load($criteria, $context, $customer)->getAddressCollection()->get($addressId);
  341.         if (!$address) {
  342.             throw new AddressNotFoundException($addressId);
  343.         }
  345.         return $address;
  346.     }
  348.     private function handleCustomerVatIds(RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): void
  349.     {
  350.         if (!$dataBag->has('vatIds')) {
  351.             return;
  352.         }
  354.         $newVatIds = $dataBag->get('vatIds')->all();
  355.         $oldVatIds = $customer->getVatIds() ?? [];
  356.         if (!array_diff($newVatIds, $oldVatIds) && !array_diff($oldVatIds, $newVatIds)) {
  357.             return;
  358.         }
  360.         $dataCustomer = CustomerTransformer::transform($customer);
  361.         $dataCustomer['vatIds'] = $newVatIds;
  362.         $dataCustomer['accountType'] = $customer->getCompany() === null ? CustomerEntity::ACCOUNT_TYPE_PRIVATE : CustomerEntity::ACCOUNT_TYPE_BUSINESS;
  364.         $newDataBag = new RequestDataBag($dataCustomer);
  366.         $this->updateCustomerProfileRoute->change($newDataBag, $context, $customer);
  367.     }
  368. }