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

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