| 1 | <?php |
||
| 2 | /** |
||
| 3 | * Version management for database migrations. |
||
| 4 | * |
||
| 5 | * Database changes require special care: |
||
| 6 | * - the model has to be adjusted for users installing the plugin |
||
| 7 | * - the current setup has to be migrated for current users |
||
| 8 | * |
||
| 9 | * These migrations are a way to handle current users. They do *not* |
||
| 10 | * run on plugin activation. |
||
| 11 | * |
||
| 12 | * Pattern: |
||
| 13 | * |
||
| 14 | * - increment \PodloveSubscribeButton\DATABASE_VERSION constant by 1, e.g. |
||
| 15 | * ```php |
||
|
0 ignored issues
–
show
introduced
by
Loading history...
|
|||
| 16 | * define( __NAMESPACE__ . '\DATABASE_VERSION', 2 ); |
||
|
0 ignored issues
–
show
|
|||
| 17 | * ``` |
||
|
0 ignored issues
–
show
|
|||
| 18 | * |
||
|
0 ignored issues
–
show
|
|||
| 19 | * - add a case in `\PodloveSubscribeButton\run_migrations_for_version`, e.g. |
||
| 20 | * ```php |
||
|
0 ignored issues
–
show
|
|||
| 21 | * function run_migrations_for_version( $version ) { |
||
|
0 ignored issues
–
show
|
|||
| 22 | * global $wpdb; |
||
|
0 ignored issues
–
show
|
|||
| 23 | * switch ( $version ) { |
||
|
0 ignored issues
–
show
|
|||
| 24 | * case 2: |
||
|
0 ignored issues
–
show
|
|||
| 25 | * $wbdb-> // run sql or whatever |
||
|
0 ignored issues
–
show
|
|||
| 26 | * break; |
||
|
0 ignored issues
–
show
|
|||
| 27 | * } |
||
|
0 ignored issues
–
show
|
|||
| 28 | * } |
||
|
0 ignored issues
–
show
|
|||
| 29 | * ``` |
||
|
0 ignored issues
–
show
|
|||
| 30 | * |
||
|
0 ignored issues
–
show
|
|||
| 31 | * Feel free to move the migration code into a separate function if it's |
||
|
0 ignored issues
–
show
|
|||
| 32 | * rather complex. |
||
|
0 ignored issues
–
show
|
|||
| 33 | * |
||
|
0 ignored issues
–
show
|
|||
| 34 | * - adjust the main model / setup process so new users installing the plugin |
||
| 35 | * will have these changes too |
||
| 36 | * |
||
| 37 | * - Test the migrations! :) |
||
| 38 | */ |
||
|
0 ignored issues
–
show
|
|||
| 39 | |||
| 40 | namespace PodloveSubscribeButton; |
||
| 41 | use \PodloveSubscribeButton\Model; |
||
|
0 ignored issues
–
show
The type
\PodloveSubscribeButton\Model was not found. Maybe you did not declare it correctly or list all dependencies?
The issue could also be caused by a filter entry in the build configuration.
If the path has been excluded in your configuration, e.g. filter:
dependency_paths: ["lib/*"]
For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
|
|||
| 42 | |||
| 43 | define( __NAMESPACE__ . '\DATABASE_VERSION', 2 ); |
||
| 44 | |||
| 45 | add_action( 'admin_init', '\PodloveSubscribeButton\maybe_run_database_migrations' ); |
||
| 46 | add_action( 'admin_init', '\PodloveSubscribeButton\run_database_migrations', 5 ); |
||
| 47 | |||
| 48 | function maybe_run_database_migrations() { |
||
|
0 ignored issues
–
show
|
|||
| 49 | $database_version = get_option('podlove_subscribe_button_plugin_database_version'); |
||
|
0 ignored issues
–
show
|
|||
| 50 | |||
| 51 | if ( $database_version === false ) { |
||
|
0 ignored issues
–
show
|
|||
| 52 | // plugin has just been installed or Plugin Version < 1.3 |
||
|
0 ignored issues
–
show
|
|||
| 53 | update_option( 'podlove_subscribe_button_plugin_database_version', DATABASE_VERSION ); |
||
| 54 | } |
||
| 55 | } |
||
|
0 ignored issues
–
show
|
|||
| 56 | |||
| 57 | function run_database_migrations() { |
||
|
0 ignored issues
–
show
|
|||
| 58 | if (get_option('podlove_subscribe_button_plugin_database_version') >= DATABASE_VERSION) |
||
|
0 ignored issues
–
show
|
|||
| 59 | return; |
||
| 60 | |||
| 61 | if (is_multisite()) { |
||
|
0 ignored issues
–
show
|
|||
| 62 | set_time_limit(0); // may take a while, depending on network size |
||
|
0 ignored issues
–
show
|
|||
| 63 | \PodloveSubscribeButton\for_every_podcast_blog(function() { migrate_for_current_blog(); }); |
||
|
0 ignored issues
–
show
|
|||
| 64 | } else { |
||
| 65 | migrate_for_current_blog(); |
||
| 66 | } |
||
| 67 | |||
| 68 | if (isset($_REQUEST['_wp_http_referer']) && $_REQUEST['_wp_http_referer']) { |
||
|
0 ignored issues
–
show
|
|||
| 69 | wp_redirect($_REQUEST['_wp_http_referer']); |
||
|
0 ignored issues
–
show
|
|||
| 70 | exit; |
||
| 71 | } |
||
| 72 | } |
||
|
0 ignored issues
–
show
|
|||
| 73 | |||
| 74 | function migrate_for_current_blog() { |
||
|
0 ignored issues
–
show
|
|||
| 75 | $database_version = get_option('podlove_subscribe_button_plugin_database_version'); |
||
|
0 ignored issues
–
show
|
|||
| 76 | |||
| 77 | for ($i = $database_version+1; $i <= DATABASE_VERSION; $i++) { |
||
|
0 ignored issues
–
show
|
|||
| 78 | \PodloveSubscribeButton\run_migrations_for_version($i); |
||
|
0 ignored issues
–
show
|
|||
| 79 | update_option('podlove_subscribe_button_plugin_database_version', $i); |
||
|
0 ignored issues
–
show
|
|||
| 80 | } |
||
| 81 | } |
||
|
0 ignored issues
–
show
|
|||
| 82 | |||
| 83 | /** |
||
| 84 | * Find and run migration for given version number. |
||
| 85 | * |
||
| 86 | * @todo move migrations into separate files |
||
| 87 | * |
||
| 88 | * @param int $version |
||
|
0 ignored issues
–
show
|
|||
| 89 | */ |
||
| 90 | function run_migrations_for_version( $version ) { |
||
| 91 | global $wpdb; |
||
| 92 | |||
| 93 | switch ( $version ) {} |
||
|
0 ignored issues
–
show
|
|||
| 94 | |||
| 95 | } |