shortcodes/includes/class-shortcodes-ultimate-upgrade.php at master · cleancoded/shortcodes · GitHub

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
165
166
167
168
169
170
<?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 path to the main plugin file.
	 *
	 * @since    5.0.0
	 * @access   private
	 * @var      string    $plugin_file   The path to the main plugin file.
	 */
	private $plugin_file;

	/**
	 * 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    $option_name   Name of the option which stores plugin version.
	 */
	private $option_name;

	/**
	 * The previous saved version.
	 *
	 * @since    5.0.0
	 * @access   private
	 * @var      string    $saved_version   The previous saved version.
	 */
	private $saved_version;

	/**
	 * Define the functionality of the updater.
	 *
	 * @since   5.0.0
	 * @param string  $plugin_file    The path to the main plugin file.
	 * @param string  $plugin_version The current version of the plugin.
	 */
	public function __construct( $plugin_file, $plugin_version ) {

		$this->plugin_file     = $plugin_file;
		$this->current_version = $plugin_version;
		$this->option_name     = 'su_option_version';
		$this->saved_version   = get_option( $this->option_name, 0 );

	}

	/**
	 * Run upgrade procedures (if needed).
	 *
	 * @since  5.0.0
	 */
	public function maybe_upgrade() {

		if ( ! $this->is_version_changed() ) {
			return;
		}

		if ( $this->is_previous_version_less_than( '5.0.0' ) ) {
			$this->upgrade_to_5_0_0();
		}

		$this->save_current_version();

	}

	/**
	 * 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_previous_version_less_than( $this->current_version );
	}

	/**
	 * Conditional check if previous version of the plugin less than passed one.
	 *
	 * @since  5.0.0
	 * @access private
	 * @return boolean True if previous version of the plugin less than passed one, False otherwise.
	 */
	private function is_previous_version_less_than( $version ) {
		return version_compare( $this->saved_version, $version, '<' );
	}

	/**
	 * Save current version number.
	 *
	 * @since  5.0.0
	 * @access private
	 */
	private function save_current_version() {
		update_option( $this->option_name, $this->current_version, false );
	}

	/**
	 * Upgrade the plugin to version 5.0.0
	 *
	 * 1. Replace 'su_vote' option with 'su_option_dismissed_notices'.
	 * 2. Delete 'su_installed' option.
	 * 3. Remove extra slashes from 'su_option_custom-css' option.
	 *
	 * @since   5.0.0
	 * @access  private
	 */
	private function upgrade_to_5_0_0() {

		/**
		 * 1. Replace 'su_vote' option with 'su_option_dismissed_notices'.
		 */
		if ( get_option( 'su_vote' ) ) {

			$dismissed_notices = get_option( 'su_option_dismissed_notices' );

			if ( ! is_array( $dismissed_notices ) ) {

				$dismissed_notices = array(
					'rate' => true
				);

			}

			update_option( 'su_option_dismissed_notices', $dismissed_notices );

			delete_option( 'su_vote' );

		}


		/**
		 * 2. Delete 'su_installed' option.
		 */
		delete_option( 'su_installed' );


		/**
		 * 3. Remove extra slashes from 'su_option_custom-css' option.
		 */
		$custom_css = get_option( 'su_option_custom-css' );

		if ( ! empty( $custom_css ) ) {

			$custom_css = stripslashes( $custom_css );

			update_option( 'su_option_custom-css', $custom_css, true );

		}

	}

}