Completed
Branch new-admin-design (d8208b)
by
unknown
21:14 queued 19:00
created
core/services/helpers/datetime/PhpCompatLessFiveSixHelper.php 2 patches
Indentation   +212 added lines, -212 removed lines patch added patch discarded remove patch
@@ -18,221 +18,221 @@
 block discarded – undo
18 18
 class PhpCompatLessFiveSixHelper extends AbstractHelper
19 19
 {
20 20
 
21
-    /**
22
-     * PhpCompatLessFiveSixHelper constructor.
23
-     *
24
-     * @throws DomainException
25
-     */
26
-    public function __construct()
27
-    {
28
-        if (PHP_VERSION_ID >= 50600) {
29
-            throw new DomainException(
30
-                sprintf(
31
-                    esc_html__(
32
-                        'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
33
-                        'event_espresso'
34
-                    ),
35
-                    __CLASS__,
36
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
37
-                )
38
-            );
39
-        }
40
-    }
21
+	/**
22
+	 * PhpCompatLessFiveSixHelper constructor.
23
+	 *
24
+	 * @throws DomainException
25
+	 */
26
+	public function __construct()
27
+	{
28
+		if (PHP_VERSION_ID >= 50600) {
29
+			throw new DomainException(
30
+				sprintf(
31
+					esc_html__(
32
+						'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
33
+						'event_espresso'
34
+					),
35
+					__CLASS__,
36
+					'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
37
+				)
38
+			);
39
+		}
40
+	}
41 41
 
42
-    /**
43
-     * Returns a timezone string for the provided gmt_offset.
44
-     *
45
-     * @param float|string $gmt_offset
46
-     * @return string
47
-     * @throws EE_Error
48
-     */
49
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
50
-    {
51
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
52
-        if (is_string($gmt_offset_or_timezone_string)) {
53
-            return $gmt_offset_or_timezone_string;
54
-        }
55
-        // well we know its a float, so let's roll with it.
56
-        $gmt_offset = $gmt_offset_or_timezone_string;
57
-        // convert GMT offset to seconds
58
-        $gmt_offset *= HOUR_IN_SECONDS;
59
-        // although we don't know the TZ abbreviation, we know the UTC offset
60
-        $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
61
-        // only use this timezone_string IF it's current offset matches the given offset
62
-        if (! empty($timezone_string)) {
63
-            $offset = null;
64
-            try {
65
-                $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
66
-                if ($offset !== $gmt_offset) {
67
-                    $timezone_string = false;
68
-                }
69
-            } catch (Exception $e) {
70
-                $timezone_string = false;
71
-            }
72
-        }
73
-        // better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
74
-        // ...
75
-        $timezone_string = $timezone_string !== false
76
-            ? $timezone_string
77
-            : $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
78
-        return $timezone_string;
79
-    }
42
+	/**
43
+	 * Returns a timezone string for the provided gmt_offset.
44
+	 *
45
+	 * @param float|string $gmt_offset
46
+	 * @return string
47
+	 * @throws EE_Error
48
+	 */
49
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
50
+	{
51
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
52
+		if (is_string($gmt_offset_or_timezone_string)) {
53
+			return $gmt_offset_or_timezone_string;
54
+		}
55
+		// well we know its a float, so let's roll with it.
56
+		$gmt_offset = $gmt_offset_or_timezone_string;
57
+		// convert GMT offset to seconds
58
+		$gmt_offset *= HOUR_IN_SECONDS;
59
+		// although we don't know the TZ abbreviation, we know the UTC offset
60
+		$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
61
+		// only use this timezone_string IF it's current offset matches the given offset
62
+		if (! empty($timezone_string)) {
63
+			$offset = null;
64
+			try {
65
+				$offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
66
+				if ($offset !== $gmt_offset) {
67
+					$timezone_string = false;
68
+				}
69
+			} catch (Exception $e) {
70
+				$timezone_string = false;
71
+			}
72
+		}
73
+		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
74
+		// ...
75
+		$timezone_string = $timezone_string !== false
76
+			? $timezone_string
77
+			: $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
78
+		return $timezone_string;
79
+	}
80 80
 
81 81
 
82
-    /**
83
-     * @param int  $gmt_offset
84
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table
85
-     * @see self::adjustInvalidGmtOffset
86
-     * @return string
87
-     * @throws EE_Error
88
-     */
89
-    protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
90
-    {
91
-        $gmt_offset = (int) $gmt_offset;
92
-        /** @var array[] $abbreviations */
93
-        $abbreviations = DateTimeZone::listAbbreviations();
94
-        foreach ($abbreviations as $abbreviation) {
95
-            foreach ($abbreviation as $timezone) {
96
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
97
-                    try {
98
-                        $offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
99
-                        if ($offset !== $gmt_offset) {
100
-                            continue;
101
-                        }
102
-                        return $timezone['timezone_id'];
103
-                    } catch (Exception $e) {
104
-                        continue;
105
-                    }
106
-                }
107
-            }
108
-        }
109
-        // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
110
-        if ($coerce === true) {
111
-            $timezone_string = $this->getTimezoneStringFromAbbreviationsList(
112
-                $this->adjustInvalidGmtOffsets($gmt_offset),
113
-                false
114
-            );
115
-            if ($timezone_string) {
116
-                return $timezone_string;
117
-            }
118
-        }
119
-        throw new EE_Error(
120
-            sprintf(
121
-                esc_html__(
122
-                    'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
123
-                    'event_espresso'
124
-                ),
125
-                $gmt_offset / HOUR_IN_SECONDS,
126
-                '<a href="http://www.php.net/manual/en/timezones.php">',
127
-                '</a>'
128
-            )
129
-        );
130
-    }
82
+	/**
83
+	 * @param int  $gmt_offset
84
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table
85
+	 * @see self::adjustInvalidGmtOffset
86
+	 * @return string
87
+	 * @throws EE_Error
88
+	 */
89
+	protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
90
+	{
91
+		$gmt_offset = (int) $gmt_offset;
92
+		/** @var array[] $abbreviations */
93
+		$abbreviations = DateTimeZone::listAbbreviations();
94
+		foreach ($abbreviations as $abbreviation) {
95
+			foreach ($abbreviation as $timezone) {
96
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
97
+					try {
98
+						$offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
99
+						if ($offset !== $gmt_offset) {
100
+							continue;
101
+						}
102
+						return $timezone['timezone_id'];
103
+					} catch (Exception $e) {
104
+						continue;
105
+					}
106
+				}
107
+			}
108
+		}
109
+		// if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
110
+		if ($coerce === true) {
111
+			$timezone_string = $this->getTimezoneStringFromAbbreviationsList(
112
+				$this->adjustInvalidGmtOffsets($gmt_offset),
113
+				false
114
+			);
115
+			if ($timezone_string) {
116
+				return $timezone_string;
117
+			}
118
+		}
119
+		throw new EE_Error(
120
+			sprintf(
121
+				esc_html__(
122
+					'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
123
+					'event_espresso'
124
+				),
125
+				$gmt_offset / HOUR_IN_SECONDS,
126
+				'<a href="http://www.php.net/manual/en/timezones.php">',
127
+				'</a>'
128
+			)
129
+		);
130
+	}
131 131
 
132 132
 
