class-shortcodes-ultimate-upgrade.php
3.32 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?php
/**
* The class responsible for plugin upgrade procedures.
*
* @since 5.0.0
* @package Shortcodes_Ultimate
* @subpackage Shortcodes_Ultimate/includes
*/
final class Shortcodes_Ultimate_Upgrade {
/**
* The current version of the plugin.
*
* @since 5.0.0
* @access private
* @var string $current_version The current version of the plugin.
*/
private $current_version;
/**
* Name of the option which stores plugin version.
*
* @since 5.0.0
* @access private
* @var string $saved_version_option Name of the option which stores plugin version.
*/
private $saved_version_option;
/**
* The full path of the upgrade file.
*
* @since 5.4.0
* @access private
* @var string $upgrade_path The full path of the upgrade file.
*/
private $upgrade_path;
/**
* Define the functionality of the updater.
*
* @since 5.0.0
* @param string $plugin_version The current version of the plugin.
*/
public function __construct( $plugin_version ) {
$this->current_version = $plugin_version;
$this->saved_version_option = 'su_option_version';
$this->upgrade_path = '';
}
/**
* Run upgrades if version changed.
*
* @since 5.0.0
*/
public function maybe_upgrade() {
if ( ! $this->is_version_changed() ) {
return;
}
$this->setup_defaults();
$this->maybe_upgrade_to( '5.0.0' );
$this->maybe_upgrade_to( '5.0.7' );
$this->maybe_upgrade_to( '5.6.0' );
$this->maybe_upgrade_to( '5.9.1' );
$this->update_saved_version();
}
/**
* Helper function to register a new upgrade routine.
*
* @since 5.4.0
* @param string $version New version number.
*/
private function maybe_upgrade_to( $version ) {
if ( ! $this->is_saved_version_lower_than( $version ) ) {
return;
}
$this->upgrade_to( $version );
}
/**
* Helper function to test a new upgrade routine.
*
* @since 5.6.0
* @param string $version New version number.
*/
private function upgrade_to( $version ) {
$this->upgrade_path = plugin_dir_path( __FILE__ ) . 'upgrade/' . $version . '.php';
if ( ! file_exists( $this->upgrade_path ) ) {
return;
}
include $this->upgrade_path;
}
/**
* Conditional check if plugin was updated.
*
* @since 5.0.0
* @access private
* @return boolean True if plugin was updated, False otherwise.
*/
private function is_version_changed() {
return $this->is_saved_version_lower_than( $this->current_version );
}
/**
* Conditional check if previous version of the plugin lower than passed one.
*
* @since 5.0.0
* @access private
* @return boolean True if previous version of the plugin lower than passed one, False otherwise.
*/
private function is_saved_version_lower_than( $version ) {
return version_compare(
get_option( $this->saved_version_option, 0 ),
$version,
'<'
);
}
/**
* Save current version number.
*
* @since 5.0.0
* @access private
*/
private function update_saved_version() {
update_option( $this->saved_version_option, $this->current_version, false );
}
/**
* Setup missing default settings
*/
private function setup_defaults() {
$defaults = su_get_config( 'default-settings' );
foreach ( $defaults as $option => $value ) {
if ( get_option( $option, 0 ) === 0 ) {
add_option( $option, $value );
}
}
}
}