Actions
4 years ago
Contracts
4 years ago
Controllers
4 years ago
Exceptions
4 years ago
MigrationsRegister.php
4 years ago
MigrationsRunner.php
4 years ago
MigrationsServiceProvider.php
4 years ago
MigrationsRegister.php
113 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Migrations; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | use Give\Framework\Migrations\Contracts\Migration; |
| 7 | |
| 8 | class MigrationsRegister |
| 9 | { |
| 10 | /** |
| 11 | * FQCN of Migration classes |
| 12 | * |
| 13 | * @since 2.9.0 |
| 14 | * |
| 15 | * @var string[] |
| 16 | */ |
| 17 | private $migrations = []; |
| 18 | |
| 19 | /** |
| 20 | * Returns all of the registered migrations |
| 21 | * |
| 22 | * @since 2.9.0 |
| 23 | * |
| 24 | * @return string[] |
| 25 | */ |
| 26 | public function getMigrations() |
| 27 | { |
| 28 | return $this->migrations; |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * Checks to see if a migration is registered with the given ID |
| 33 | * |
| 34 | * @since 2.9.2 |
| 35 | * |
| 36 | * @param string $id |
| 37 | * |
| 38 | * @return bool |
| 39 | */ |
| 40 | public function hasMigration($id) |
| 41 | { |
| 42 | return isset($this->migrations[$id]); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Returns a migration with the given ID |
| 47 | * |
| 48 | * @since 2.9.2 |
| 49 | * |
| 50 | * @param string $id |
| 51 | * |
| 52 | * @return string |
| 53 | */ |
| 54 | public function getMigration($id) |
| 55 | { |
| 56 | if ( ! isset($this->migrations[$id])) { |
| 57 | throw new InvalidArgumentException("No migration exists with the ID {$id}"); |
| 58 | } |
| 59 | |
| 60 | return $this->migrations[$id]; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Returns all of the registered migration ids |
| 65 | * |
| 66 | * @since 2.9.0 |
| 67 | * |
| 68 | * @return string[] |
| 69 | */ |
| 70 | public function getRegisteredIds() |
| 71 | { |
| 72 | return array_keys($this->migrations); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Add a migration to the list of migrations |
| 77 | * |
| 78 | * @since 2.9.0 |
| 79 | * |
| 80 | * @param string $migrationClass FQCN of the Migration Class |
| 81 | */ |
| 82 | public function addMigration($migrationClass) |
| 83 | { |
| 84 | if ( ! is_subclass_of($migrationClass, Migration::class)) { |
| 85 | throw new InvalidArgumentException('Class must extend the ' . Migration::class . ' class'); |
| 86 | } |
| 87 | |
| 88 | $migrationId = $migrationClass::id(); |
| 89 | |
| 90 | if (isset($this->migrations[$migrationId])) { |
| 91 | throw new InvalidArgumentException( |
| 92 | 'A migration can only be added once. Make sure there are not id conflicts.' |
| 93 | ); |
| 94 | } |
| 95 | |
| 96 | $this->migrations[$migrationId] = $migrationClass; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Helper for adding a bunch of migrations at once |
| 101 | * |
| 102 | * @since 2.9.0 |
| 103 | * |
| 104 | * @param string[] $migrationClasses |
| 105 | */ |
| 106 | public function addMigrations(array $migrationClasses) |
| 107 | { |
| 108 | foreach ($migrationClasses as $migrationClass) { |
| 109 | $this->addMigration($migrationClass); |
| 110 | } |
| 111 | } |
| 112 | } |
| 113 |