133
-    /**
134
-     * Depending on PHP version,
135
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
136
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
137
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
138
-     *
139
-     * @param int $gmt_offset
140
-     * @return int
141
-     */
142
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
143
-    {
144
-        // make sure $gmt_offset is int
145
-        $gmt_offset = (int) $gmt_offset;
146
-        switch ($gmt_offset) {
147
-            // -12
148
-            case -43200:
149
-                $gmt_offset = -39600;
150
-                break;
151
-            // -11.5
152
-            case -41400:
153
-                $gmt_offset = -39600;
154
-                break;
155
-            // -10.5
156
-            case -37800:
157
-                $gmt_offset = -39600;
158
-                break;
159
-            // -8.5
160
-            case -30600:
161
-                $gmt_offset = -28800;
162
-                break;
163
-            // -7.5
164
-            case -27000:
165
-                $gmt_offset = -25200;
166
-                break;
167
-            // -6.5
168
-            case -23400:
169
-                $gmt_offset = -21600;
170
-                break;
171
-            // -5.5
172
-            case -19800:
173
-                $gmt_offset = -18000;
174
-                break;
175
-            // -4.5
176
-            case -16200:
177
-                $gmt_offset = -14400;
178
-                break;
179
-            // -3.5
180
-            case -12600:
181
-                $gmt_offset = -10800;
182
-                break;
183
-            // -2.5
184
-            case -9000:
185
-                $gmt_offset = -7200;
186
-                break;
187
-            // -1.5
188
-            case -5400:
189
-                $gmt_offset = -3600;
190
-                break;
191
-            // -0.5
192
-            case -1800:
193
-                $gmt_offset = 0;
194
-                break;
195
-            // .5
196
-            case 1800:
197
-                $gmt_offset = 3600;
198
-                break;
199
-            // 1.5
200
-            case 5400:
201
-                $gmt_offset = 7200;
202
-                break;
203
-            // 2.5
204
-            case 9000:
205
-                $gmt_offset = 10800;
206
-                break;
207
-            // 3.5
208
-            case 12600:
209
-                $gmt_offset = 14400;
210
-                break;
211
-            // 7.5
212
-            case 27000:
213
-                $gmt_offset = 28800;
214
-                break;
215
-            // 8.5
216
-            case 30600:
217
-                $gmt_offset = 31500;
218
-                break;
219
-            // 10.5
220
-            case 37800:
221
-                $gmt_offset = 39600;
222
-                break;
223
-            // 11.5
224
-            case 41400:
225
-                $gmt_offset = 43200;
226
-                break;
227
-            // 12.75
228
-            case 45900:
229
-                $gmt_offset = 46800;
230
-                break;
231
-            // 13.75
232
-            case 49500:
233
-                $gmt_offset = 50400;
234
-                break;
235
-        }
236
-        return $gmt_offset;
237
-    }
133
+	/**
134
+	 * Depending on PHP version,
135
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
136
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
137
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
138
+	 *
139
+	 * @param int $gmt_offset
140
+	 * @return int
141
+	 */
142
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
143
+	{
144
+		// make sure $gmt_offset is int
145
+		$gmt_offset = (int) $gmt_offset;
146
+		switch ($gmt_offset) {
147
+			// -12
148
+			case -43200:
149
+				$gmt_offset = -39600;
150
+				break;
151
+			// -11.5
152
+			case -41400:
153
+				$gmt_offset = -39600;
154
+				break;
155
+			// -10.5
156
+			case -37800:
157
+				$gmt_offset = -39600;
158
+				break;
159
+			// -8.5
160
+			case -30600:
161
+				$gmt_offset = -28800;
162
+				break;
163
+			// -7.5
164
+			case -27000:
165
+				$gmt_offset = -25200;
166
+				break;
167
+			// -6.5
168
+			case -23400:
169
+				$gmt_offset = -21600;
170
+				break;
171
+			// -5.5
172
+			case -19800:
173
+				$gmt_offset = -18000;
174
+				break;
175
+			// -4.5
176
+			case -16200:
177
+				$gmt_offset = -14400;
178
+				break;
179
+			// -3.5
180
+			case -12600:
181
+				$gmt_offset = -10800;
182
+				break;
183
+			// -2.5
184
+			case -9000:
185
+				$gmt_offset = -7200;
186
+				break;
187
+			// -1.5
188
+			case -5400:
189
+				$gmt_offset = -3600;
190
+				break;
191
+			// -0.5
192
+			case -1800:
193
+				$gmt_offset = 0;
194
+				break;
195
+			// .5
196
+			case 1800:
197
+				$gmt_offset = 3600;
198
+				break;
199
+			// 1.5
200
+			case 5400:
201
+				$gmt_offset = 7200;
202
+				break;
203
+			// 2.5
204
+			case 9000:
205
+				$gmt_offset = 10800;
206
+				break;
207
+			// 3.5
208
+			case 12600:
209
+				$gmt_offset = 14400;
210
+				break;
211
+			// 7.5
212
+			case 27000:
213
+				$gmt_offset = 28800;
214
+				break;
215
+			// 8.5
216
+			case 30600:
217
+				$gmt_offset = 31500;
218
+				break;
219
+			// 10.5
220
+			case 37800:
221
+				$gmt_offset = 39600;
222
+				break;
223
+			// 11.5
224
+			case 41400:
225
+				$gmt_offset = 43200;
226
+				break;
227
+			// 12.75
228
+			case 45900:
229
+				$gmt_offset = 46800;
230
+				break;
231
+			// 13.75
232
+			case 49500:
233
+				$gmt_offset = 50400;
234
+				break;
235
+		}
236
+		return $gmt_offset;
237
+	}
238 238
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -59,7 +59,7 @@
 block discarded – undo
59 59
         // although we don't know the TZ abbreviation, we know the UTC offset
60 60
         $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
61 61
         // only use this timezone_string IF it's current offset matches the given offset
62
-        if (! empty($timezone_string)) {
62
+        if ( ! empty($timezone_string)) {
63 63
             $offset = null;
64 64
             try {
65 65
                 $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
Please login to merge, or discard this patch.
core/services/helpers/datetime/PhpCompatGreaterFiveSixHelper.php 2 patches
Indentation   +79 added lines, -79 removed lines patch added patch discarded remove patch
@@ -8,91 +8,91 @@
 block discarded – undo
8 8
 
9 9
 class PhpCompatGreaterFiveSixHelper extends AbstractHelper
10 10
 {
11
-    /**
12
-     * PhpCompatLessFiveSixHelper constructor.
13
-     *
14
-     * @throws DomainException
15
-     */
16
-    public function __construct()
17
-    {
18
-        if (PHP_VERSION_ID < 50600) {
19
-            throw new DomainException(
20
-                sprintf(
21
-                    esc_html__(
22
-                        'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
23
-                        'event_espresso'
24
-                    ),
25
-                    __CLASS__,
26
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
27
-                )
28
-            );
29
-        }
30
-    }
11
+	/**
12
+	 * PhpCompatLessFiveSixHelper constructor.
13
+	 *
14
+	 * @throws DomainException
15
+	 */
16
+	public function __construct()
17
+	{
18
+		if (PHP_VERSION_ID < 50600) {
19
+			throw new DomainException(
20
+				sprintf(
21
+					esc_html__(
22
+						'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
23
+						'event_espresso'
24
+					),
25
+					__CLASS__,
26
+					'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
27
+				)
28
+			);
29
+		}
30
+	}
31 31
 
32
-    /**
33
-     * Returns a timezone string for the provided gmt_offset.
34
-     * This is a valid timezone string that can be sent into DateTimeZone
35
-     *
36
-     * @param float|string $gmt_offset
37
-     * @return string
38
-     */
39
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
40
-    {
41
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
42
-        return is_float($gmt_offset_or_timezone_string)
43
-            ? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
44
-            : $gmt_offset_or_timezone_string;
45
-    }
32
+	/**
33
+	 * Returns a timezone string for the provided gmt_offset.
34
+	 * This is a valid timezone string that can be sent into DateTimeZone
35
+	 *
36
+	 * @param float|string $gmt_offset
37
+	 * @return string
38
+	 */
39
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
40
+	{
41
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
42
+		return is_float($gmt_offset_or_timezone_string)
43
+			? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
44
+			: $gmt_offset_or_timezone_string;
45
+	}
46 46
 
47 47
 
48 48
 
49
-    /**
50
-     * Returns a formatted offset for use as an argument for constructing DateTimeZone
51
-     * @param float $gmt_offset This should be a float representing the gmt_offset.
52
-     * @return string
53
-     */
54
-    protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
55
-    {
56
-        $gmt_offset = (float) $gmt_offset;
57
-        $is_negative = $gmt_offset < 0;
58
-        $gmt_offset *= 100;
59
-        $gmt_offset = absint($gmt_offset);
60
-        // negative and need zero padding?
61
-        if (strlen($gmt_offset) < 4) {
62
-            $gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
63
-        }
64
-        $gmt_offset = $this->convertToTimeFraction($gmt_offset);
65
-        // return something like -1300, -0200 or +1300, +0200
66
-        return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
67
-    }
49
+	/**
50
+	 * Returns a formatted offset for use as an argument for constructing DateTimeZone
51
+	 * @param float $gmt_offset This should be a float representing the gmt_offset.
52
+	 * @return string
53
+	 */
54
+	protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
55
+	{
56
+		$gmt_offset = (float) $gmt_offset;
57
+		$is_negative = $gmt_offset < 0;
58
+		$gmt_offset *= 100;
59
+		$gmt_offset = absint($gmt_offset);
60
+		// negative and need zero padding?
61
+		if (strlen($gmt_offset) < 4) {
62
+			$gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
63
+		}
64
+		$gmt_offset = $this->convertToTimeFraction($gmt_offset);
65
+		// return something like -1300, -0200 or +1300, +0200
66
+		return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
67
+	}
68 68
 
69 69
 
70
-    /**
71
-     * Converts something like `1550` to `1530` or `0275` to `0245`
72
-     * Incoming offset should be a positive value, this will mutate negative values. Be aware!
73
-     * @param int $offset
74
-     * @return mixed
75
-     */
76
-    protected function convertToTimeFraction($offset)
77
-    {
78
-        $first_part = substr($offset, 0, 2);
79
-        $second_part = substr($offset, 2, 2);
80
-        $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
81
-        return $first_part . $second_part;
82
-    }
70
+	/**
71
+	 * Converts something like `1550` to `1530` or `0275` to `0245`
72
+	 * Incoming offset should be a positive value, this will mutate negative values. Be aware!
73
+	 * @param int $offset
74
+	 * @return mixed
75
+	 */
76
+	protected function convertToTimeFraction($offset)
77
+	{
78
+		$first_part = substr($offset, 0, 2);
79
+		$second_part = substr($offset, 2, 2);
80
+		$second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
81
+		return $first_part . $second_part;
82
+	}
83 83
 
84 84
 
85
-    /**
86
-     * Get Timezone offset for given timezone object
87
-     *
88
-     * @param DateTimeZone $date_time_zone
89
-     * @param null|int     $time
90
-     * @return int
91
-     */
92
-    public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
93
-    {
94
-        $time = is_int($time) || $time === null ? $time : (int) strtotime($time);
95
-        $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
96
-        return $date_time_zone->getOffset(new DateTime('@' . $time));
97
-    }
85
+	/**
86
+	 * Get Timezone offset for given timezone object
87
+	 *
88
+	 * @param DateTimeZone $date_time_zone
89
+	 * @param null|int     $time
90
+	 * @return int
91
+	 */
92
+	public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
93
+	{
94
+		$time = is_int($time) || $time === null ? $time : (int) strtotime($time);
95
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
96
+		return $date_time_zone->getOffset(new DateTime('@' . $time));
97
+	}
98 98
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -63,7 +63,7 @@  discard block
 block discarded – undo
63 63
         }
64 64
         $gmt_offset = $this->convertToTimeFraction($gmt_offset);
65 65
         // return something like -1300, -0200 or +1300, +0200
66
-        return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
66
+        return $is_negative ? '-'.$gmt_offset : '+'.$gmt_offset;
67 67
     }
68 68
 
69 69
 
@@ -78,7 +78,7 @@  discard block
 block discarded – undo
78 78
         $first_part = substr($offset, 0, 2);
79 79
         $second_part = substr($offset, 2, 2);
80 80
         $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
81
-        return $first_part . $second_part;
81
+        return $first_part.$second_part;
82 82
     }
83 83
 
84 84
 
@@ -93,6 +93,6 @@  discard block
 block discarded – undo
93 93
     {
94 94
         $time = is_int($time) || $time === null ? $time : (int) strtotime($time);
95 95
         $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
96
-        return $date_time_zone->getOffset(new DateTime('@' . $time));
96
+        return $date_time_zone->getOffset(new DateTime('@'.$time));
97 97
     }
98 98
 }
