vendor/shopware/storefront/Theme/Subscriber/PluginLifecycleSubscriber.php line 62

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Theme\Subscriber;
  5. use Shopware\Core\Framework\Plugin;
  6. use Shopware\Core\Framework\Plugin\Event\PluginPreActivateEvent;
  7. use Shopware\Core\Framework\Plugin\Event\PluginPreDeactivateEvent;
  8. use Shopware\Core\Framework\Plugin\Event\PluginPreUninstallEvent;
  9. use Shopware\Core\Framework\Plugin\Event\PluginPreUpdateEvent;
  10. use Shopware\Storefront\Theme\Exception\InvalidThemeBundleException;
  11. use Shopware\Storefront\Theme\Exception\ThemeCompileException;
  12. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\StorefrontPluginConfiguration;
  13. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\StorefrontPluginConfigurationFactory;
  14. use Shopware\Storefront\Theme\StorefrontPluginRegistryInterface;
  15. use Shopware\Storefront\Theme\ThemeLifecycleHandler;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. class PluginLifecycleSubscriber implements EventSubscriberInterface
  19. {
  20.     /**
  21.      * @var StorefrontPluginRegistryInterface
  22.      */
  23.     private $storefrontPluginRegistry;
  25.     /**
  26.      * @var string
  27.      */
  28.     private $projectDirectory;
  30.     /**
  31.      * @var StorefrontPluginConfigurationFactory
  32.      */
  33.     private $pluginConfigurationFactory;
  35.     /**
  36.      * @var ThemeLifecycleHandler
  37.      */
  38.     private $themeLifecycleHandler;
  40.     public function __construct(
  41.         StorefrontPluginRegistryInterface $storefrontPluginRegistry,
  42.         string $projectDirectory,
  43.         StorefrontPluginConfigurationFactory $pluginConfigurationFactory,
  44.         ThemeLifecycleHandler $themeLifecycleHandler
  45.     ) {
  46.         $this->storefrontPluginRegistry = $storefrontPluginRegistry;
  47.         $this->projectDirectory = $projectDirectory;
  48.         $this->pluginConfigurationFactory = $pluginConfigurationFactory;
  49.         $this->themeLifecycleHandler = $themeLifecycleHandler;
  50.     }
  52.     public static function getSubscribedEvents()
  53.     {
  54.         return [
  55.             PluginPreActivateEvent::class => 'pluginActivate',
  56.             PluginPreUpdateEvent::class => 'pluginUpdate',
  57.             PluginPreDeactivateEvent::class => 'pluginDeactivateAndUninstall',
  58.             PluginPreUninstallEvent::class => 'pluginDeactivateAndUninstall',
  59.         ];
  60.     }
  62.     public function pluginActivate(PluginPreActivateEvent $event): void
  63.     {
  64.         // create instance of the plugin to create a configuration
  65.         // (the kernel boot is already finished and the activated plugin is missing)
  66.         $storefrontPluginConfig = $this->createConfigFromClassName(
  67.             $event->getPlugin()->getPath(),
  68.             $event->getPlugin()->getBaseClass()
  69.         );
  71.         // add plugin configuration to the list of all active plugin configurations
  72.         $configurationCollection = clone $this->storefrontPluginRegistry->getConfigurations();
  73.         $configurationCollection->add($storefrontPluginConfig);
  75.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  76.             $storefrontPluginConfig,
  77.             $configurationCollection,
  78.             $event->getContext()->getContext()
  79.         );
  80.     }
  82.     public function pluginUpdate(PluginPreUpdateEvent $event): void
  83.     {
  84.         $pluginName = $event->getPlugin()->getName();
  85.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  87.         if (!$config) {
  88.             return;
  89.         }
  91.         $this->themeLifecycleHandler->handleThemeInstallOrUpdate(
  92.             $config,
  93.             $this->storefrontPluginRegistry->getConfigurations(),
  94.             $event->getContext()->getContext()
  95.         );
  96.     }
  98.     /**
  99.      * @param PluginPreDeactivateEvent|PluginPreUninstallEvent $event
  100.      */
  101.     public function pluginDeactivateAndUninstall($event): void
  102.     {
  103.         $pluginName = $event->getPlugin()->getName();
  104.         $config = $this->storefrontPluginRegistry->getConfigurations()->getByTechnicalName($pluginName);
  106.         if (!$config) {
  107.             return;
  108.         }
  110.         $this->themeLifecycleHandler->handleThemeUninstall($config, $event->getContext()->getContext());
  111.     }
  113.     /**
  114.      * @throws ThemeCompileException
  115.      * @throws InvalidThemeBundleException
  116.      */
  117.     private function createConfigFromClassName(string $pluginPath, string $className): StorefrontPluginConfiguration
  118.     {
  119.         /** @var Plugin $plugin */
  120.         $plugin = new $className(true, $pluginPath, $this->projectDirectory);
  122.         if (!$plugin instanceof Plugin) {
  123.             throw new \RuntimeException(
  124.                 sprintf('Plugin class "%s" must extend "%s"', \get_class($plugin), Plugin::class)
  125.             );
  126.         }
  128.         return $this->pluginConfigurationFactory->createFromBundle($plugin);
  129.     }
  130. }