NEXT-19598 - Adjust hook class visibilities

changelog/_unreleased/2023-04-26-hook-class-visibilities.md

@@ -0,0 +1,6 @@
+---
+title: Adjusted hook class visibilities
+issue: NEXT-19598
+---
+# Core
+* Changed all abstract Hook classes to be `@internal` and all concrete Hook classes to be `@final`, you should only rely on the concrete hooks and not add hooks yourself.

coding-guidelines/core/decorator-pattern.md

@@ -89,9 +89,6 @@ In this case you should mark the service as follows:
 - if you want that developers can call public functions of your service but should not extend it, mark all classes as `@final`
 
 ```php
-/**
- * @final You can use this service, and we keep the api stable, but you should not extend it
- */
 abstract class AbstractRuleLoader
 {
     abstract public function load(Context $context): RuleCollection;

phpstan.neon.dist

@@ -171,7 +171,6 @@ parameters:
         # Internal deprecations of Shopware are handled in other places
         - '#deprecated.*class Shopware\\#'
         - '#deprecated.*interface Shopware\\#'
-        - '#extends @final class Shopware\\Core\\Framework\\Script\\Execution\\Hook\.#'
 
         - # tests are allowed to add dummy classes in the same file
             message: '#Multiple class\/interface\/trait is not allowed in single file#'

src/Core/Checkout/Cart/AbstractRuleLoader.php

@@ -6,9 +6,6 @@
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\Log\Package;
 
-/**
- * @final
- */
 #[Package('checkout')]
 abstract class AbstractRuleLoader
 {

src/Core/Checkout/Cart/Hook/CartHook.php

@@ -16,6 +16,8 @@
  * @hook-use-case cart_manipulation
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('checkout')]
 class CartHook extends Hook implements CartAware

src/Core/Checkout/Payment/Hook/PaymentMethodRouteHook.php

@@ -14,6 +14,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.5.0.0
+ *
+ * @final
  */
 #[Package('checkout')]
 class PaymentMethodRouteHook extends StoreApiRequestHook

src/Core/Checkout/Shipping/Hook/ShippingMethodRouteHook.php

@@ -14,6 +14,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.5.0.0
+ *
+ * @final
  */
 #[Package('checkout')]
 class ShippingMethodRouteHook extends StoreApiRequestHook

src/Core/Content/Product/Hook/Pricing/ProductPricingHook.php

@@ -17,6 +17,8 @@
  * @hook-use-case product
  *
  * @since 6.5.1.0
+ *
+ * @final
  */
 #[Package('inventory')]
 class ProductPricingHook extends Hook implements SalesChannelContextAware

src/Core/Framework/Adapter/Cache/Script/CacheInvalidationHook.php

@@ -14,6 +14,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class CacheInvalidationHook extends Hook

src/Core/Framework/App/Event/Hooks/AppActivatedHook.php

@@ -12,6 +12,8 @@
  * @hook-use-case app_lifecycle
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class AppActivatedHook extends AppLifecycleHook implements AppSpecificHook

src/Core/Framework/App/Event/Hooks/AppDeactivatedHook.php

@@ -12,6 +12,8 @@
  * @hook-use-case app_lifecycle
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class AppDeactivatedHook extends AppLifecycleHook implements AppSpecificHook

src/Core/Framework/App/Event/Hooks/AppDeletedHook.php

@@ -12,6 +12,8 @@
  * @hook-use-case app_lifecycle
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class AppDeletedHook extends AppLifecycleHook implements AppSpecificHook

src/Core/Framework/App/Event/Hooks/AppInstalledHook.php

@@ -12,6 +12,8 @@
  * @hook-use-case app_lifecycle
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class AppInstalledHook extends AppLifecycleHook implements AppSpecificHook

src/Core/Framework/App/Event/Hooks/AppLifecycleHook.php

@@ -9,7 +9,7 @@
 use Shopware\Core\System\SystemConfig\Facade\SystemConfigFacadeHookFactory;
 
 /**
- * @internal
+ * @internal only rely on the concrete hook implementations
  */
 #[Package('core')]
 abstract class AppLifecycleHook extends Hook

src/Core/Framework/App/Event/Hooks/AppUpdatedHook.php

@@ -12,6 +12,8 @@
  * @hook-use-case app_lifecycle
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class AppUpdatedHook extends AppLifecycleHook implements AppSpecificHook

src/Core/Framework/Script/Api/ApiHook.php

@@ -18,6 +18,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class ApiHook extends Hook implements StoppableHook

src/Core/Framework/Script/Api/StoreApiCacheKeyHook.php

@@ -16,6 +16,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class StoreApiCacheKeyHook extends OptionalFunctionHook implements SalesChannelContextAware, StoppableHook

src/Core/Framework/Script/Api/StoreApiHook.php

@@ -16,6 +16,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class StoreApiHook extends InterfaceHook implements SalesChannelContextAware

src/Core/Framework/Script/Api/StoreApiResponseHook.php

@@ -22,6 +22,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class StoreApiResponseHook extends FunctionHook implements SalesChannelContextAware, StoppableHook

src/Core/Framework/Script/Execution/FunctionHook.php

@@ -5,7 +5,7 @@
 use Shopware\Core\Framework\Log\Package;
 
 /**
- * @internal
+ * @internal only rely on the concrete implementations
  */
 #[Package('core')]
 abstract class FunctionHook extends Hook

src/Core/Framework/Script/Execution/Hook.php

@@ -6,7 +6,7 @@
 use Shopware\Core\Framework\Log\Package;
 
 /**
- * @final
+ * @internal only rely on the concrete hook implementations
  */
 #[Package('core')]
 abstract class Hook

src/Core/Framework/Script/Execution/InterfaceHook.php

@@ -5,7 +5,7 @@
 use Shopware\Core\Framework\Log\Package;
 
 /**
- * @internal
+ * @internal only rely on the concrete implementations
  */
 #[Package('core')]
 abstract class InterfaceHook extends Hook

src/Core/Framework/Script/Execution/OptionalFunctionHook.php

@@ -7,7 +7,7 @@
 /**
  * Marker that a function does not need to be implemented by a script
  *
- * @internal
+ * @internal only rely on the concrete implementations
  */
 #[Package('core')]
 abstract class OptionalFunctionHook extends FunctionHook

src/Core/System/SalesChannel/StoreApiRequestHook.php

@@ -9,6 +9,9 @@
 use Shopware\Core\Framework\Script\Execution\Hook;
 use Shopware\Core\System\SystemConfig\Facade\SystemConfigFacadeHookFactory;
 
+/**
+ * @internal only rely on the concrete implementations
+ */
 #[Package('core')]
 abstract class StoreApiRequestHook extends Hook implements SalesChannelContextAware
 {

src/Storefront/Framework/Script/Api/StorefrontHook.php

@@ -23,6 +23,8 @@
  * @hook-use-case custom_endpoint
  *
  * @since 6.4.9.0
+ *
+ * @final
  */
 #[Package('core')]
 class StorefrontHook extends Hook implements SalesChannelContextAware, StoppableHook

src/Storefront/Page/Account/CustomerGroupRegistration/CustomerGroupRegistrationPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class CustomerGroupRegistrationPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Login/AccountGuestLoginPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountGuestLoginPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Login/AccountLoginPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountLoginPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Order/AccountEditOrderPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountEditOrderPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Order/AccountOrderDetailPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountOrderDetailPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Order/AccountOrderPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountOrderPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Overview/AccountOverviewPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountOverviewPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/PaymentMethod/AccountPaymentMethodPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class AccountPaymentMethodPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Profile/AccountProfilePageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountProfilePageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/RecoverPassword/AccountRecoverPasswordPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.13.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountRecoverPasswordPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Account/Register/AccountRegisterPageLoadedHook.php

@@ -14,6 +14,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('customer-order')]
 class AccountRegisterPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Address/Detail/AddressDetailPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class AddressDetailPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Address/Listing/AddressBookWidgetLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class AddressBookWidgetLoadedHook extends PageLoadedHook

src/Storefront/Page/Address/Listing/AddressListingPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class AddressListingPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Checkout/Cart/CheckoutCartPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class CheckoutCartPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Checkout/Confirm/CheckoutConfirmPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class CheckoutConfirmPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Checkout/Finish/CheckoutFinishPageLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class CheckoutFinishPageLoadedHook extends PageLoadedHook

src/Storefront/Page/Checkout/Offcanvas/CheckoutInfoWidgetLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class CheckoutInfoWidgetLoadedHook extends PageLoadedHook

src/Storefront/Page/Checkout/Offcanvas/CheckoutOffcanvasWidgetLoadedHook.php

@@ -13,6 +13,8 @@
  * @hook-use-case data_loading
  *
  * @since 6.4.8.0
+ *
+ * @final
  */
 #[Package('storefront')]
 class CheckoutOffcanvasWidgetLoadedHook extends PageLoadedHook