Please login to merge, or discard this patch.
core/EE_Load_Espresso_Core.core.php 1 patch
Indentation   +110 added lines, -110 removed lines patch added patch discarded remove patch
@@ -27,114 +27,114 @@
 block discarded – undo
27 27
 class EE_Load_Espresso_Core implements RequestDecoratorInterface, RequestStackCoreAppInterface
28 28
 {
29 29
 
30
-    /**
31
-     * @var RequestInterface $request
32
-     */
33
-    protected $request;
34
-
35
-    /**
36
-     * @var ResponseInterface $response
37
-     */
38
-    protected $response;
39
-
40
-    /**
41
-     * @var EE_Dependency_Map $dependency_map
42
-     */
43
-    protected $dependency_map;
44
-
45
-    /**
46
-     * @var EE_Registry $registry
47
-     */
48
-    protected $registry;
49
-
50
-
51
-    /**
52
-     * EE_Load_Espresso_Core constructor
53
-     *
54
-     * @param EE_Registry       $registry
55
-     * @param EE_Dependency_Map $dependency_map
56
-     * @throws EE_Error
57
-     */
58
-    public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map)
59
-    {
60
-        EE_Error::doing_it_wrong(
61
-            __METHOD__,
62
-            sprintf(
63
-                esc_html__(
64
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
65
-                    'event_espresso'
66
-                ),
67
-                'EventEspresso\core\services\request\RequestStackCoreApp',
68
-                '\core\services\request',
69
-                'EventEspresso\core\services\request'
70
-            ),
71
-            '4.9.53'
72
-        );
73
-    }
74
-
75
-
76
-    /**
77
-     * handle
78
-     * sets hooks for running rest of system
79
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
80
-     * starting EE Addons from any other point may lead to problems
81
-     *
82
-     * @param RequestInterface  $request
83
-     * @param ResponseInterface $response
84
-     * @return ResponseInterface
85
-     * @throws EE_Error
86
-     * @throws InvalidDataTypeException
87
-     * @throws InvalidInterfaceException
88
-     * @throws InvalidArgumentException
89
-     * @throws DomainException
90
-     */
91
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
92
-    {
93
-    }
94
-
95
-
96
-    /**
97
-     * @return RequestInterface
98
-     */
99
-    public function request()
100
-    {
101
-    }
102
-
103
-
104
-    /**
105
-     * @return ResponseInterface
106
-     */
107
-    public function response()
108
-    {
109
-    }
110
-
111
-
112
-    /**
113
-     * @return EE_Dependency_Map
114
-     * @throws EE_Error
115
-     */
116
-    public function dependency_map()
117
-    {
118
-    }
119
-
120
-
121
-    /**
122
-     * @return EE_Registry
123
-     * @throws EE_Error
124
-     */
125
-    public function registry()
126
-    {
127
-    }
128
-
129
-
130
-    /**
131
-     * called after the request stack has been fully processed
132
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
133
-     *
134
-     * @param RequestInterface  $request
135
-     * @param ResponseInterface $response
136
-     */
137
-    public function handleResponse(RequestInterface $request, ResponseInterface $response)
138
-    {
139
-    }
30
+	/**
31
+	 * @var RequestInterface $request
32
+	 */
33
+	protected $request;
34
+
35
+	/**
36
+	 * @var ResponseInterface $response
37
+	 */
38
+	protected $response;
39
+
40
+	/**
41
+	 * @var EE_Dependency_Map $dependency_map
42
+	 */
43
+	protected $dependency_map;
44
+
45
+	/**
46
+	 * @var EE_Registry $registry
47
+	 */
48
+	protected $registry;
49
+
50
+
51
+	/**
52
+	 * EE_Load_Espresso_Core constructor
53
+	 *
54
+	 * @param EE_Registry       $registry
55
+	 * @param EE_Dependency_Map $dependency_map
56
+	 * @throws EE_Error
57
+	 */
58
+	public function __construct(EE_Registry $registry, EE_Dependency_Map $dependency_map)
59
+	{
60
+		EE_Error::doing_it_wrong(
61
+			__METHOD__,
62
+			sprintf(
63
+				esc_html__(
64
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
65
+					'event_espresso'
66
+				),
67
+				'EventEspresso\core\services\request\RequestStackCoreApp',
68
+				'\core\services\request',
69
+				'EventEspresso\core\services\request'
70
+			),
71
+			'4.9.53'
72
+		);
73
+	}
74
+
75
+
76
+	/**
77
+	 * handle
78
+	 * sets hooks for running rest of system
79
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
80
+	 * starting EE Addons from any other point may lead to problems
81
+	 *
82
+	 * @param RequestInterface  $request
83
+	 * @param ResponseInterface $response
84
+	 * @return ResponseInterface
85
+	 * @throws EE_Error
86
+	 * @throws InvalidDataTypeException
87
+	 * @throws InvalidInterfaceException
88
+	 * @throws InvalidArgumentException
89
+	 * @throws DomainException
90
+	 */
91
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
92
+	{
93
+	}
94
+
95
+
96
+	/**
97
+	 * @return RequestInterface
98
+	 */
99
+	public function request()
100
+	{
101
+	}
102
+
103
+
104
+	/**
105
+	 * @return ResponseInterface
106
+	 */
107
+	public function response()
108
+	{
109
+	}
110
+
111
+
112
+	/**
113
+	 * @return EE_Dependency_Map
114
+	 * @throws EE_Error
115
+	 */
116
+	public function dependency_map()
117
+	{
118
+	}
119
+
120
+
121
+	/**
122
+	 * @return EE_Registry
123
+	 * @throws EE_Error
124
+	 */
125
+	public function registry()
126
+	{
127
+	}
128
+
129
+
130
+	/**
131
+	 * called after the request stack has been fully processed
132
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
133
+	 *
134
+	 * @param RequestInterface  $request
135
+	 * @param ResponseInterface $response
136
+	 */
137
+	public function handleResponse(RequestInterface $request, ResponseInterface $response)
138
+	{
139
+	}
140 140
 }
Please login to merge, or discard this patch.
core/EE_Object_Collection.core.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -40,7 +40,7 @@
 block discarded – undo
40 40
     public function add($object, $info = null)
