vendor/shopware/core/Checkout/Customer/SalesChannel/LogoutRoute.php line 72

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Customer\SalesChannel;
  5. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  6. use Shopware\Core\Checkout\Customer\CustomerEntity;
  7. use Shopware\Core\Checkout\Customer\Event\CustomerLogoutEvent;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  10. use Shopware\Core\Framework\Routing\Annotation\LoginRequired;
  11. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  12. use Shopware\Core\Framework\Routing\Annotation\Since;
  13. use Shopware\Core\Framework\Util\Random;
  14. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  15. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextPersister;
  16. use Shopware\Core\System\SalesChannel\ContextTokenResponse;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Shopware\Core\System\SystemConfig\SystemConfigService;
  19. use Symfony\Component\Routing\Annotation\Route;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. /**
  23.  * @Route(defaults={"_routeScope"={"store-api"}})
  24.  */
  25. #[Package('customer-order')]
  26. class LogoutRoute extends AbstractLogoutRoute
  27. {
  28.     /**
  29.      * @var SalesChannelContextPersister
  30.      */
  31.     private $contextPersister;
  33.     /**
  34.      * @var EventDispatcherInterface
  35.      */
  36.     private $eventDispatcher;
  38.     /**
  39.      * @var SystemConfigService
  40.      */
  41.     private $systemConfig;
  43.     /**
  44.      * @var CartService
  45.      */
  46.     private $cartService;
  48.     /**
  49.      * @internal
  50.      */
  51.     public function __construct(
  52.         SalesChannelContextPersister $contextPersister,
  53.         EventDispatcherInterface $eventDispatcher,
  54.         SystemConfigService $systemConfig,
  55.         CartService $cartService
  56.     ) {
  57.         $this->contextPersister = $contextPersister;
  58.         $this->eventDispatcher = $eventDispatcher;
  59.         $this->systemConfig = $systemConfig;
  60.         $this->cartService = $cartService;
  61.     }
  63.     public function getDecorated(): AbstractLogoutRoute
  64.     {
  65.         throw new DecorationPatternException(self::class);
  66.     }
  68.     /**
  69.      * @Since("6.2.0.0")
  70.      * @Route(path="/store-api/account/logout", name="store-api.account.logout", methods={"POST"}, defaults={"_loginRequired"=true, "_loginRequiredAllowGuest"=true})
  71.      */
  72.     public function logout(SalesChannelContext $context, RequestDataBag $data): ContextTokenResponse
  73.     {
  74.         /** @var CustomerEntity $customer */
  75.         $customer = $context->getCustomer();
  76.         if ($this->shouldDelete($context)) {
  77.             $this->cartService->deleteCart($context);
  78.             $this->contextPersister->delete($context->getToken(), $context->getSalesChannelId());
  80.             $event = new CustomerLogoutEvent($context, $customer);
  81.             $this->eventDispatcher->dispatch($event);
  83.             return new ContextTokenResponse($context->getToken());
  84.         }
  86.         $newToken = Random::getAlphanumericString(32);
  87.         if ((bool) $data->get('replace-token')) {
  88.             $newToken = $this->contextPersister->replace($context->getToken(), $context);
  89.         }
  91.         $context->assign([
  92.             'token' => $newToken,
  93.         ]);
  95.         $event = new CustomerLogoutEvent($context, $customer);
  96.         $this->eventDispatcher->dispatch($event);
  98.         return new ContextTokenResponse($context->getToken());
  99.     }
  101.     private function shouldDelete(SalesChannelContext $context): bool
  102.     {
  103.         $config = $this->systemConfig->get('core.loginRegistration.invalidateSessionOnLogOut', $context->getSalesChannelId());
  105.         if ($config) {
  106.             return true;
  107.         }
  109.         if ($context->getCustomer() === null) {
  110.             return true;
  111.         }
  113.         return $context->getCustomer()->getGuest();
  114.     }
  115. }