From 559840e342ec195f9e9ec83fe84688145eb4fcf0 Mon Sep 17 00:00:00 2001 From: Jan Goralski Date: Fri, 27 Sep 2024 10:13:34 +0200 Subject: [PATCH 1/2] [Maintenance] Remove leftover mentions of master request related methods --- .../EventListener/AdminFilterSubscriber.php | 12 +---- .../ResourceDeleteSubscriber.php | 8 +--- .../CoreBundle/Checkout/CheckoutResolver.php | 8 +--- .../EventListener/XFrameOptionsSubscriber.php | 12 +---- .../NonChannelLocaleListener.php | 8 +--- .../EventListener/SessionCartSubscriber.php | 8 +--- .../NonChannelLocaleListenerSpec.php | 44 ++++--------------- 7 files changed, 14 insertions(+), 86 deletions(-) diff --git a/src/Sylius/Bundle/AdminBundle/EventListener/AdminFilterSubscriber.php b/src/Sylius/Bundle/AdminBundle/EventListener/AdminFilterSubscriber.php index 32305a7e53..2c386de2c2 100644 --- a/src/Sylius/Bundle/AdminBundle/EventListener/AdminFilterSubscriber.php +++ b/src/Sylius/Bundle/AdminBundle/EventListener/AdminFilterSubscriber.php @@ -33,7 +33,7 @@ final class AdminFilterSubscriber implements EventSubscriberInterface public function onKernelRequest(RequestEvent $event): void { - if (!$this->isMainRequest($event)) { + if (!$event->isMainRequest()) { return; } @@ -58,16 +58,6 @@ final class AdminFilterSubscriber implements EventSubscriberInterface } } - private function isMainRequest(RequestEvent $event): bool - { - if (\method_exists($event, 'isMainRequest')) { - return $event->isMainRequest(); - } - - /** @phpstan-ignore-next-line */ - return $event->isMasterRequest(); - } - private function isIndexResourceRoute(string $route): bool { return str_ends_with($route, 'index'); diff --git a/src/Sylius/Bundle/AdminBundle/EventListener/ResourceDeleteSubscriber.php b/src/Sylius/Bundle/AdminBundle/EventListener/ResourceDeleteSubscriber.php index 644ac7d3a2..f175fe3bc0 100644 --- a/src/Sylius/Bundle/AdminBundle/EventListener/ResourceDeleteSubscriber.php +++ b/src/Sylius/Bundle/AdminBundle/EventListener/ResourceDeleteSubscriber.php @@ -46,13 +46,7 @@ final readonly class ResourceDeleteSubscriber implements EventSubscriberInterfac return; } - if (\method_exists($event, 'isMainRequest')) { - $isMainRequest = $event->isMainRequest(); - } else { - /** @phpstan-ignore-next-line */ - $isMainRequest = $event->isMasterRequest(); - } - if (!$isMainRequest || 'html' !== $event->getRequest()->getRequestFormat()) { + if (!$event->isMainRequest() || 'html' !== $event->getRequest()->getRequestFormat()) { return; } diff --git a/src/Sylius/Bundle/CoreBundle/Checkout/CheckoutResolver.php b/src/Sylius/Bundle/CoreBundle/Checkout/CheckoutResolver.php index bea0ed18c6..dfad685102 100644 --- a/src/Sylius/Bundle/CoreBundle/Checkout/CheckoutResolver.php +++ b/src/Sylius/Bundle/CoreBundle/Checkout/CheckoutResolver.php @@ -42,13 +42,7 @@ final class CheckoutResolver implements EventSubscriberInterface public function onKernelRequest(RequestEvent $event): void { - if (\method_exists($event, 'isMainRequest')) { - $isMainRequest = $event->isMainRequest(); - } else { - /** @phpstan-ignore-next-line */ - $isMainRequest = $event->isMasterRequest(); - } - if (!$isMainRequest) { + if (!$event->isMainRequest()) { return; } diff --git a/src/Sylius/Bundle/CoreBundle/EventListener/XFrameOptionsSubscriber.php b/src/Sylius/Bundle/CoreBundle/EventListener/XFrameOptionsSubscriber.php index 920f3bedc0..f7c88afc68 100644 --- a/src/Sylius/Bundle/CoreBundle/EventListener/XFrameOptionsSubscriber.php +++ b/src/Sylius/Bundle/CoreBundle/EventListener/XFrameOptionsSubscriber.php @@ -28,7 +28,7 @@ final class XFrameOptionsSubscriber implements EventSubscriberInterface public function onKernelResponse(ResponseEvent $event): void { - if (!$this->isMainRequest($event)) { + if (!$event->isMainRequest()) { return; } @@ -36,14 +36,4 @@ final class XFrameOptionsSubscriber implements EventSubscriberInterface $response->headers->set('X-Frame-Options', 'sameorigin'); } - - private function isMainRequest(ResponseEvent $event): bool - { - if (\method_exists($event, 'isMainRequest')) { - return $event->isMainRequest(); - } - - /** @phpstan-ignore-next-line */ - return $event->isMasterRequest(); - } } diff --git a/src/Sylius/Bundle/ShopBundle/EventListener/NonChannelLocaleListener.php b/src/Sylius/Bundle/ShopBundle/EventListener/NonChannelLocaleListener.php index 05c2f748cc..6244a67d3c 100644 --- a/src/Sylius/Bundle/ShopBundle/EventListener/NonChannelLocaleListener.php +++ b/src/Sylius/Bundle/ShopBundle/EventListener/NonChannelLocaleListener.php @@ -46,13 +46,7 @@ final class NonChannelLocaleListener */ public function restrictRequestLocale(RequestEvent $event): void { - if (\method_exists($event, 'isMainRequest')) { - $isMainRequest = $event->isMainRequest(); - } else { - /** @phpstan-ignore-next-line */ - $isMainRequest = $event->isMasterRequest(); - } - if (!$isMainRequest) { + if (!$event->isMainRequest()) { return; } diff --git a/src/Sylius/Bundle/ShopBundle/EventListener/SessionCartSubscriber.php b/src/Sylius/Bundle/ShopBundle/EventListener/SessionCartSubscriber.php index 38f7bcc710..34438293c9 100644 --- a/src/Sylius/Bundle/ShopBundle/EventListener/SessionCartSubscriber.php +++ b/src/Sylius/Bundle/ShopBundle/EventListener/SessionCartSubscriber.php @@ -37,13 +37,7 @@ final class SessionCartSubscriber implements EventSubscriberInterface public function onKernelResponse(ResponseEvent $event): void { - if (\method_exists($event, 'isMainRequest')) { - $isMainRequest = $event->isMainRequest(); - } else { - /** @phpstan-ignore-next-line */ - $isMainRequest = $event->isMasterRequest(); - } - if (!$isMainRequest) { + if (!$event->isMainRequest()) { return; } diff --git a/src/Sylius/Bundle/ShopBundle/spec/EventListener/NonChannelLocaleListenerSpec.php b/src/Sylius/Bundle/ShopBundle/spec/EventListener/NonChannelLocaleListenerSpec.php index 79e3935369..e67d663db9 100644 --- a/src/Sylius/Bundle/ShopBundle/spec/EventListener/NonChannelLocaleListenerSpec.php +++ b/src/Sylius/Bundle/ShopBundle/spec/EventListener/NonChannelLocaleListenerSpec.php @@ -62,16 +62,12 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior ; } - function it_does_nothing_if_its_not_a_master_request( + function it_does_nothing_if_its_not_a_main_request( LocaleProviderInterface $localeProvider, FirewallMap $firewallMap, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(false); - } else { - $event->isMasterRequest()->willReturn(false); - } + $event->isMainRequest()->willReturn(false); $event->getRequest()->shouldNotBeCalled(); $firewallMap->getFirewallConfig(Argument::any())->shouldNotBeCalled(); @@ -89,11 +85,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior Request $request, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $firewallMap->getFirewallConfig($request)->willReturn(null); @@ -111,11 +103,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior Request $request, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $firewallMap->getFirewallConfig($request)->willReturn( new FirewallConfig('lalaland', 'mock'), @@ -135,11 +123,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior Request $request, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $firewallMap->getFirewallConfig($request)->willReturn( new FirewallConfig('shop', 'mock'), @@ -161,11 +145,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior Request $request, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $firewallMap->getFirewallConfig($request)->willReturn( new FirewallConfig('shop', 'mock'), @@ -190,11 +170,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior RequestEvent $event, Router $router, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $firewallMap->getFirewallConfig($request)->willReturn( new FirewallConfig('shop', 'mock'), @@ -216,11 +192,7 @@ final class NonChannelLocaleListenerSpec extends ObjectBehavior Request $request, RequestEvent $event, ): void { - if (\method_exists(RequestEvent::class, 'isMainRequest')) { - $event->isMainRequest()->willReturn(true); - } else { - $event->isMasterRequest()->willReturn(true); - } + $event->isMainRequest()->willReturn(true); $event->getRequest()->willReturn($request); $request->getLocale()->willReturn('en'); From 8af0c3025b40229ca78872b1c098b35bade4df7a Mon Sep 17 00:00:00 2001 From: Magdalena Sadowska Date: Fri, 27 Sep 2024 11:14:19 +0200 Subject: [PATCH 2/2] [Docs] Add 2.0-dev installation instructions --- docs/book/installation/installation.rst | 12 ++++++++++++ docs/getting-started-with-sylius/installation.rst | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/book/installation/installation.rst b/docs/book/installation/installation.rst index 8b56b3bf78..42132d72c4 100644 --- a/docs/book/installation/installation.rst +++ b/docs/book/installation/installation.rst @@ -19,6 +19,18 @@ To begin creating your new project, run this command: composer create-project sylius/sylius-standard acme +.. tip:: + + We are about to release a new major version of Sylius, which is going to be 2.0. + Worry not, upgrading from 1.x to 2.x will be possible. + It is currently recommended to start with 1.x and upgrade the project once 2.0 is there, + but if you'd like to start playing around with the still-in-progress version, you can use this command to set the environment + on Sylius 2.0-ALPHA.X/BETA.X. + + .. code-block:: bash + + composer composer create-project --stability=dev sylius/sylius-standard:2.0.x-dev acme + .. note:: Make sure to use PHP ^8.1. Using an older PHP version will result in installing an older version of Sylius. diff --git a/docs/getting-started-with-sylius/installation.rst b/docs/getting-started-with-sylius/installation.rst index 2e1d87b9be..90e2472371 100644 --- a/docs/getting-started-with-sylius/installation.rst +++ b/docs/getting-started-with-sylius/installation.rst @@ -28,6 +28,18 @@ The easiest way to install Sylius on your local machine is to use the following It will create a ``MyFirstShop`` directory with a brand new Sylius application inside. +.. tip:: + + We are about to release a new major version of Sylius, which is going to be 2.0. + Worry not, upgrading from 1.x to 2.x will be possible. + It is currently recommended to start with 1.x and upgrade the project once 2.0 is there, + but if you'd like to start playing around with the still-in-progress version, you can use this command to set the environment + on Sylius 2.0-ALPHA.X/BETA.X. + + .. code-block:: bash + + composer composer create-project --stability=dev sylius/sylius-standard:2.0.x-dev acme + .. note:: Are you familiar with Docker? Check out the :doc:`Sylius Installation Guide with Docker `