41 41
     {
42 42
         $class = $this->interface;
43
-        if (! $object instanceof $class) {
43
+        if ( ! $object instanceof $class) {
44 44
             return false;
45 45
         }
46 46
         $this->attach($object);
Please login to merge, or discard this patch.
Indentation   +156 added lines, -156 removed lines patch added patch discarded remove patch
@@ -16,160 +16,160 @@
 block discarded – undo
16 16
 abstract class EE_Object_Collection extends SplObjectStorage implements EEI_Collection
17 17
 {
18 18
 
19
-    /**
20
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
21
-     * this should be set from within the child class constructor
22
-     *
23
-     * @type string $interface
24
-     */
25
-    protected $interface;
26
-
27
-
28
-    /**
29
-     * add
30
-     *
31
-     * attaches an object to the Collection
32
-     * and sets any supplied data associated with the current iterator entry
33
-     * by calling EE_Object_Collection::set_info()
34
-     *
35
-     * @access public
36
-     * @param object $object
37
-     * @param mixed  $info
38
-     * @return bool
39
-     */
40
-    public function add($object, $info = null)
41
-    {
42
-        $class = $this->interface;
43
-        if (! $object instanceof $class) {
44
-            return false;
45
-        }
46
-        $this->attach($object);
47
-        $this->set_info($object, $info);
48
-        return $this->contains($object);
49
-    }
50
-
51
-
52
-    /**
53
-     * set_info
54
-     *
55
-     * Sets the data associated with an object in the Collection
56
-     * if no $info is supplied, then the spl_object_hash() is used
57
-     *
58
-     * @access public
59
-     * @param object $object
60
-     * @param mixed  $info
61
-     * @return bool
62
-     */
63
-    public function set_info($object, $info = null)
64
-    {
65
-        $info = ! empty($info) ? $info : spl_object_hash($object);
66
-        $this->rewind();
67
-        while ($this->valid()) {
68
-            if ($object === $this->current()) {
69
-                $this->setInfo($info);
70
-                $this->rewind();
71
-                return true;
72
-            }
73
-            $this->next();
74
-        }
75
-        return false;
76
-    }
77
-
78
-
79
-    /**
80
-     * get_by_info
81
-     *
82
-     * finds and returns an object in the Collection based on the info that was set using addObject()
83
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
84
-     *
85
-     * @access public
86
-     * @param mixed
87
-     * @return null | object
88
-     */
89
-    public function get_by_info($info)
90
-    {
91
-        $this->rewind();
92
-        while ($this->valid()) {
93
-            if ($info === $this->getInfo()) {
94
-                $object = $this->current();
95
-                $this->rewind();
96
-                return $object;
97
-            }
98
-            $this->next();
99
-        }
100
-        return null;
101
-    }
102
-
103
-
104
-    /**
105
-     * has
106
-     *
107
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
108
-     *
109
-     * @access public
110
-     * @param object $object
111
-     * @return bool
112
-     */
113
-    public function has($object)
114
-    {
115
-        return $this->contains($object);
116
-    }
117
-
118
-
119
-    /**
120
-     * remove
121
-     *
122
-     * detaches an object from the Collection
123
-     *
124
-     * @access public
125
-     * @param $object
126
-     * @return bool
127
-     */
128
-    public function remove($object)
129
-    {
130
-        $this->detach($object);
131
-        return true;
132
-    }
133
-
134
-
135
-    /**
136
-     * set_current
137
-     *
138
-     * advances pointer to the provided object
139
-     *
140
-     * @access public
141
-     * @param $object
142
-     * @return void
143
-     */
144
-    public function set_current($object)
145
-    {
146
-        $this->rewind();
147
-        while ($this->valid()) {
148
-            if ($this->current() === $object) {
149
-                break;
150
-            }
151
-            $this->next();
152
-        }
153
-    }
154
-
155
-
156
-    /**
157
-     * set_current_by_info
158
-     *
159
-     * advances pointer to the object whose info matches that which was provided
160
-     *
161
-     * @access public
162
-     * @param $info
163
-     * @return void
164
-     */
165
-    public function set_current_by_info($info)
166
-    {
167
-        $this->rewind();
168
-        while ($this->valid()) {
169
-            if ($info === $this->getInfo()) {
170
-                break;
171
-            }
172
-            $this->next();
173
-        }
174
-    }
19
+	/**
20
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
21
+	 * this should be set from within the child class constructor
22
+	 *
23
+	 * @type string $interface
24
+	 */
25
+	protected $interface;
26
+
27
+
28
+	/**
29
+	 * add
30
+	 *
31
+	 * attaches an object to the Collection
32
+	 * and sets any supplied data associated with the current iterator entry
33
+	 * by calling EE_Object_Collection::set_info()
34
+	 *
35
+	 * @access public
36
+	 * @param object $object
37
+	 * @param mixed  $info
38
+	 * @return bool
39
+	 */
40
+	public function add($object, $info = null)
41
+	{
42
+		$class = $this->interface;
43
+		if (! $object instanceof $class) {
44
+			return false;
45
+		}
46
+		$this->attach($object);
47
+		$this->set_info($object, $info);
48
+		return $this->contains($object);
49
+	}
50
+
51
+
52
+	/**
53
+	 * set_info
54
+	 *
55
+	 * Sets the data associated with an object in the Collection
56
+	 * if no $info is supplied, then the spl_object_hash() is used
57
+	 *
58
+	 * @access public
59
+	 * @param object $object
60
+	 * @param mixed  $info
61
+	 * @return bool
62
+	 */
63
+	public function set_info($object, $info = null)
64
+	{
65
+		$info = ! empty($info) ? $info : spl_object_hash($object);
66
+		$this->rewind();
67
+		while ($this->valid()) {
68
+			if ($object === $this->current()) {
69
+				$this->setInfo($info);
70
+				$this->rewind();
71
+				return true;
72
+			}
73
+			$this->next();
74
+		}
75
+		return false;
76
+	}
77
+
78
+
79
+	/**
80
+	 * get_by_info
81
+	 *
82
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
83
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
84
+	 *
85
+	 * @access public
86
+	 * @param mixed
87
+	 * @return null | object
88
+	 */
89
+	public function get_by_info($info)
90
+	{
91
+		$this->rewind();
92
+		while ($this->valid()) {
93
+			if ($info === $this->getInfo()) {
94
+				$object = $this->current();
95
+				$this->rewind();
96
+				return $object;
97
+			}
98
+			$this->next();
99
+		}
100
+		return null;
101
+	}
102
+
103
+
104
+	/**
105
+	 * has
106
+	 *
107
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
108
+	 *
109
+	 * @access public
110
+	 * @param object $object
111
+	 * @return bool
112
+	 */
113
+	public function has($object)
114
+	{
115
+		return $this->contains($object);
116
+	}
117
+
118
+
119
+	/**
120
+	 * remove
121
+	 *
122
+	 * detaches an object from the Collection
123
+	 *
124
+	 * @access public
125
+	 * @param $object
126
+	 * @return bool
127
+	 */
128
+	public function remove($object)
129
+	{
130
+		$this->detach($object);
131
+		return true;
132
+	}
133
+
134
+
135
+	/**
136
+	 * set_current
137
+	 *
138
+	 * advances pointer to the provided object
139
+	 *
140
+	 * @access public
141
+	 * @param $object
142
+	 * @return void
143
+	 */
144
+	public function set_current($object)
145
+	{
146
+		$this->rewind();
147
+		while ($this->valid()) {
148
+			if ($this->current() === $object) {
149
+				break;
150
+			}
151
+			$this->next();
152
+		}
153
+	}
154
+
155
+
156
+	/**
157
+	 * set_current_by_info
158
+	 *
159
+	 * advances pointer to the object whose info matches that which was provided
160
+	 *
161
+	 * @access public
162
+	 * @param $info
163
+	 * @return void
164
+	 */
165
+	public function set_current_by_info($info)
166
+	{
167
+		$this->rewind();
168
+		while ($this->valid()) {
169
+			if ($info === $this->getInfo()) {
170
+				break;
171
+			}
172
+			$this->next();
173
+		}
174
+	}
175 175
 }
Please login to merge, or discard this patch.
data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_billing_info.dmsstage.php 2 patches
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -25,9 +25,9 @@  discard block
 block discarded – undo
25 25
         $old_billing_info = maybe_unserialize($old_row['meta_value']);
26 26
         $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
27 27
         $repetitive_prefix = '_reg-page-billing-';
28
-        $repetitive_suffix = "-" . $gateway_name;
28
+        $repetitive_suffix = "-".$gateway_name;
29 29
         foreach ($old_billing_info as $old_input_name => $input_value) {
30
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
30
+            $old_input_name_important_part = str_replace(array($repetitive_prefix, $repetitive_suffix), array('', ''), $old_input_name);
31 31
 
32 32
             switch ($old_input_name_important_part) {
33 33
                 case 'fname':
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
                 default:
62 62
                     $new_input_name = $old_input_name_important_part;
63 63
             }
64
-            $new_billing_info[ $new_input_name ] = $input_value;
64
+            $new_billing_info[$new_input_name] = $input_value;
65 65
         }
66 66
         update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
67 67
     }
@@ -74,6 +74,6 @@  discard block
 block discarded – undo
74 74
     protected function _get_state_name_by_ID($id)
75 75
     {
76 76
         global $wpdb;
77
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
77
+        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM ".$wpdb->prefix."esp_state WHERE STA_ID = %d", $id));
78 78
     }
79 79
 }
Please login to merge, or discard this patch.
Indentation   +64 added lines, -64 removed lines patch added patch discarded remove patch
@@ -11,69 +11,69 @@
 block discarded – undo
