vendor/pimcore/pimcore/lib/Extension/Bundle/Installer/SettingsStoreAwareInstaller.php line 151

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Extension\Bundle\Installer;
  18. use Doctrine\Migrations\DependencyFactory;
  19. use Doctrine\Migrations\Version\Direction;
  20. use Doctrine\Migrations\Version\ExecutionResult;
  21. use Pimcore\Migrations\FilteredMigrationsRepository;
  22. use Pimcore\Migrations\FilteredTableMetadataStorage;
  23. use Pimcore\Model\Tool\SettingsStore;
  24. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  26. abstract class SettingsStoreAwareInstaller extends AbstractInstaller
  27. {
  28.     /**
  29.      * @var BundleInterface
  30.      */
  31.     protected $bundle;
  33.     /**
  34.      * @var FilteredMigrationsRepository
  35.      */
  36.     protected $migrationRepository;
  38.     /**
  39.      * @var FilteredTableMetadataStorage
  40.      */
  41.     protected $tableMetadataStorage;
  43.     /**
  44.      * @var DependencyFactory
  45.      */
  46.     protected $dependencyFactory;
  48.     public function __construct(BundleInterface $bundle)
  49.     {
  50.         parent::__construct();
  51.         $this->bundle = $bundle;
  52.     }
  54.     /**
  55.      * @param FilteredMigrationsRepository $migrationRepository
  56.      *
  57.      * @required
  58.      */
  59.     public function setMigrationRepository(FilteredMigrationsRepository $migrationRepository): void
  60.     {
  61.         $this->migrationRepository = $migrationRepository;
  62.     }
  64.     /**
  65.      * @param FilteredTableMetadataStorage $tableMetadataStorage
  66.      *
  67.      * @required
  68.      */
  69.     public function setTableMetadataStorage(FilteredTableMetadataStorage $tableMetadataStorage): void
  70.     {
  71.         $this->tableMetadataStorage = $tableMetadataStorage;
  72.     }
  74.     /**
  75.      * @param DependencyFactory $dependencyFactory
  76.      *
  77.      * @required
  78.      */
  79.     public function setDependencyFactory(DependencyFactory $dependencyFactory): void
  80.     {
  81.         $this->dependencyFactory = $dependencyFactory;
  82.     }
  84.     protected function getSettingsStoreInstallationId(): string
  85.     {
  86.         return 'BUNDLE_INSTALLED__' . $this->bundle->getNamespace() . '\\' . $this->bundle->getName();
  87.     }
  89.     public function getLastMigrationVersionClassName(): ?string
  90.     {
  91.         return null;
  92.     }
  94.     protected function markInstalled()
  95.     {
  96.         $migrationVersion = $this->getLastMigrationVersionClassName();
  97.         if ($migrationVersion) {
  98.             $this->migrationRepository->setPrefix($this->bundle->getNamespace());
  99.             $this->tableMetadataStorage->setPrefix($this->bundle->getNamespace());
  100.             $migrations = $this->dependencyFactory->getMigrationRepository()->getMigrations();
  101.             $executedMigrations = $this->dependencyFactory->getMetadataStorage()->getExecutedMigrations();
  103.             foreach ($migrations->getItems() as $migration) {
  104.                 $version = $migration->getVersion();
  106.                 if (!$executedMigrations->hasMigration($version)) {
  107.                     $migrationResult = new ExecutionResult($version, Direction::UP);
  108.                     $this->dependencyFactory->getMetadataStorage()->complete($migrationResult);
  109.                 }
  111.                 if ((string)$version === $migrationVersion) {
  112.                     break;
  113.                 }
  114.             }
  115.         }
  117.         SettingsStore::set($this->getSettingsStoreInstallationId(), true, 'bool', 'pimcore');
  118.     }
  120.     protected function markUninstalled()
  121.     {
  122.         SettingsStore::set($this->getSettingsStoreInstallationId(), false, 'bool', 'pimcore');
  124.         $migrationVersion = $this->getLastMigrationVersionClassName();
  125.         if ($migrationVersion) {
  126.             $this->tableMetadataStorage->setPrefix($this->bundle->getNamespace());
  127.             $executedMigrations = $this->dependencyFactory->getMetadataStorage()->getExecutedMigrations();
  129.             foreach ($executedMigrations->getItems() as $migration) {
  130.                 $migrationResult = new ExecutionResult($migration->getVersion(), Direction::DOWN);
  131.                 $this->dependencyFactory->getMetadataStorage()->complete($migrationResult);
  132.             }
  133.         }
  134.     }
  136.     public function install()
  137.     {
  138.         parent::install();
  139.         $this->markInstalled();
  140.     }
  142.     public function uninstall()
  143.     {
  144.         parent::uninstall();
  145.         $this->markUninstalled();
  146.     }
  148.     /**
  149.      * @return bool
  150.      */
  151.     public function isInstalled()
  152.     {
  153.         $installSetting = SettingsStore::get($this->getSettingsStoreInstallationId(), 'pimcore');
  155.         return (bool) ($installSetting ? $installSetting->getData() : false);
  156.     }
  158.     /**
  159.      * @return bool
  160.      */
  161.     public function canBeInstalled()
  162.     {
  163.         return !$this->isInstalled();
  164.     }
  166.     /**
  167.      * @return bool
  168.      */
  169.     public function canBeUninstalled()
  170.     {
  171.         return $this->isInstalled();
  172.     }
  173. }