vendor/shopware/core/Framework/Plugin.php line 76

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Framework\Parameter\AdditionalBundleParameters;
  7. use Shopware\Core\Framework\Plugin\Context\ActivateContext;
  8. use Shopware\Core\Framework\Plugin\Context\DeactivateContext;
  9. use Shopware\Core\Framework\Plugin\Context\InstallContext;
  10. use Shopware\Core\Framework\Plugin\Context\UninstallContext;
  11. use Shopware\Core\Framework\Plugin\Context\UpdateContext;
  12. use Shopware\Core\Kernel;
  13. use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
  15. #[Package('core')]
  16. abstract class Plugin extends Bundle
  17. {
  18.     /**
  19.      * @var bool
  20.      */
  21.     private $active;
  23.     /**
  24.      * @var string
  25.      */
  26.     private $basePath;
  28.     /**
  29.      * @internal
  30.      */
  31.     final public function __construct(bool $active, string $basePath, ?string $projectDir = null)
  32.     {
  33.         $this->active = $active;
  34.         $this->basePath = $basePath;
  36.         if ($projectDir && mb_strpos($this->basePath, '/') !== 0) {
  37.             $this->basePath = rtrim($projectDir, '/') . '/' . $this->basePath;
  38.         }
  40.         $this->path = $this->computePluginClassPath();
  41.     }
  43.     final public function isActive(): bool
  44.     {
  45.         return $this->active;
  46.     }
  48.     public function install(InstallContext $installContext): void
  49.     {
  50.     }
  52.     public function postInstall(InstallContext $installContext): void
  53.     {
  54.     }
  56.     public function update(UpdateContext $updateContext): void
  57.     {
  58.     }
  60.     public function postUpdate(UpdateContext $updateContext): void
  61.     {
  62.     }
  64.     public function activate(ActivateContext $activateContext): void
  65.     {
  66.     }
  68.     public function deactivate(DeactivateContext $deactivateContext): void
  69.     {
  70.     }
  72.     public function uninstall(UninstallContext $uninstallContext): void
  73.     {
  74.     }
  76.     public function configureRoutes(RoutingConfigurator $routes, string $environment): void
  77.     {
  78.         if (!$this->isActive()) {
  79.             return;
  80.         }
  82.         parent::configureRoutes($routes, $environment);
  83.     }
  85.     /**
  86.      * @return Bundle[]
  87.      */
  88.     public function getAdditionalBundles(AdditionalBundleParameters $parameters): array
  89.     {
  90.         return [];
  91.     }
  93.     /**
  94.      * By default the container is rebuild during plugin activation and deactivation to allow the plugin to access
  95.      * its own services. If you are absolutely sure you do not require this feature for you plugin you might want
  96.      * to overwrite this method and return false to improve the activation/deactivation of your plugin. This change will
  97.      * only have an affect in the system context (CLI)
  98.      */
  99.     public function rebuildContainer(): bool
  100.     {
  101.         return true;
  102.     }
  104.     /**
  105.      * Some plugins need to provide 3rd party dependencies.
  106.      * If needed, return true and Shopware will execute `composer require` during the plugin installation.
  107.      * When the plugins gets uninstalled, Shopware executes `composer remove`
  108.      */
  109.     public function executeComposerCommands(): bool
  110.     {
  111.         return false;
  112.     }
  114.     final public function removeMigrations(): void
  115.     {
  116.         // namespace should not start with `shopware`
  117.         if (str_starts_with(mb_strtolower($this->getMigrationNamespace()), 'shopware') && !str_starts_with(mb_strtolower($this->getMigrationNamespace()), 'shopware\commercial')) {
  118.             throw new \RuntimeException('Deleting Shopware migrations is not allowed');
  119.         }
  121.         $class = addcslashes($this->getMigrationNamespace(), '\\_%') . '%';
  122.         Kernel::getConnection()->executeUpdate('DELETE FROM migration WHERE class LIKE :class', ['class' => $class]);
  123.     }
  125.     public function getBasePath(): string
  126.     {
  127.         return $this->basePath;
  128.     }
  130.     public function enrichPrivileges(): array
  131.     {
  132.         return [];
  133.     }
  135.     /**
  136.      * Used to configure the BaseUrl for the Admin Extension API
  137.      */
  138.     public function getAdminBaseUrl(): ?string
  139.     {
  140.         return null;
  141.     }
  143.     private function computePluginClassPath(): string
  144.     {
  145.         $canonicalizedPluginClassPath = parent::getPath();
  146.         $canonicalizedPluginPath = realpath($this->basePath);
  148.         if ($canonicalizedPluginPath !== false && mb_strpos($canonicalizedPluginClassPath, $canonicalizedPluginPath) === 0) {
  149.             $relativePluginClassPath = mb_substr($canonicalizedPluginClassPath, mb_strlen($canonicalizedPluginPath));
  151.             return $this->basePath . $relativePluginClassPath;
  152.         }
  154.         return parent::getPath();
  155.     }
  156. }