11 11
  */
12 12
 class EE_DMS_4_6_0_billing_info extends EE_Data_Migration_Script_Stage_Table
13 13
 {
14
-    public function __construct()
15
-    {
16
-        global $wpdb;
17
-        $this->_old_table = $wpdb->postmeta;
18
-        $this->_pretty_name = esc_html__('Billing Info', 'event_espresso');
19
-        $this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
20
-        parent::__construct();
21
-    }
22
-    protected function _migrate_old_row($old_row)
23
-    {
24
-        $new_billing_info = array();
25
-        $old_billing_info = maybe_unserialize($old_row['meta_value']);
26
-        $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
27
-        $repetitive_prefix = '_reg-page-billing-';
28
-        $repetitive_suffix = "-" . $gateway_name;
29
-        foreach ($old_billing_info as $old_input_name => $input_value) {
30
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
14
+	public function __construct()
15
+	{
16
+		global $wpdb;
17
+		$this->_old_table = $wpdb->postmeta;
18
+		$this->_pretty_name = esc_html__('Billing Info', 'event_espresso');
19
+		$this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
20
+		parent::__construct();
21
+	}
22
+	protected function _migrate_old_row($old_row)
23
+	{
24
+		$new_billing_info = array();
25
+		$old_billing_info = maybe_unserialize($old_row['meta_value']);
26
+		$gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
27
+		$repetitive_prefix = '_reg-page-billing-';
28
+		$repetitive_suffix = "-" . $gateway_name;
29
+		foreach ($old_billing_info as $old_input_name => $input_value) {
30
+			$old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
31 31
 
32
-            switch ($old_input_name_important_part) {
33
-                case 'fname':
34
-                    $new_input_name = 'first_name';
35
-                    break;
36
-                case 'lname':
37
-                    $new_input_name = 'last_name';
38
-                    break;
39
-                case 'state':
40
-                    // we used to store the state's id ,but now we just store the name
41
-                    $new_input_name = $old_input_name_important_part;
42
-                    $input_value = $this->_get_state_name_by_ID($input_value);
43
-                    break;
44
-                case 'card-nmbr':
45
-                    $new_input_name = 'credit_card';
46
-                    break;
47
-                case 'card-type':// paypal pro only
48
-                    $new_input_name = 'credit_card_type';
49
-                    break;
50
-                case 'card-exp-date-mnth':
51
-                    $new_input_name = 'exp_month';
52
-                    $input_value = '';
53
-                    break;
54
-                case 'card-exp-date-year':
55
-                    $new_input_name = 'exp_year';
56
-                    $input_value = 0;
57
-                    break;
58
-                case 'ccv-code':
59
-                    $new_input_name = 'cvv';
60
-                    break;
61
-                default:
62
-                    $new_input_name = $old_input_name_important_part;
63
-            }
64
-            $new_billing_info[ $new_input_name ] = $input_value;
65
-        }
66
-        update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
67
-    }
68
-    /**
69
-     *
70
-     * @global type $wpdb
71
-     * @param int $id
72
-     * @return string
73
-     */
74
-    protected function _get_state_name_by_ID($id)
75
-    {
76
-        global $wpdb;
77
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
78
-    }
32
+			switch ($old_input_name_important_part) {
33
+				case 'fname':
34
+					$new_input_name = 'first_name';
35
+					break;
36
+				case 'lname':
37
+					$new_input_name = 'last_name';
38
+					break;
39
+				case 'state':
40
+					// we used to store the state's id ,but now we just store the name
41
+					$new_input_name = $old_input_name_important_part;
42
+					$input_value = $this->_get_state_name_by_ID($input_value);
43
+					break;
44
+				case 'card-nmbr':
45
+					$new_input_name = 'credit_card';
46
+					break;
47
+				case 'card-type':// paypal pro only
48
+					$new_input_name = 'credit_card_type';
49
+					break;
50
+				case 'card-exp-date-mnth':
51
+					$new_input_name = 'exp_month';
52
+					$input_value = '';
53
+					break;
54
+				case 'card-exp-date-year':
55
+					$new_input_name = 'exp_year';
56
+					$input_value = 0;
57
+					break;
58
+				case 'ccv-code':
59
+					$new_input_name = 'cvv';
60
+					break;
61
+				default:
62
+					$new_input_name = $old_input_name_important_part;
63
+			}
64
+			$new_billing_info[ $new_input_name ] = $input_value;
65
+		}
66
+		update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
67
+	}
68
+	/**
69
+	 *
70
+	 * @global type $wpdb
71
+	 * @param int $id
72
+	 * @return string
73
+	 */
74
+	protected function _get_state_name_by_ID($id)
75
+	{
76
+		global $wpdb;
77
+		return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
78
+	}
79 79
 }
Please login to merge, or discard this patch.
4_9_0_stages/EE_DMS_4_9_0_Answers_With_No_Registration.dmsstage.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -48,9 +48,9 @@
 block discarded – undo
48 48
     {
49 49
         global $wpdb;
50 50
         $wpdb->delete(
51
-            $wpdb->prefix . 'esp_answer',
52
-            array( 'REG_ID' => 0 ),
53
-            array( '%d' )
51
+            $wpdb->prefix.'esp_answer',
52
+            array('REG_ID' => 0),
53
+            array('%d')
54 54
         );
55 55
         $this->set_completed();
56 56
         return 1;
Please login to merge, or discard this patch.
Indentation   +38 added lines, -38 removed lines patch added patch discarded remove patch
@@ -15,44 +15,44 @@
 block discarded – undo
15 15
 
16 16
 
17 17
 
18
-    /**
19
-     * Just initializes the status of the migration
20
-     *
21
-     * @return EE_DMS_4_9_0_Answers_With_No_Registration
22
-     */
23
-    public function __construct()
24
-    {
25
-        $this->_pretty_name = esc_html__('Answer Cleanup', 'event_espresso');
26
-        parent::__construct();
27
-    }
18
+	/**
19
+	 * Just initializes the status of the migration
20
+	 *
21
+	 * @return EE_DMS_4_9_0_Answers_With_No_Registration
22
+	 */
23
+	public function __construct()
24
+	{
25
+		$this->_pretty_name = esc_html__('Answer Cleanup', 'event_espresso');
26
+		parent::__construct();
27
+	}
28 28
 
29
-    /**
30
-     * Counts the records to migrate; the public version may cache it
31
-     * @return int
32
-     */
33
-    protected function _count_records_to_migrate()
34
-    {
35
-        return 1;
36
-    }
29
+	/**
30
+	 * Counts the records to migrate; the public version may cache it
31
+	 * @return int
32
+	 */
33
+	protected function _count_records_to_migrate()
34
+	{
35
+		return 1;
36
+	}
37 37
 
38
-    /**
39
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
40
-     * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
41
-     * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
42
-     * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
43
-     * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
44
-     * @param int $num_items_to_migrate
45
-     * @return int number of items ACTUALLY migrated
46
-     */
47
-    protected function _migration_step($num_items_to_migrate = 50)
48
-    {
49
-        global $wpdb;
50
-        $wpdb->delete(
51
-            $wpdb->prefix . 'esp_answer',
52
-            array( 'REG_ID' => 0 ),
53
-            array( '%d' )
54
-        );
55
-        $this->set_completed();
56
-        return 1;
57
-    }
38
+	/**
39
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
40
+	 * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
41
+	 * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
42
+	 * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
43
+	 * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
44
+	 * @param int $num_items_to_migrate
45
+	 * @return int number of items ACTUALLY migrated
46
+	 */
47
+	protected function _migration_step($num_items_to_migrate = 50)
48
+	{
49
+		global $wpdb;
50
+		$wpdb->delete(
51
+			$wpdb->prefix . 'esp_answer',
52
+			array( 'REG_ID' => 0 ),
53
+			array( '%d' )
54
+		);
55
+		$this->set_completed();
56
+		return 1;
57
+	}
58 58
 }
Please login to merge, or discard this patch.
core/data_migration_scripts/EE_Data_Migration_Script_Stage.core.php 1 patch
Indentation   +90 added lines, -90 removed lines patch added patch discarded remove patch
@@ -37,103 +37,103 @@
 block discarded – undo
37 37
  */
38 38
 abstract class EE_Data_Migration_Script_Stage extends EE_Data_Migration_Class_Base
