MigrationHelper.php
101 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\MigrationLog\Helpers; |
| 4 | |
| 5 | use Give\Framework\Migrations\Contracts\Migration; |
| 6 | use Give\Framework\Migrations\MigrationsRegister; |
| 7 | use Give\MigrationLog\MigrationLogModel; |
| 8 | use Give\MigrationLog\MigrationLogRepository; |
| 9 | |
| 10 | /** |
| 11 | * Class MigrationOrder |
| 12 | * @package Give\MigrationLog\Helpers |
| 13 | * |
| 14 | * Helper class used to get migration data |
| 15 | * |
| 16 | * @since 2.10.0 |
| 17 | */ |
| 18 | class MigrationHelper { |
| 19 | |
| 20 | /** |
| 21 | * @var MigrationsRegister |
| 22 | */ |
| 23 | private $migrationRegister; |
| 24 | |
| 25 | /** |
| 26 | * @var MigrationLogRepository |
| 27 | */ |
| 28 | private $migrationRepository; |
| 29 | |
| 30 | /** |
| 31 | * @var MigrationLogModel[] |
| 32 | */ |
| 33 | private $migrationsInDatabase; |
| 34 | |
| 35 | /** |
| 36 | * MigrationOrder constructor. |
| 37 | * |
| 38 | * @param MigrationsRegister $migrationRegister |
| 39 | * @param MigrationLogRepository $migrationRepository |
| 40 | */ |
| 41 | public function __construct( |
| 42 | MigrationsRegister $migrationRegister, |
| 43 | MigrationLogRepository $migrationRepository |
| 44 | ) { |
| 45 | $this->migrationRegister = $migrationRegister; |
| 46 | $this->migrationRepository = $migrationRepository; |
| 47 | $this->migrationsInDatabase = $this->migrationRepository->getMigrations(); |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Get migrations sorted by run order |
| 52 | * |
| 53 | * @return array |
| 54 | */ |
| 55 | private function getMigrationsSorted() { |
| 56 | static $migrations = []; |
| 57 | |
| 58 | if ( empty( $migrations ) ) { |
| 59 | /* @var Migration $migrationClass */ |
| 60 | foreach ( $this->migrationRegister->getMigrations() as $migrationClass ) { |
| 61 | $migrations[ $migrationClass::timestamp() . '_' . $migrationClass::id() ] = $migrationClass::id(); |
| 62 | } |
| 63 | |
| 64 | ksort( $migrations ); |
| 65 | } |
| 66 | |
| 67 | return $migrations; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Get pending migrations |
| 72 | * |
| 73 | * @return string[] |
| 74 | */ |
| 75 | public function getPendingMigrations() { |
| 76 | return array_filter( |
| 77 | $this->migrationRegister->getMigrations(), |
| 78 | function( $migrationClass ) { |
| 79 | /* @var Migration $migrationClass */ |
| 80 | foreach ( $this->migrationsInDatabase as $migration ) { |
| 81 | if ( $migration->getId() === $migrationClass::id() ) { |
| 82 | return false; |
| 83 | } |
| 84 | } |
| 85 | return true; |
| 86 | } |
| 87 | ); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Get migration run order |
| 92 | * |
| 93 | * @param string $migrationId |
| 94 | * |
| 95 | * @return int |
| 96 | */ |
| 97 | public function getRunOrderForMigration( $migrationId ) { |
| 98 | return array_search( $migrationId, array_values( $this->getMigrationsSorted() ) ) + 1; |
| 99 | } |
| 100 | } |
| 101 |