Migration.php
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP_SCOPED\IAWP\Migrations; |
| 4 | |
| 5 | abstract class Migration |
| 6 | { |
| 7 | /** |
| 8 | * Classes that extend must provide their database version |
| 9 | * |
| 10 | * @var string |
| 11 | */ |
| 12 | protected $database_version = '0'; |
| 13 | public final function __construct() |
| 14 | { |
| 15 | $this->migrate(); |
| 16 | } |
| 17 | /** |
| 18 | * Trigger the migration |
| 19 | * |
| 20 | * @return void |
| 21 | */ |
| 22 | protected final function migrate() : void |
| 23 | { |
| 24 | $db_version = \get_option('iawp_db_version', '0'); |
| 25 | if (\version_compare($db_version, $this->database_version, '<')) { |
| 26 | // Trigger the classes' migration function |
| 27 | $this->handle(); |
| 28 | \update_option('iawp_db_version', $this->database_version); |
| 29 | } |
| 30 | } |
| 31 | /** |
| 32 | * Classes that extend must define a handle method where migration work is done |
| 33 | * |
| 34 | * @return void |
| 35 | */ |
| 36 | protected abstract function handle() : void; |
| 37 | /** |
| 38 | * @return void |
| 39 | */ |
| 40 | public static function create_or_migrate() : void |
| 41 | { |
| 42 | if (self::should_migrate()) { |
| 43 | \update_option('iawp_is_migrating', '1'); |
| 44 | new Migration_1_0(); |
| 45 | new Migration_1_6(); |
| 46 | new Migration_1_8(); |
| 47 | new Migration_1_9(); |
| 48 | new Migration_2(); |
| 49 | new Migration_3(); |
| 50 | new Migration_4(); |
| 51 | new Migration_5(); |
| 52 | new Migration_6(); |
| 53 | new Migration_7(); |
| 54 | new Migration_8(); |
| 55 | new Migration_9(); |
| 56 | new Migration_10(); |
| 57 | new Migration_11(); |
| 58 | new Migration_12(); |
| 59 | new Migration_13(); |
| 60 | new Migration_14(); |
| 61 | new Migration_15(); |
| 62 | \update_option('iawp_is_migrating', '0'); |
| 63 | } |
| 64 | } |
| 65 | /** |
| 66 | * is_migrating is serving multiple purposes. It's also being used to stop ajax requests and dashboard |
| 67 | * widgets from running when the database version is newer than one that comes with the installed version |
| 68 | * of independent analytics. The probably should be a method called something `database_ready` that serves |
| 69 | * this purpose more explicitly. |
| 70 | * |
| 71 | * @return bool |
| 72 | */ |
| 73 | public static function is_migrating() : bool |
| 74 | { |
| 75 | $db_version = \get_option('iawp_db_version', '0'); |
| 76 | $is_migrating = \get_option('iawp_is_migrating') === '1'; |
| 77 | $is_current = \version_compare($db_version, '15', '='); |
| 78 | $is_outdated = !$is_current; |
| 79 | return $is_outdated || $is_migrating; |
| 80 | } |
| 81 | public static function is_database_ahead_of_plugin() : bool |
| 82 | { |
| 83 | $db_version = \get_option('iawp_db_version', '0'); |
| 84 | return \version_compare($db_version, '15', '>'); |
| 85 | } |
| 86 | public static function is_actually_migrating() : bool |
| 87 | { |
| 88 | return \get_option('iawp_is_migrating') === '1'; |
| 89 | } |
| 90 | /** |
| 91 | * @return bool |
| 92 | */ |
| 93 | public static function should_migrate() : bool |
| 94 | { |
| 95 | $db_version = \get_option('iawp_db_version', '0'); |
| 96 | $is_migrating = \get_option('iawp_is_migrating') === '1'; |
| 97 | $is_current = \version_compare($db_version, '15', '='); |
| 98 | $is_outdated = !$is_current; |
| 99 | return $is_outdated && !$is_migrating; |
| 100 | } |
| 101 | } |
| 102 |