39 39
 {
40
-    /**
41
-     * The migration script this is a stage of
42
-     *
43
-     * @var EE_Data_Migration_Script_Base
44
-     */
45
-    protected $_migration_script;
40
+	/**
41
+	 * The migration script this is a stage of
42
+	 *
43
+	 * @var EE_Data_Migration_Script_Base
44
+	 */
45
+	protected $_migration_script;
46 46
 
47
-    /**
48
-     * This should eb called to essentially 'finalize' construction of the stage.
49
-     * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
50
-     * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
51
-     *
52
-     * @param EE_Data_Migration_Script_Base $migration_script
53
-     */
54
-    public function _construct_finalize($migration_script)
55
-    {
56
-        $this->_migration_script = $migration_script;
57
-    }
47
+	/**
48
+	 * This should eb called to essentially 'finalize' construction of the stage.
49
+	 * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
50
+	 * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
51
+	 *
52
+	 * @param EE_Data_Migration_Script_Base $migration_script
53
+	 */
54
+	public function _construct_finalize($migration_script)
55
+	{
56
+		$this->_migration_script = $migration_script;
57
+	}
58 58
 
59
-    /**
60
-     * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
61
-     * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
62
-     * needs to catch exceptions and decide what's a fatal error and what isn't.
63
-     *
64
-     * @param int $num_items_to_migrate
65
-     * @return int
66
-     */
67
-    public function migration_step($num_items_to_migrate = 50)
68
-    {
69
-        // before we run the migration step, we want ot take note of warnings that get outputted
70
-        ob_start();
71
-        $items_migrated = $this->_migration_step($num_items_to_migrate);
72
-        $output = ob_get_contents();
73
-        ob_end_clean();
74
-        if ($output) {
75
-            $this->add_error($output);
76
-        }
77
-        $this->_records_migrated += $items_migrated;
78
-        return $items_migrated;
79
-    }
59
+	/**
60
+	 * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
61
+	 * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
62
+	 * needs to catch exceptions and decide what's a fatal error and what isn't.
63
+	 *
64
+	 * @param int $num_items_to_migrate
65
+	 * @return int
66
+	 */
67
+	public function migration_step($num_items_to_migrate = 50)
68
+	{
69
+		// before we run the migration step, we want ot take note of warnings that get outputted
70
+		ob_start();
71
+		$items_migrated = $this->_migration_step($num_items_to_migrate);
72
+		$output = ob_get_contents();
73
+		ob_end_clean();
74
+		if ($output) {
75
+			$this->add_error($output);
76
+		}
77
+		$this->_records_migrated += $items_migrated;
78
+		return $items_migrated;
79
+	}
80 80
 
81 81
 
82
-    /**
83
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
84
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
85
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
86
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
87
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
88
-     * very least we MUST report/return 50 items migrated)
89
-     *
90
-     * @param int $num_items_to_migrate
91
-     * @return int number of items ACTUALLY migrated
92
-     */
93
-    abstract protected function _migration_step($num_items_to_migrate = 50);
82
+	/**
83
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
84
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
85
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
86
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
87
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
88
+	 * very least we MUST report/return 50 items migrated)
89
+	 *
90
+	 * @param int $num_items_to_migrate
91
+	 * @return int number of items ACTUALLY migrated
92
+	 */
93
+	abstract protected function _migration_step($num_items_to_migrate = 50);
94 94
 
95
-    /**
96
-     * Counts the records that have been migrated so far
97
-     *
98
-     * @return int
99
-     */
100
-    public function count_records_migrated()
101
-    {
102
-        return $this->_records_migrated;
103
-    }
95
+	/**
96
+	 * Counts the records that have been migrated so far
97
+	 *
98
+	 * @return int
99
+	 */
100
+	public function count_records_migrated()
101
+	{
102
+		return $this->_records_migrated;
103
+	}
104 104
 
105
-    /**
106
-     * returns an array of strings describing errors
107
-     *
108
-     * @return array
109
-     */
110
-    public function get_errors()
111
-    {
112
-        return $this->_errors;
113
-    }
105
+	/**
106
+	 * returns an array of strings describing errors
107
+	 *
108
+	 * @return array
109
+	 */
110
+	public function get_errors()
111
+	{
112
+		return $this->_errors;
113
+	}
114 114
 
115 115
 
116
-    /**
117
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
118
-     * to have been made from the properties_as_array() function.
119
-     *
120
-     * @param array $array_of_properties like what's produced from properties_as_array() method
121
-     */
122
-    public function instantiate_from_array_of_properties($array_of_properties)
123
-    {
124
-        unset($array_of_properties['class']);
125
-        foreach ($array_of_properties as $property_name => $property_value) {
126
-            $this->{$property_name} = $property_value;
127
-        }
128
-    }
116
+	/**
117
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
118
+	 * to have been made from the properties_as_array() function.
119
+	 *
120
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
121
+	 */
122
+	public function instantiate_from_array_of_properties($array_of_properties)
123
+	{
124
+		unset($array_of_properties['class']);
125
+		foreach ($array_of_properties as $property_name => $property_value) {
126
+			$this->{$property_name} = $property_value;
127
+		}
128
+	}
129 129
 
130
-    /**
131
-     * Gets the script this is a stage of
132
-     *
133
-     * @return EE_Data_Migration_Script_Base
134
-     */
135
-    protected function get_migration_script()
136
-    {
137
-        return $this->_migration_script;
138
-    }
130
+	/**
131
+	 * Gets the script this is a stage of
132
+	 *
133
+	 * @return EE_Data_Migration_Script_Base
134
+	 */
135
+	protected function get_migration_script()
136
+	{
137
+		return $this->_migration_script;
138
+	}
139 139
 }
Please login to merge, or discard this patch.
core/EE_Object_Repository.core.php 1 patch
Indentation   +86 added lines, -86 removed lines patch added patch discarded remove patch
@@ -16,98 +16,98 @@
 block discarded – undo
16 16
 abstract class EE_Object_Repository extends EE_Object_Collection implements EEI_Repository
17 17
 {
18 18
 
19
-    /**
20
-     * default persist method called on repository objects if none supplied
21
-     *
22
-     * @type string $persist_method
23
-     */
24
-    protected $persist_method;
19
+	/**
20
+	 * default persist method called on repository objects if none supplied
21
+	 *
22
+	 * @type string $persist_method
23
+	 */
24
+	protected $persist_method;
25 25
 
26 26
 
27
-    /**
28
-     * _call_user_func_array_on_current
29
-     *
30
-     * calls the supplied callback method name on the current repository object,
31
-     * an array of arguments can also be supplied that will be passed along to the callback method,
32
-     * where each element of the $arguments array corresponds to a parameter for the callback method
33
-     * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
34
-     * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
35
-     *
36
-     * @access public
37
-     * @param string $callback  name of method found on object to be called.
38
-     * @param array  $arguments arrays of arguments that will be passed to the object's callback method
39
-     * @return bool | int
40
-     */
41
-    protected function _call_user_func_array_on_current($callback = '', $arguments = array())
42
-    {
43
-        if ($callback !== '' && method_exists($this->current(), $callback)) {
44
-            return call_user_func_array(array($this->current(), $callback), $arguments);
45
-        }
46
-        return false;
47
-    }
27
+	/**
28
+	 * _call_user_func_array_on_current
29
+	 *
30
+	 * calls the supplied callback method name on the current repository object,
31
+	 * an array of arguments can also be supplied that will be passed along to the callback method,
32
+	 * where each element of the $arguments array corresponds to a parameter for the callback method
33
+	 * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
34
+	 * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
35
+	 *
36
+	 * @access public
37
+	 * @param string $callback  name of method found on object to be called.
38
+	 * @param array  $arguments arrays of arguments that will be passed to the object's callback method
39
+	 * @return bool | int
40
+	 */
41
+	protected function _call_user_func_array_on_current($callback = '', $arguments = array())
42
+	{
43
+		if ($callback !== '' && method_exists($this->current(), $callback)) {
44
+			return call_user_func_array(array($this->current(), $callback), $arguments);
45
+		}
46
+		return false;
47
+	}
48 48
 
49 49
 
50
-    /**
51
-     * _call_user_func_on_all
52
-     *
53
-     * calls the supplied callback method name on ALL repository objects,
54
-     *
55
-     * @access public
56
-     * @param string $callback name of method found on repository objects to be called
57
-     * @return bool | int
58
-     */
59
-    protected function _call_user_func_on_all($callback = '')
60
-    {
61
-        $success = true;
62
-        if ($this->valid()) {
63
-            $this->rewind();
64
-            while ($this->valid()) {
65
-                // any negative result will toggle success to false
66
-                $success = $this->_call_user_func_array_on_current($callback) ? $success : false;
67
-                $this->next();
68
-            }
69
-            $this->rewind();
70
-        }
71
-        return $success;
72
-    }
50
+	/**
51
+	 * _call_user_func_on_all
52
+	 *
53
+	 * calls the supplied callback method name on ALL repository objects,
54
+	 *
55
+	 * @access public
56
+	 * @param string $callback name of method found on repository objects to be called
57
+	 * @return bool | int
58
+	 */
59
+	protected function _call_user_func_on_all($callback = '')
60
+	{
61
+		$success = true;
62
+		if ($this->valid()) {
63
+			$this->rewind();
64
+			while ($this->valid()) {
65
+				// any negative result will toggle success to false
66
+				$success = $this->_call_user_func_array_on_current($callback) ? $success : false;
67
+				$this->next();
68
+			}
69
+			$this->rewind();
70
+		}
71
+		return $success;
72
+	}
73 73
 
74 74
 
75
-    /**
76
-     * persist
77
-     *
78
-     * primarily used for saving EE_Base_Class classes to the database,
79
-     * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
80
-     * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
81
-     * arguments can also be supplied that will be passed along to the object's persistence method
82
-     *
83
-     * @access public
84
-     * @param string $persistence_callback                                    name of method found on object that can
85
-     *                                                                        be used for persisting the object
86
-     *                                                                        defaults to
87
-     *                                                                        EE_Object_Repository::$persist_method
88
-     * @param array  $persistence_arguments                                   arrays of arguments that will be passed
89
-     *                                                                        to the object's persistence method
90
-     * @return bool | int
91
-     */
92
-    public function persist($persistence_callback = '', $persistence_arguments = array())
93
-    {
94
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
95
-        return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
96
-    }
75
+	/**
76
+	 * persist
77
+	 *
78
+	 * primarily used for saving EE_Base_Class classes to the database,
79
+	 * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
80
+	 * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
81
+	 * arguments can also be supplied that will be passed along to the object's persistence method
82
+	 *
83
+	 * @access public
84
+	 * @param string $persistence_callback                                    name of method found on object that can
85
+	 *                                                                        be used for persisting the object
86
+	 *                                                                        defaults to
87
+	 *                                                                        EE_Object_Repository::$persist_method
88
+	 * @param array  $persistence_arguments                                   arrays of arguments that will be passed
89
+	 *                                                                        to the object's persistence method
90
+	 * @return bool | int
91
+	 */
92
+	public function persist($persistence_callback = '', $persistence_arguments = array())
93
+	{
94
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
95
+		return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
96
+	}
97 97
 
98 98
 
99
-    /**
100
-     * persist_all
101
-     *
102
-     * calls \EE_Object_Repository::persist() on all objects within the repository
103
-     *
104
-     * @access public
105
-     * @param string $persistence_callback name of method found on object that can be used for persisting the object
106
-     * @return bool | int
107
-     */
108
-    public function persist_all($persistence_callback = '')
109
-    {
110
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
111
-        return $this->_call_user_func_on_all($persistence_callback);
112
-    }
99
+	/**
100
+	 * persist_all
101
+	 *
102
+	 * calls \EE_Object_Repository::persist() on all objects within the repository
103
+	 *
104
+	 * @access public
105
+	 * @param string $persistence_callback name of method found on object that can be used for persisting the object
106
+	 * @return bool | int
107
+	 */
108
+	public function persist_all($persistence_callback = '')
109
+	{
110
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
111
+		return $this->_call_user_func_on_all($persistence_callback);
112
+	}
113 113
 }
