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

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\Log\Package;
  20. use Shopware\Core\Framework\Routing\Annotation\LoginRequired;
  21. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  22. use Shopware\Core\Framework\Routing\Annotation\Since;
  23. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  24. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  25. use Shopware\Core\Framework\Uuid\Uuid;
  26. use Shopware\Core\Framework\Validation\DataBag\DataBag;
  27. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  28. use Shopware\Core\Framework\Validation\Exception\ConstraintViolationException;
  29. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  30. use Shopware\Storefront\Framework\Routing\Annotation\NoStore;
  31. use Shopware\Storefront\Page\Address\AddressEditorModalStruct;
  32. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoadedHook;
  33. use Shopware\Storefront\Page\Address\Detail\AddressDetailPageLoader;
  34. use Shopware\Storefront\Page\Address\Listing\AddressBookWidgetLoadedHook;
  35. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoadedHook;
  36. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoader;
  37. use Symfony\Component\HttpFoundation\RedirectResponse;
  38. use Symfony\Component\HttpFoundation\Request;
  39. use Symfony\Component\HttpFoundation\Response;
  40. use Symfony\Component\Routing\Annotation\Route;
  42. /**
  43. * @Route(defaults={"_routeScope"={"storefront"}})
  44. *
  45. * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  46. */
  47. #[Package('storefront')]
  48. class AddressController extends StorefrontController
  49. {
  50. private const ADDRESS_TYPE_BILLING = 'billing';
  51. private const ADDRESS_TYPE_SHIPPING = 'shipping';
  53. private AccountService $accountService;
  55. private AddressListingPageLoader $addressListingPageLoader;
  57. private AddressDetailPageLoader $addressDetailPageLoader;
  59. private AbstractListAddressRoute $listAddressRoute;
  61. private AbstractUpsertAddressRoute $updateAddressRoute;
  63. private AbstractDeleteAddressRoute $deleteAddressRoute;
  65. private AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute;
  67. /**
  68. * @internal
  69. */
  70. public function __construct(
  71. AddressListingPageLoader $addressListingPageLoader,
  72. AddressDetailPageLoader $addressDetailPageLoader,
  73. AccountService $accountService,
  74. AbstractListAddressRoute $listAddressRoute,
  75. AbstractUpsertAddressRoute $updateAddressRoute,
  76. AbstractDeleteAddressRoute $deleteAddressRoute,
  77. AbstractChangeCustomerProfileRoute $updateCustomerProfileRoute
  78. ) {
  79. $this->accountService = $accountService;
  80. $this->addressListingPageLoader = $addressListingPageLoader;
  81. $this->addressDetailPageLoader = $addressDetailPageLoader;
  82. $this->listAddressRoute = $listAddressRoute;
  83. $this->updateAddressRoute = $updateAddressRoute;
  84. $this->deleteAddressRoute = $deleteAddressRoute;
  85. $this->updateCustomerProfileRoute = $updateCustomerProfileRoute;
  86. }
  88. /**
  89. * @Since("6.0.0.0")
  90. * @Route("/account/address", name="frontend.account.address.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  91. * @NoStore
  92. */
  93. public function accountAddressOverview(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  94. {
  95. $page = $this->addressListingPageLoader->load($request, $context, $customer);
  97. $this->hook(new AddressListingPageLoadedHook($page, $context));
  99. return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/index.html.twig', ['page' => $page]);
  100. }
  102. /**
  103. * @Since("6.0.0.0")
  104. * @Route("/account/address/create", name="frontend.account.address.create.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  105. * @NoStore
  106. */
  107. public function accountCreateAddress(Request $request, RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  108. {
  109. $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  111. $this->hook(new AddressDetailPageLoadedHook($page, $context));
  113. return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/create.html.twig', [
  114. 'page' => $page,
  115. 'data' => $data,
  116. ]);
  117. }
  119. /**
  120. * @Since("6.0.0.0")
  121. * @Route("/account/address/{addressId}", name="frontend.account.address.edit.page", options={"seo"="false"}, methods={"GET"}, defaults={"_loginRequired"=true})
  122. * @NoStore
  123. */
  124. public function accountEditAddress(Request $request, SalesChannelContext $context, CustomerEntity $customer): Response
  125. {
  126. $page = $this->addressDetailPageLoader->load($request, $context, $customer);
  128. $this->hook(new AddressDetailPageLoadedHook($page, $context));
  130. return $this->renderStorefront('@Storefront/storefront/page/account/addressbook/edit.html.twig', ['page' => $page]);
  131. }
  133. /**
  134. * @Since("6.0.0.0")
  135. * @Route("/account/address/default-{type}/{addressId}", name="frontend.account.address.set-default-address", methods={"POST"}, defaults={"_loginRequired"=true})
  136. */
  137. public function switchDefaultAddress(string $type, string $addressId, SalesChannelContext $context, CustomerEntity $customer): RedirectResponse
  138. {
  139. if (!Uuid::isValid($addressId)) {
  140. throw new InvalidUuidException($addressId);
  141. }
  143. $success = true;
  145. try {
  146. if ($type === self::ADDRESS_TYPE_SHIPPING) {
  147. $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  148. } elseif ($type === self::ADDRESS_TYPE_BILLING) {
  149. $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  150. } else {
  151. $success = false;
  152. }
  153. } catch (AddressNotFoundException $exception) {
  154. $success = false;
  155. }
  157. return new RedirectResponse(
  158. $this->generateUrl('frontend.account.address.page', ['changedDefaultAddress' => $success])
  159. );
  160. }
  162. /**
  163. * @Since("6.0.0.0")
  164. * @Route("/account/address/delete/{addressId}", name="frontend.account.address.delete", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  165. */
  166. public function deleteAddress(string $addressId, SalesChannelContext $context, CustomerEntity $customer): Response
  167. {
  168. $success = true;
  170. if (!$addressId) {
  171. throw new MissingRequestParameterException('addressId');
  172. }
  174. try {
  175. $this->deleteAddressRoute->delete($addressId, $context, $customer);
  176. } catch (InvalidUuidException | AddressNotFoundException | CannotDeleteDefaultAddressException $exception) {
  177. $success = false;
  178. }
  180. return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressDeleted' => $success]));
  181. }
  183. /**
  184. * @Since("6.0.0.0")
  185. * @Route("/account/address/create", name="frontend.account.address.create", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  186. * @Route("/account/address/{addressId}", name="frontend.account.address.edit.save", options={"seo"="false"}, methods={"POST"}, defaults={"_loginRequired"=true})
  187. */
  188. public function saveAddress(RequestDataBag $data, SalesChannelContext $context, CustomerEntity $customer): Response
  189. {
  190. /** @var RequestDataBag $address */
  191. $address = $data->get('address');
  193. try {
  194. $this->updateAddressRoute->upsert(
  195. $address->get('id'),
  196. $address->toRequestDataBag(),
  197. $context,
  198. $customer
  199. );
  201. return new RedirectResponse($this->generateUrl('frontend.account.address.page', ['addressSaved' => true]));
  202. } catch (ConstraintViolationException $formViolations) {
  203. }
  205. if (!$address->get('id')) {
  206. return $this->forwardToRoute('frontend.account.address.create.page', ['formViolations' => $formViolations]);
  207. }
  209. return $this->forwardToRoute(
  210. 'frontend.account.address.edit.page',
  211. ['formViolations' => $formViolations],
  212. ['addressId' => $address->get('id')]
  213. );
  214. }
  216. /**
  217. * @Since("6.0.0.0")
  218. * @Route("/widgets/account/address-book", name="frontend.account.addressbook", options={"seo"=true}, methods={"POST"}, defaults={"XmlHttpRequest"=true, "_loginRequired"=true, "_loginRequiredAllowGuest"=true})
  219. */
  220. public function addressBook(Request $request, RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): Response
  221. {
  222. $viewData = new AddressEditorModalStruct();
  223. $params = [];
  225. try {
  226. $this->handleChangeableAddresses($viewData, $dataBag, $context, $customer);
  227. $this->handleAddressCreation($viewData, $dataBag, $context, $customer);
  228. $this->handleAddressSelection($viewData, $dataBag, $context, $customer);
  230. $page = $this->addressListingPageLoader->load($request, $context, $customer);
  232. $this->hook(new AddressBookWidgetLoadedHook($page, $context));
  234. $viewData->setPage($page);
  235. if (Feature::isActive('FEATURE_NEXT_15957')) {
  236. $this->handleCustomerVatIds($dataBag, $context, $customer);
  237. }
  238. } catch (ConstraintViolationException $formViolations) {
  239. $params['formViolations'] = $formViolations;
  240. $params['postedData'] = $dataBag->get('address');
  241. } catch (\Exception $exception) {
  242. $viewData->setSuccess(false);
  243. $viewData->setMessages([
  244. 'type' => self::DANGER,
  245. 'text' => $this->trans('error.message-default'),
  246. ]);
  247. }
  249. if ($request->get('redirectTo') || $request->get('forwardTo')) {
  250. return $this->createActionResponse($request);
  251. }
  252. $params = array_merge($params, $viewData->getVars());
  254. $response = $this->renderStorefront(
  255. '@Storefront/storefront/component/address/address-editor-modal.html.twig',
  256. $params
  257. );
  259. $response->headers->set('x-robots-tag', 'noindex');
  261. return $response;
  262. }
  264. private function handleAddressCreation(
  265. AddressEditorModalStruct $viewData,
  266. RequestDataBag $dataBag,
  267. SalesChannelContext $context,
  268. CustomerEntity $customer
  269. ): void {
  270. /** @var DataBag|null $addressData */
  271. $addressData = $dataBag->get('address');
  273. if ($addressData === null) {
  274. return;
  275. }
  277. $response = $this->updateAddressRoute->upsert(
  278. $addressData->get('id'),
  279. $addressData->toRequestDataBag(),
  280. $context,
  281. $customer
  282. );
  284. $addressId = $response->getAddress()->getId();
  286. $addressType = null;
  288. if ($viewData->isChangeBilling()) {
  289. $addressType = self::ADDRESS_TYPE_BILLING;
  290. } elseif ($viewData->isChangeShipping()) {
  291. $addressType = self::ADDRESS_TYPE_SHIPPING;
  292. }
  294. // prepare data to set newly created address as customers default
  295. if ($addressType) {
  296. $dataBag->set('selectAddress', new RequestDataBag([
  297. 'id' => $addressId,
  298. 'type' => $addressType,
  299. ]));
  300. }
  302. $viewData->setAddressId($addressId);
  303. $viewData->setSuccess(true);
  304. $viewData->setMessages(['type' => 'success', 'text' => $this->trans('account.addressSaved')]);
  305. }
  307. private function handleChangeableAddresses(
  308. AddressEditorModalStruct $viewData,
  309. RequestDataBag $dataBag,
  310. SalesChannelContext $context,
  311. CustomerEntity $customer
  312. ): void {
  313. $changeableAddresses = $dataBag->get('changeableAddresses');
  315. if ($changeableAddresses === null) {
  316. return;
  317. }
  319. $viewData->setChangeShipping((bool) $changeableAddresses->get('changeShipping'));
  320. $viewData->setChangeBilling((bool) $changeableAddresses->get('changeBilling'));
  322. $addressId = $dataBag->get('id');
  324. if (!$addressId) {
  325. return;
  326. }
  328. $viewData->setAddress($this->getById($addressId, $context, $customer));
  329. }
  331. /**
  332. * @throws CustomerNotLoggedInException
  333. * @throws InvalidUuidException
  334. */
  335. private function handleAddressSelection(
  336. AddressEditorModalStruct $viewData,
  337. RequestDataBag $dataBag,
  338. SalesChannelContext $context,
  339. CustomerEntity $customer
  340. ): void {
  341. $selectedAddress = $dataBag->get('selectAddress');
  343. if ($selectedAddress === null) {
  344. return;
  345. }
  347. $addressType = $selectedAddress->get('type');
  348. $addressId = $selectedAddress->get('id');
  350. if (!Uuid::isValid($addressId)) {
  351. throw new InvalidUuidException($addressId);
  352. }
  354. $success = true;
  356. try {
  357. if ($addressType === self::ADDRESS_TYPE_SHIPPING) {
  358. $address = $this->getById($addressId, $context, $customer);
  359. $customer->setDefaultShippingAddress($address);
  360. $this->accountService->setDefaultShippingAddress($addressId, $context, $customer);
  361. } elseif ($addressType === self::ADDRESS_TYPE_BILLING) {
  362. $address = $this->getById($addressId, $context, $customer);
  363. $customer->setDefaultBillingAddress($address);
  364. $this->accountService->setDefaultBillingAddress($addressId, $context, $customer);
  365. } else {
  366. $success = false;
  367. }
  368. } catch (AddressNotFoundException $exception) {
  369. $success = false;
  370. }
  372. if ($success) {
  373. $this->addFlash(self::SUCCESS, $this->trans('account.addressDefaultChanged'));
  374. } else {
  375. $this->addFlash(self::DANGER, $this->trans('account.addressDefaultNotChanged'));
  376. }
  378. $viewData->setSuccess($success);
  379. }
  381. private function getById(string $addressId, SalesChannelContext $context, CustomerEntity $customer): CustomerAddressEntity
  382. {
  383. if (!Uuid::isValid($addressId)) {
  384. throw new InvalidUuidException($addressId);
  385. }
  387. $criteria = new Criteria();
  388. $criteria->addFilter(new EqualsFilter('id', $addressId));
  389. $criteria->addFilter(new EqualsFilter('customerId', $customer->getId()));
  391. $address = $this->listAddressRoute->load($criteria, $context, $customer)->getAddressCollection()->get($addressId);
  393. if (!$address) {
  394. throw new AddressNotFoundException($addressId);
  395. }
  397. return $address;
  398. }
  400. private function handleCustomerVatIds(RequestDataBag $dataBag, SalesChannelContext $context, CustomerEntity $customer): void
  401. {
  402. if (!$dataBag->has('vatIds')) {
  403. return;
  404. }
  406. $newVatIds = $dataBag->get('vatIds')->all();
  407. $oldVatIds = $customer->getVatIds() ?? [];
  408. if (!array_diff($newVatIds, $oldVatIds) && !array_diff($oldVatIds, $newVatIds)) {
  409. return;
  410. }
  412. $dataCustomer = CustomerTransformer::transform($customer);
  413. $dataCustomer['vatIds'] = $newVatIds;
  414. $dataCustomer['accountType'] = $customer->getCompany() === null ? CustomerEntity::ACCOUNT_TYPE_PRIVATE : CustomerEntity::ACCOUNT_TYPE_BUSINESS;
  416. $newDataBag = new RequestDataBag($dataCustomer);
  418. $this->updateCustomerProfileRoute->change($newDataBag, $context, $customer);
  419. }
  420. }