Contracts
5 years ago
MigrationsRegister.php
5 years ago
MigrationsRunner.php
5 years ago
MigrationsServiceProvider.php
5 years ago
MigrationsRegister.php
74 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Migrations; |
| 4 | |
| 5 | use Give\Framework\Migrations\Contracts\Migration; |
| 6 | use http\Exception\InvalidArgumentException; |
| 7 | |
| 8 | class MigrationsRegister { |
| 9 | /** |
| 10 | * FQCN of Migration classes |
| 11 | * |
| 12 | * @since 2.9.0 |
| 13 | * |
| 14 | * @var string[] |
| 15 | */ |
| 16 | private $migrations = []; |
| 17 | |
| 18 | /** |
| 19 | * Returns all of the registered migrations |
| 20 | * |
| 21 | * @since 2.9.0 |
| 22 | * |
| 23 | * @return string[] |
| 24 | */ |
| 25 | public function getMigrations() { |
| 26 | return $this->migrations; |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * Returns all of the registered migration ids |
| 31 | * |
| 32 | * @since 2.9.0 |
| 33 | * |
| 34 | * @return string[] |
| 35 | */ |
| 36 | public function getRegisteredIds() { |
| 37 | return array_keys( $this->migrations ); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Add a migration to the list of migrations |
| 42 | * |
| 43 | * @since 2.9.0 |
| 44 | * |
| 45 | * @param string $migrationClass FQCN of the Migration Class |
| 46 | */ |
| 47 | public function addMigration( $migrationClass ) { |
| 48 | if ( ! is_subclass_of( $migrationClass, Migration::class ) ) { |
| 49 | throw new InvalidArgumentException( 'Class must extend the ' . Migration::class . ' class' ); |
| 50 | } |
| 51 | |
| 52 | $migrationId = $migrationClass::id(); |
| 53 | |
| 54 | if ( isset( $this->migrations[ $migrationId ] ) ) { |
| 55 | throw new InvalidArgumentException( 'A migration can only be added once. Make sure there are not id conflicts.' ); |
| 56 | } |
| 57 | |
| 58 | $this->migrations[ $migrationId ] = $migrationClass; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Helper for adding a bunch of migrations at once |
| 63 | * |
| 64 | * @since 2.9.0 |
| 65 | * |
| 66 | * @param string[] $migrationClasses |
| 67 | */ |
| 68 | public function addMigrations( array $migrationClasses ) { |
| 69 | foreach ( $migrationClasses as $migrationClass ) { |
| 70 | $this->addMigration( $migrationClass ); |
| 71 | } |
| 72 | } |
| 73 | } |
| 74 |