Please login to merge, or discard this patch.
core/admin/EE_Help_Tour.core.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -256,8 +256,8 @@  discard block
 block discarded – undo
256 256
     public function get_stops()
257 257
     {
258 258
         foreach ($this->_stops as $ind => $stop) {
259
-            if (! isset($stop['button_text'])) {
260
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
259
+            if ( ! isset($stop['button_text'])) {
260
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
261 261
             }
262 262
         }
263 263
         return $this->_stops;
@@ -277,6 +277,6 @@  discard block
 block discarded – undo
277 277
                 $this->_options['pauseAfter'][] = $ind;
278 278
             }
279 279
         }
280
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
280
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
281 281
     }
282 282
 }
Please login to merge, or discard this patch.
Indentation   +267 added lines, -267 removed lines patch added patch discarded remove patch
@@ -18,271 +18,271 @@
 block discarded – undo
18 18
 abstract class EE_Help_Tour extends EE_Base
19 19
 {
20 20
 
21
-    /**
22
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
23
-     * constructor of the child class.
24
-     *
25
-     * @access protected
26
-     * @var string
27
-     */
28
-    protected $_label = '';
29
-
30
-
31
-    /**
32
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
33
-     * cookies for the tour. Set this in the constructor of the child class.
34
-     *
35
-     * @access protected
36
-     * @var string
37
-     */
38
-    protected $_slug = '';
39
-
40
-
41
-    /**
42
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
43
-     * setting up a tour on a given page. format for array is: array(
44
-     *        0 => array(
45
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
46
-     *            precendence even if you also set class.
47
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
48
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
49
-     *            stop will be a modal on the page anchored to the main body.
50
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
51
-     *            'button_text' => 'custom text for button', //optional
52
-     *            'content' => 'The content for the stop', //required
53
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
54
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
55
-     *            when this tour has been set to run on timer.
56
-     *            'options' => array(
57
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
58
-     *                instance on this specific stop.
59
-     *                )
60
-     *            )
61
-     *        );
62
-     *
63
-     * @access protected
64
-     * @var array
65
-     */
66
-    protected $_stops = array();
67
-
68
-
69
-    /**
70
-     * This contains any stop specific options for the tour.
71
-     * defaults are set but child classes can override.
72
-     *
73
-     * @access protected
74
-     * @var array
75
-     */
76
-    protected $_options = array();
77
-
78
-
79
-    /**
80
-     * holds anything found in the request object (however we override any _gets with _post data).
81
-     *
82
-     * @access protected
83
-     * @var array
84
-     */
85
-    protected $_req_data = array();
86
-
87
-
88
-    /**
89
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
90
-     *
91
-     * @var boolean
92
-     */
93
-    protected $_is_caf = false;
94
-
95
-
96
-    /**
97
-     * _constructor
98
-     * initialized the tour object and sets up important properties required to setup the tour.
99
-     *
100
-     * @access public
101
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
102
-     * @return void
103
-     */
104
-    public function __construct($caf = false)
105
-    {
106
-        $this->_is_caf = $caf;
107
-        /** @var RequestInterface $request */
108
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
109
-        $this->_req_data = $request->requestParams();
110
-        $this->_set_tour_properties();
111
-        $this->_set_tour_stops();
112
-        $this->_set_tour_options();
113
-
114
-        // make sure the last tour stop has "end tour" for its button
115
-        $end = array_pop($this->_stops);
116
-        $end['button_text'] = esc_html__('End Tour', 'event_espresso');
117
-        // add back to stops
118
-        $this->_stops[] = $end;
119
-    }
120
-
121
-
122
-    /**
123
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
124
-     *
125
-     * @abstract
126
-     * @access protected
127
-     * @return void
128
-     */
129
-    abstract protected function _set_tour_properties();
130
-
131
-
132
-    /**
133
-     * required method that's sole purpose is to setup the $_stops property
134
-     *
135
-     * @abstract
136
-     * @access protected
137
-     * @return void
138
-     */
139
-    abstract protected function _set_tour_stops();
140
-
141
-
142
-    /**
143
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
144
-     * options the child wishes to override for a this tour. See property definition for more info
145
-     *
146
-     * @access protected
147
-     * @return void
148
-     */
149
-    protected function _set_tour_options($options = array())
150
-    {
151
-        $defaults = array(
152
-            'tipLocation'           => 'bottom',
153
-            // 'top', 'bottom', 'right', 'left' in relation to parent
154
-            'nubPosition'           => 'auto',
155
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
156
-            'tipAdjustmentY'        => 0,
157
-            // allow for adjustment of tip
158
-            'tipAdjustmentX'        => 0,
159
-            // allow for adjustment of tip
160
-            'scroll'                => true,
161
-            // whether to scrollTo the next step or not
162
-            'scrollSpeed'           => 300,
163
-            // Page scrolling speed in ms
164
-            'timer'                 => 0,
165
-            // 0 = off, all other numbers = time(ms)
166
-            'autoStart'             => true,
167
-            // true or false - false tour starts when restart called
168
-            'startTimerOnClick'     => true,
169
-            // true/false to start timer on first click
170
-            'nextButton'            => true,
171
-            // true/false for next button visibility
172
-            'button_text'           => esc_html__('Next', 'event_espresso'),
173
-            'tipAnimation'          => 'fade',
174
-            // 'pop' or 'fade' in each tip
175
-            'pauseAfter'            => array(),
176
-            // array of indexes where to pause the tour after
177
-            'tipAnimationFadeSpeed' => 300,
178
-            // if 'fade'- speed in ms of transition
179
-            'cookieMonster'         => true,
180
-            // true/false for whether cookies are used
181
-            'cookieName'            => $this->get_slug(),
182
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
183
-            // set to false or yoursite.com
184
-            'cookieDomain'          => false,
185
-            // Where the tip be attached if not inline
186
-            // 'tipContainer' => 'body',
187
-            'modal'                 => false,
188
-            // Whether to cover page with modal during the tour
189
-            'expose'                => false,
190
-            // Whether to expose the elements at each step in the tour (requires modal:true),
191
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
192
-            // A method to call after an element has been exposed
193
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
194
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
195
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
196
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
197
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
198
-            // A method to call before each step
199
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
200
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
201
-        );
202
-
203
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
204
-        $this->_options = $options;
205
-    }
206
-
207
-
208
-    /**
209
-     * getter functions to return all the properties for the tour.
210
-     */
211
-
212
-
213
-    /**
214
-     * get_slug
215
-     *
216
-     * @return string slug for the tour
217
-     */
218
-    public function get_slug()
219
-    {
220
-        if (empty($this->_slug)) {
221
-            throw new EE_Error(
222
-                sprintf(
223
-                    esc_html__(
224
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
225
-                        'event_espresso'
226
-                    ),
227
-                    get_class($this)
228
-                )
229
-            );
230
-        }
231
-        return $this->_slug;
232
-    }
233
-
234
-
235
-    /**
236
-     * get_label
237
-     *
238
-     * @return string
239
-     */
240
-    public function get_label()
241
-    {
242
-        if (empty($this->_label)) {
243
-            throw new EE_Error(
244
-                sprintf(
245
-                    esc_html__(
246
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
247
-                        'event_espresso'
248
-                    ),
249
-                    get_class($this)
250
-                )
251
-            );
252
-        }
253
-        return $this->_label;
254
-    }
255
-
256
-
257
-    /**
258
-     * get_stops
259
-     *
260
-     * @return array
261
-     */
262
-    public function get_stops()
263
-    {
264
-        foreach ($this->_stops as $ind => $stop) {
265
-            if (! isset($stop['button_text'])) {
266
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
267
-            }
268
-        }
269
-        return $this->_stops;
270
-    }
271
-
272
-
273
-    /**
274
-     * get options
275
-     *
276
-     * @return array
277
-     */
278
-    public function get_options()
279
-    {
280
-        // let's make sure there are not pauses set
281
-        foreach ($this->_stops as $ind => $stop) {
282
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
283
-                $this->_options['pauseAfter'][] = $ind;
284
-            }
285
-        }
286
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
287
-    }
21
+	/**
22
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
23
+	 * constructor of the child class.
24
+	 *
25
+	 * @access protected
26
+	 * @var string
27
+	 */
28
+	protected $_label = '';
29
+
30
+
31
+	/**
32
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
33
+	 * cookies for the tour. Set this in the constructor of the child class.
34
+	 *
35
+	 * @access protected
36
+	 * @var string
37
+	 */
38
+	protected $_slug = '';
39
+
40
+
41
+	/**
42
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
43
+	 * setting up a tour on a given page. format for array is: array(
44
+	 *        0 => array(
45
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
46
+	 *            precendence even if you also set class.
47
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
48
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
49
+	 *            stop will be a modal on the page anchored to the main body.
50
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
51
+	 *            'button_text' => 'custom text for button', //optional
52
+	 *            'content' => 'The content for the stop', //required
53
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
54
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
55
+	 *            when this tour has been set to run on timer.
56
+	 *            'options' => array(
57
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
58
+	 *                instance on this specific stop.
59
+	 *                )
60
+	 *            )
61
+	 *        );
62
+	 *
63
+	 * @access protected
64
+	 * @var array
65
+	 */
66
+	protected $_stops = array();
67
+
68
+
69
+	/**
70
+	 * This contains any stop specific options for the tour.
71
+	 * defaults are set but child classes can override.
72
+	 *
73
+	 * @access protected
74
+	 * @var array
75
+	 */
76
+	protected $_options = array();
77
+
78
+
79
+	/**
80
+	 * holds anything found in the request object (however we override any _gets with _post data).
81
+	 *
82
+	 * @access protected
83
+	 * @var array
84
+	 */
85
+	protected $_req_data = array();
86
+
87
+
88
+	/**
89
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
90
+	 *
91
+	 * @var boolean
92
+	 */
93
+	protected $_is_caf = false;
94
+
95
+
96
+	/**
97
+	 * _constructor
98
+	 * initialized the tour object and sets up important properties required to setup the tour.
99
+	 *
100
+	 * @access public
101
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
102
+	 * @return void
103
+	 */
104
+	public function __construct($caf = false)
105
+	{
106
+		$this->_is_caf = $caf;
107
+		/** @var RequestInterface $request */
108
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
109
+		$this->_req_data = $request->requestParams();
110
+		$this->_set_tour_properties();
111
+		$this->_set_tour_stops();
112
+		$this->_set_tour_options();
113
+
114
+		// make sure the last tour stop has "end tour" for its button
115
+		$end = array_pop($this->_stops);
116
+		$end['button_text'] = esc_html__('End Tour', 'event_espresso');
117
+		// add back to stops
118
+		$this->_stops[] = $end;
119
+	}
120
+
121
+
122
+	/**
123
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
124
+	 *
125
+	 * @abstract
126
+	 * @access protected
127
+	 * @return void
128
+	 */
129
+	abstract protected function _set_tour_properties();
130
+
131
+
132
+	/**
133
+	 * required method that's sole purpose is to setup the $_stops property
134
+	 *
135
+	 * @abstract
136
+	 * @access protected
137
+	 * @return void
138
+	 */
139
+	abstract protected function _set_tour_stops();
140
+
141
+
142
+	/**
143
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
144
+	 * options the child wishes to override for a this tour. See property definition for more info
145
+	 *
146
+	 * @access protected
147
+	 * @return void
148
+	 */
149
+	protected function _set_tour_options($options = array())
150
+	{
151
+		$defaults = array(
152
+			'tipLocation'           => 'bottom',
153
+			// 'top', 'bottom', 'right', 'left' in relation to parent
154
+			'nubPosition'           => 'auto',
155
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
156
+			'tipAdjustmentY'        => 0,
157
+			// allow for adjustment of tip
158
+			'tipAdjustmentX'        => 0,
159
+			// allow for adjustment of tip
160
+			'scroll'                => true,
161
+			// whether to scrollTo the next step or not
162
+			'scrollSpeed'           => 300,
163
+			// Page scrolling speed in ms
164
+			'timer'                 => 0,
165
+			// 0 = off, all other numbers = time(ms)
166
+			'autoStart'             => true,
167
+			// true or false - false tour starts when restart called
168
+			'startTimerOnClick'     => true,
169
+			// true/false to start timer on first click
170
+			'nextButton'            => true,
171
+			// true/false for next button visibility
172
+			'button_text'           => esc_html__('Next', 'event_espresso'),
173
+			'tipAnimation'          => 'fade',
174
+			// 'pop' or 'fade' in each tip
175
+			'pauseAfter'            => array(),
176
+			// array of indexes where to pause the tour after
177
+			'tipAnimationFadeSpeed' => 300,
178
+			// if 'fade'- speed in ms of transition
179
+			'cookieMonster'         => true,
180
+			// true/false for whether cookies are used
181
+			'cookieName'            => $this->get_slug(),
182
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
183
+			// set to false or yoursite.com
184
+			'cookieDomain'          => false,
185
+			// Where the tip be attached if not inline
186
+			// 'tipContainer' => 'body',
187
+			'modal'                 => false,
188
+			// Whether to cover page with modal during the tour
189
+			'expose'                => false,
190
+			// Whether to expose the elements at each step in the tour (requires modal:true),
191
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
192
+			// A method to call after an element has been exposed
193
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
194
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
195
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
196
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
197
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
198
+			// A method to call before each step
199
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
200
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
201
+		);
202
+
203
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
204
+		$this->_options = $options;
205
+	}
206
+
207
+
208
+	/**
209
+	 * getter functions to return all the properties for the tour.
210
+	 */
211
+
212
+
213
+	/**
214
+	 * get_slug
215
+	 *
216
+	 * @return string slug for the tour
217
+	 */
218
+	public function get_slug()
219
+	{
220
+		if (empty($this->_slug)) {
221
+			throw new EE_Error(
222
+				sprintf(
223
+					esc_html__(
224
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
225
+						'event_espresso'
226
+					),
227
+					get_class($this)
228
+				)
229
+			);
230
+		}
231
+		return $this->_slug;
232
+	}
233
+
234
+
235
+	/**
236
+	 * get_label
237
+	 *
238
+	 * @return string
239
+	 */
240
+	public function get_label()
241
+	{
242
+		if (empty($this->_label)) {
243
+			throw new EE_Error(
244
+				sprintf(
245
+					esc_html__(
246
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
247
+						'event_espresso'
248
+					),
249
+					get_class($this)
250
+				)
251
+			);
252
+		}
253
+		return $this->_label;
254
+	}
255
+
256
+
257
+	/**
258
+	 * get_stops
259
+	 *
260
+	 * @return array
261
+	 */
262
+	public function get_stops()
263
+	{
264
+		foreach ($this->_stops as $ind => $stop) {
265
+			if (! isset($stop['button_text'])) {
266
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
267
+			}
268
+		}
269
+		return $this->_stops;
270
+	}
271
+
272
+
273
+	/**
274
+	 * get options
275
+	 *
276
+	 * @return array
277
+	 */
278
+	public function get_options()
279
+	{
280
+		// let's make sure there are not pauses set
281
+		foreach ($this->_stops as $ind => $stop) {
282
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
283
+				$this->_options['pauseAfter'][] = $ind;
284
+			}
285
+		}
286
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
287
+	}
288 288
 }
Please login to merge, or discard this patch.