@@ -21,192 +21,192 @@ |
||
21 | 21 | { |
22 | 22 | |
23 | 23 | |
24 | - /** |
|
25 | - * AssetCollection constructor |
|
26 | - * |
|
27 | - * @throws InvalidInterfaceException |
|
28 | - */ |
|
29 | - public function __construct() |
|
30 | - { |
|
31 | - parent::__construct('EventEspresso\core\domain\values\assets\Asset'); |
|
32 | - } |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * @return StylesheetAsset[] |
|
37 | - * @since 4.9.62.p |
|
38 | - */ |
|
39 | - public function getStylesheetAssets() |
|
40 | - { |
|
41 | - return $this->getAssetsOfType(Asset::TYPE_CSS); |
|
42 | - } |
|
43 | - |
|
44 | - |
|
45 | - /** |
|
46 | - * @return JavascriptAsset[] |
|
47 | - * @since 4.9.62.p |
|
48 | - */ |
|
49 | - public function getJavascriptAssets() |
|
50 | - { |
|
51 | - return $this->getAssetsOfType(Asset::TYPE_JS); |
|
52 | - } |
|
53 | - |
|
54 | - |
|
55 | - /** |
|
56 | - * @return ManifestFile[] |
|
57 | - * @since 4.9.62.p |
|
58 | - */ |
|
59 | - public function getManifestFiles() |
|
60 | - { |
|
61 | - return $this->getAssetsOfType(Asset::TYPE_MANIFEST); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @param $type |
|
67 | - * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[] |
|
68 | - * @since 4.9.62.p |
|
69 | - */ |
|
70 | - protected function getAssetsOfType($type) |
|
71 | - { |
|
72 | - $files = array(); |
|
73 | - $this->rewind(); |
|
74 | - while ($this->valid()) { |
|
75 | - /** @var Asset $asset */ |
|
76 | - $asset = $this->current(); |
|
77 | - if ($asset->type() === $type) { |
|
78 | - $files[ $asset->handle() ] = $asset; |
|
79 | - } |
|
80 | - $this->next(); |
|
81 | - } |
|
82 | - $this->rewind(); |
|
83 | - return $files; |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * @return JavascriptAsset[] |
|
89 | - * @since 4.9.62.p |
|
90 | - */ |
|
91 | - public function getJavascriptAssetsWithData() |
|
92 | - { |
|
93 | - $files = array(); |
|
94 | - $this->rewind(); |
|
95 | - while ($this->valid()) { |
|
96 | - /** @var JavascriptAsset $asset */ |
|
97 | - $asset = $this->current(); |
|
98 | - if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) { |
|
99 | - $files[ $asset->handle() ] = $asset; |
|
100 | - } |
|
101 | - $this->next(); |
|
102 | - } |
|
103 | - $this->rewind(); |
|
104 | - return $files; |
|
105 | - } |
|
106 | - |
|
107 | - |
|
108 | - /** |
|
109 | - * returns TRUE or FALSE |
|
110 | - * depending on whether the object is within the Collection |
|
111 | - * based on the supplied $identifier and type |
|
112 | - * |
|
113 | - * @param mixed $identifier |
|
114 | - * @param string $type |
|
115 | - * @return bool |
|
116 | - * @since 4.9.63.p |
|
117 | - */ |
|
118 | - public function hasAssetOfType($identifier, $type = Asset::TYPE_JS) |
|
119 | - { |
|
120 | - $this->rewind(); |
|
121 | - while ($this->valid()) { |
|
122 | - if ($this->getInfo() === $identifier && $this->current()->type() === $type) { |
|
123 | - $this->rewind(); |
|
124 | - return true; |
|
125 | - } |
|
126 | - $this->next(); |
|
127 | - } |
|
128 | - return false; |
|
129 | - } |
|
130 | - |
|
131 | - |
|
132 | - /** |
|
133 | - * returns TRUE or FALSE |
|
134 | - * depending on whether the Javascript Asset is within the Collection |
|
135 | - * based on the supplied $identifier |
|
136 | - * |
|
137 | - * @param mixed $identifier |
|
138 | - * @return bool |
|
139 | - * @since 4.9.63.p |
|
140 | - */ |
|
141 | - public function hasJavascriptAsset($identifier) |
|
142 | - { |
|
143 | - return $this->hasAssetOfType($identifier, Asset::TYPE_JS); |
|
144 | - } |
|
145 | - |
|
146 | - |
|
147 | - /** |
|
148 | - * returns TRUE or FALSE |
|
149 | - * depending on whether the Stylesheet Asset is within the Collection |
|
150 | - * based on the supplied $identifier |
|
151 | - * |
|
152 | - * @param mixed $identifier |
|
153 | - * @return bool |
|
154 | - * @since 4.9.63.p |
|
155 | - */ |
|
156 | - public function hasStylesheetAsset($identifier) |
|
157 | - { |
|
158 | - return $this->hasAssetOfType($identifier, Asset::TYPE_CSS); |
|
159 | - } |
|
160 | - |
|
161 | - /** |
|
162 | - * returns the object from the Collection |
|
163 | - * based on the supplied $identifier and type |
|
164 | - * |
|
165 | - * @param mixed $identifier |
|
166 | - * @param string $type |
|
167 | - * @return JavascriptAsset|StylesheetAsset |
|
168 | - * @since 4.9.63.p |
|
169 | - */ |
|
170 | - public function getAssetOfType($identifier, $type = Asset::TYPE_JS) |
|
171 | - { |
|
172 | - $this->rewind(); |
|
173 | - while ($this->valid()) { |
|
174 | - if ($this->getInfo() === $identifier && $this->current()->type() === $type) { |
|
175 | - /** @var JavascriptAsset|StylesheetAsset $object */ |
|
176 | - $object = $this->current(); |
|
177 | - $this->rewind(); |
|
178 | - return $object; |
|
179 | - } |
|
180 | - $this->next(); |
|
181 | - } |
|
182 | - return null; |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - /** |
|
187 | - * returns the Stylesheet Asset from the Collection |
|
188 | - * based on the supplied $identifier |
|
189 | - * |
|
190 | - * @param mixed $identifier |
|
191 | - * @return StylesheetAsset |
|
192 | - * @since 4.9.63.p |
|
193 | - */ |
|
194 | - public function getStylesheetAsset($identifier) |
|
195 | - { |
|
196 | - return $this->getAssetOfType($identifier, Asset::TYPE_CSS); |
|
197 | - } |
|
198 | - |
|
199 | - |
|
200 | - /** |
|
201 | - * returns the Javascript Asset from the Collection |
|
202 | - * based on the supplied $identifier |
|
203 | - * |
|
204 | - * @param mixed $identifier |
|
205 | - * @return JavascriptAsset |
|
206 | - * @since 4.9.63.p |
|
207 | - */ |
|
208 | - public function getJavascriptAsset($identifier) |
|
209 | - { |
|
210 | - return $this->getAssetOfType($identifier, Asset::TYPE_JS); |
|
211 | - } |
|
24 | + /** |
|
25 | + * AssetCollection constructor |
|
26 | + * |
|
27 | + * @throws InvalidInterfaceException |
|
28 | + */ |
|
29 | + public function __construct() |
|
30 | + { |
|
31 | + parent::__construct('EventEspresso\core\domain\values\assets\Asset'); |
|
32 | + } |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * @return StylesheetAsset[] |
|
37 | + * @since 4.9.62.p |
|
38 | + */ |
|
39 | + public function getStylesheetAssets() |
|
40 | + { |
|
41 | + return $this->getAssetsOfType(Asset::TYPE_CSS); |
|
42 | + } |
|
43 | + |
|
44 | + |
|
45 | + /** |
|
46 | + * @return JavascriptAsset[] |
|
47 | + * @since 4.9.62.p |
|
48 | + */ |
|
49 | + public function getJavascriptAssets() |
|
50 | + { |
|
51 | + return $this->getAssetsOfType(Asset::TYPE_JS); |
|
52 | + } |
|
53 | + |
|
54 | + |
|
55 | + /** |
|
56 | + * @return ManifestFile[] |
|
57 | + * @since 4.9.62.p |
|
58 | + */ |
|
59 | + public function getManifestFiles() |
|
60 | + { |
|
61 | + return $this->getAssetsOfType(Asset::TYPE_MANIFEST); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @param $type |
|
67 | + * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[] |
|
68 | + * @since 4.9.62.p |
|
69 | + */ |
|
70 | + protected function getAssetsOfType($type) |
|
71 | + { |
|
72 | + $files = array(); |
|
73 | + $this->rewind(); |
|
74 | + while ($this->valid()) { |
|
75 | + /** @var Asset $asset */ |
|
76 | + $asset = $this->current(); |
|
77 | + if ($asset->type() === $type) { |
|
78 | + $files[ $asset->handle() ] = $asset; |
|
79 | + } |
|
80 | + $this->next(); |
|
81 | + } |
|
82 | + $this->rewind(); |
|
83 | + return $files; |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * @return JavascriptAsset[] |
|
89 | + * @since 4.9.62.p |
|
90 | + */ |
|
91 | + public function getJavascriptAssetsWithData() |
|
92 | + { |
|
93 | + $files = array(); |
|
94 | + $this->rewind(); |
|
95 | + while ($this->valid()) { |
|
96 | + /** @var JavascriptAsset $asset */ |
|
97 | + $asset = $this->current(); |
|
98 | + if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) { |
|
99 | + $files[ $asset->handle() ] = $asset; |
|
100 | + } |
|
101 | + $this->next(); |
|
102 | + } |
|
103 | + $this->rewind(); |
|
104 | + return $files; |
|
105 | + } |
|
106 | + |
|
107 | + |
|
108 | + /** |
|
109 | + * returns TRUE or FALSE |
|
110 | + * depending on whether the object is within the Collection |
|
111 | + * based on the supplied $identifier and type |
|
112 | + * |
|
113 | + * @param mixed $identifier |
|
114 | + * @param string $type |
|
115 | + * @return bool |
|
116 | + * @since 4.9.63.p |
|
117 | + */ |
|
118 | + public function hasAssetOfType($identifier, $type = Asset::TYPE_JS) |
|
119 | + { |
|
120 | + $this->rewind(); |
|
121 | + while ($this->valid()) { |
|
122 | + if ($this->getInfo() === $identifier && $this->current()->type() === $type) { |
|
123 | + $this->rewind(); |
|
124 | + return true; |
|
125 | + } |
|
126 | + $this->next(); |
|
127 | + } |
|
128 | + return false; |
|
129 | + } |
|
130 | + |
|
131 | + |
|
132 | + /** |
|
133 | + * returns TRUE or FALSE |
|
134 | + * depending on whether the Javascript Asset is within the Collection |
|
135 | + * based on the supplied $identifier |
|
136 | + * |
|
137 | + * @param mixed $identifier |
|
138 | + * @return bool |
|
139 | + * @since 4.9.63.p |
|
140 | + */ |
|
141 | + public function hasJavascriptAsset($identifier) |
|
142 | + { |
|
143 | + return $this->hasAssetOfType($identifier, Asset::TYPE_JS); |
|
144 | + } |
|
145 | + |
|
146 | + |
|
147 | + /** |
|
148 | + * returns TRUE or FALSE |
|
149 | + * depending on whether the Stylesheet Asset is within the Collection |
|
150 | + * based on the supplied $identifier |
|
151 | + * |
|
152 | + * @param mixed $identifier |
|
153 | + * @return bool |
|
154 | + * @since 4.9.63.p |
|
155 | + */ |
|
156 | + public function hasStylesheetAsset($identifier) |
|
157 | + { |
|
158 | + return $this->hasAssetOfType($identifier, Asset::TYPE_CSS); |
|
159 | + } |
|
160 | + |
|
161 | + /** |
|
162 | + * returns the object from the Collection |
|
163 | + * based on the supplied $identifier and type |
|
164 | + * |
|
165 | + * @param mixed $identifier |
|
166 | + * @param string $type |
|
167 | + * @return JavascriptAsset|StylesheetAsset |
|
168 | + * @since 4.9.63.p |
|
169 | + */ |
|
170 | + public function getAssetOfType($identifier, $type = Asset::TYPE_JS) |
|
171 | + { |
|
172 | + $this->rewind(); |
|
173 | + while ($this->valid()) { |
|
174 | + if ($this->getInfo() === $identifier && $this->current()->type() === $type) { |
|
175 | + /** @var JavascriptAsset|StylesheetAsset $object */ |
|
176 | + $object = $this->current(); |
|
177 | + $this->rewind(); |
|
178 | + return $object; |
|
179 | + } |
|
180 | + $this->next(); |
|
181 | + } |
|
182 | + return null; |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + /** |
|
187 | + * returns the Stylesheet Asset from the Collection |
|
188 | + * based on the supplied $identifier |
|
189 | + * |
|
190 | + * @param mixed $identifier |
|
191 | + * @return StylesheetAsset |
|
192 | + * @since 4.9.63.p |
|
193 | + */ |
|
194 | + public function getStylesheetAsset($identifier) |
|
195 | + { |
|
196 | + return $this->getAssetOfType($identifier, Asset::TYPE_CSS); |
|
197 | + } |
|
198 | + |
|
199 | + |
|
200 | + /** |
|
201 | + * returns the Javascript Asset from the Collection |
|
202 | + * based on the supplied $identifier |
|
203 | + * |
|
204 | + * @param mixed $identifier |
|
205 | + * @return JavascriptAsset |
|
206 | + * @since 4.9.63.p |
|
207 | + */ |
|
208 | + public function getJavascriptAsset($identifier) |
|
209 | + { |
|
210 | + return $this->getAssetOfType($identifier, Asset::TYPE_JS); |
|
211 | + } |
|
212 | 212 | } |
@@ -17,1043 +17,1043 @@ |
||
17 | 17 | { |
18 | 18 | |
19 | 19 | |
20 | - /** |
|
21 | - * return the timezone set for the WP install |
|
22 | - * |
|
23 | - * @return string valid timezone string for PHP DateTimeZone() class |
|
24 | - * @throws InvalidArgumentException |
|
25 | - * @throws InvalidDataTypeException |
|
26 | - * @throws InvalidInterfaceException |
|
27 | - */ |
|
28 | - public static function get_timezone() |
|
29 | - { |
|
30 | - return EEH_DTT_Helper::get_valid_timezone_string(); |
|
31 | - } |
|
20 | + /** |
|
21 | + * return the timezone set for the WP install |
|
22 | + * |
|
23 | + * @return string valid timezone string for PHP DateTimeZone() class |
|
24 | + * @throws InvalidArgumentException |
|
25 | + * @throws InvalidDataTypeException |
|
26 | + * @throws InvalidInterfaceException |
|
27 | + */ |
|
28 | + public static function get_timezone() |
|
29 | + { |
|
30 | + return EEH_DTT_Helper::get_valid_timezone_string(); |
|
31 | + } |
|
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * get_valid_timezone_string |
|
36 | - * ensures that a valid timezone string is returned |
|
37 | - * |
|
38 | - * @param string $timezone_string |
|
39 | - * @return string |
|
40 | - * @throws InvalidArgumentException |
|
41 | - * @throws InvalidDataTypeException |
|
42 | - * @throws InvalidInterfaceException |
|
43 | - */ |
|
44 | - public static function get_valid_timezone_string($timezone_string = '') |
|
45 | - { |
|
46 | - return self::getHelperAdapter()->getValidTimezoneString($timezone_string); |
|
47 | - } |
|
34 | + /** |
|
35 | + * get_valid_timezone_string |
|
36 | + * ensures that a valid timezone string is returned |
|
37 | + * |
|
38 | + * @param string $timezone_string |
|
39 | + * @return string |
|
40 | + * @throws InvalidArgumentException |
|
41 | + * @throws InvalidDataTypeException |
|
42 | + * @throws InvalidInterfaceException |
|
43 | + */ |
|
44 | + public static function get_valid_timezone_string($timezone_string = '') |
|
45 | + { |
|
46 | + return self::getHelperAdapter()->getValidTimezoneString($timezone_string); |
|
47 | + } |
|
48 | 48 | |
49 | 49 | |
50 | - /** |
|
51 | - * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
52 | - * |
|
53 | - * @static |
|
54 | - * @param string $timezone_string Timezone string to check |
|
55 | - * @param bool $throw_error |
|
56 | - * @return bool |
|
57 | - * @throws InvalidArgumentException |
|
58 | - * @throws InvalidDataTypeException |
|
59 | - * @throws InvalidInterfaceException |
|
60 | - */ |
|
61 | - public static function validate_timezone($timezone_string, $throw_error = true) |
|
62 | - { |
|
63 | - return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error); |
|
64 | - } |
|
50 | + /** |
|
51 | + * This only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
52 | + * |
|
53 | + * @static |
|
54 | + * @param string $timezone_string Timezone string to check |
|
55 | + * @param bool $throw_error |
|
56 | + * @return bool |
|
57 | + * @throws InvalidArgumentException |
|
58 | + * @throws InvalidDataTypeException |
|
59 | + * @throws InvalidInterfaceException |
|
60 | + */ |
|
61 | + public static function validate_timezone($timezone_string, $throw_error = true) |
|
62 | + { |
|
63 | + return self::getHelperAdapter()->validateTimezone($timezone_string, $throw_error); |
|
64 | + } |
|
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * This returns a string that can represent the provided gmt offset in format that can be passed into |
|
69 | - * DateTimeZone. This is NOT a string that can be passed as a value on the WordPress timezone_string option. |
|
70 | - * |
|
71 | - * @param float|string $gmt_offset |
|
72 | - * @return string |
|
73 | - * @throws InvalidArgumentException |
|
74 | - * @throws InvalidDataTypeException |
|
75 | - * @throws InvalidInterfaceException |
|
76 | - */ |
|
77 | - public static function get_timezone_string_from_gmt_offset($gmt_offset = '') |
|
78 | - { |
|
79 | - return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset); |
|
80 | - } |
|
67 | + /** |
|
68 | + * This returns a string that can represent the provided gmt offset in format that can be passed into |
|
69 | + * DateTimeZone. This is NOT a string that can be passed as a value on the WordPress timezone_string option. |
|
70 | + * |
|
71 | + * @param float|string $gmt_offset |
|
72 | + * @return string |
|
73 | + * @throws InvalidArgumentException |
|
74 | + * @throws InvalidDataTypeException |
|
75 | + * @throws InvalidInterfaceException |
|
76 | + */ |
|
77 | + public static function get_timezone_string_from_gmt_offset($gmt_offset = '') |
|
78 | + { |
|
79 | + return self::getHelperAdapter()->getTimezoneStringFromGmtOffset($gmt_offset); |
|
80 | + } |
|
81 | 81 | |
82 | 82 | |
83 | - /** |
|
84 | - * Gets the site's GMT offset based on either the timezone string |
|
85 | - * (in which case teh gmt offset will vary depending on the location's |
|
86 | - * observance of daylight savings time) or the gmt_offset wp option |
|
87 | - * |
|
88 | - * @return int seconds offset |
|
89 | - * @throws InvalidArgumentException |
|
90 | - * @throws InvalidDataTypeException |
|
91 | - * @throws InvalidInterfaceException |
|
92 | - */ |
|
93 | - public static function get_site_timezone_gmt_offset() |
|
94 | - { |
|
95 | - return self::getHelperAdapter()->getSiteTimezoneGmtOffset(); |
|
96 | - } |
|
83 | + /** |
|
84 | + * Gets the site's GMT offset based on either the timezone string |
|
85 | + * (in which case teh gmt offset will vary depending on the location's |
|
86 | + * observance of daylight savings time) or the gmt_offset wp option |
|
87 | + * |
|
88 | + * @return int seconds offset |
|
89 | + * @throws InvalidArgumentException |
|
90 | + * @throws InvalidDataTypeException |
|
91 | + * @throws InvalidInterfaceException |
|
92 | + */ |
|
93 | + public static function get_site_timezone_gmt_offset() |
|
94 | + { |
|
95 | + return self::getHelperAdapter()->getSiteTimezoneGmtOffset(); |
|
96 | + } |
|
97 | 97 | |
98 | 98 | |
99 | - /** |
|
100 | - * Depending on PHP version, |
|
101 | - * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
102 | - * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
103 | - * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
104 | - * |
|
105 | - * @deprecated 4.9.54.rc Developers this was always meant to only be an internally used method. This will be |
|
106 | - * removed in a future version of EE. |
|
107 | - * @param int $gmt_offset |
|
108 | - * @return int |
|
109 | - * @throws InvalidArgumentException |
|
110 | - * @throws InvalidDataTypeException |
|
111 | - * @throws InvalidInterfaceException |
|
112 | - */ |
|
113 | - public static function adjust_invalid_gmt_offsets($gmt_offset = 0) |
|
114 | - { |
|
115 | - return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset); |
|
116 | - } |
|
99 | + /** |
|
100 | + * Depending on PHP version, |
|
101 | + * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
102 | + * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
103 | + * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
104 | + * |
|
105 | + * @deprecated 4.9.54.rc Developers this was always meant to only be an internally used method. This will be |
|
106 | + * removed in a future version of EE. |
|
107 | + * @param int $gmt_offset |
|
108 | + * @return int |
|
109 | + * @throws InvalidArgumentException |
|
110 | + * @throws InvalidDataTypeException |
|
111 | + * @throws InvalidInterfaceException |
|
112 | + */ |
|
113 | + public static function adjust_invalid_gmt_offsets($gmt_offset = 0) |
|
114 | + { |
|
115 | + return self::getHelperAdapter()->adjustInvalidGmtOffsets($gmt_offset); |
|
116 | + } |
|
117 | 117 | |
118 | 118 | |
119 | - /** |
|
120 | - * get_timezone_string_from_abbreviations_list |
|
121 | - * |
|
122 | - * @deprecated 4.9.54.rc Developers, this was never intended to be public. This is a soft deprecation for now. |
|
123 | - * If you are using this, you'll want to work out an alternate way of getting the value. |
|
124 | - * @param int $gmt_offset |
|
125 | - * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset. |
|
126 | - * @return string |
|
127 | - * @throws EE_Error |
|
128 | - * @throws InvalidArgumentException |
|
129 | - * @throws InvalidDataTypeException |
|
130 | - * @throws InvalidInterfaceException |
|
131 | - */ |
|
132 | - public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true) |
|
133 | - { |
|
134 | - $gmt_offset = (int) $gmt_offset; |
|
135 | - /** @var array[] $abbreviations */ |
|
136 | - $abbreviations = DateTimeZone::listAbbreviations(); |
|
137 | - foreach ($abbreviations as $abbreviation) { |
|
138 | - foreach ($abbreviation as $timezone) { |
|
139 | - if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) { |
|
140 | - try { |
|
141 | - $offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id'])); |
|
142 | - if ($offset !== $gmt_offset) { |
|
143 | - continue; |
|
144 | - } |
|
145 | - return $timezone['timezone_id']; |
|
146 | - } catch (Exception $e) { |
|
147 | - continue; |
|
148 | - } |
|
149 | - } |
|
150 | - } |
|
151 | - } |
|
152 | - // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted |
|
153 | - if ($coerce === true) { |
|
154 | - $timezone_string = self::get_timezone_string_from_abbreviations_list( |
|
155 | - self::adjust_invalid_gmt_offsets($gmt_offset), |
|
156 | - false |
|
157 | - ); |
|
158 | - if ($timezone_string) { |
|
159 | - return $timezone_string; |
|
160 | - } |
|
161 | - } |
|
162 | - throw new EE_Error( |
|
163 | - sprintf( |
|
164 | - esc_html__( |
|
165 | - 'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
166 | - 'event_espresso' |
|
167 | - ), |
|
168 | - $gmt_offset / HOUR_IN_SECONDS, |
|
169 | - '<a href="http://www.php.net/manual/en/timezones.php">', |
|
170 | - '</a>' |
|
171 | - ) |
|
172 | - ); |
|
173 | - } |
|
119 | + /** |
|
120 | + * get_timezone_string_from_abbreviations_list |
|
121 | + * |
|
122 | + * @deprecated 4.9.54.rc Developers, this was never intended to be public. This is a soft deprecation for now. |
|
123 | + * If you are using this, you'll want to work out an alternate way of getting the value. |
|
124 | + * @param int $gmt_offset |
|
125 | + * @param bool $coerce If true, we attempt to coerce with our adjustment table @see self::adjust_invalid_gmt_offset. |
|
126 | + * @return string |
|
127 | + * @throws EE_Error |
|
128 | + * @throws InvalidArgumentException |
|
129 | + * @throws InvalidDataTypeException |
|
130 | + * @throws InvalidInterfaceException |
|
131 | + */ |
|
132 | + public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true) |
|
133 | + { |
|
134 | + $gmt_offset = (int) $gmt_offset; |
|
135 | + /** @var array[] $abbreviations */ |
|
136 | + $abbreviations = DateTimeZone::listAbbreviations(); |
|
137 | + foreach ($abbreviations as $abbreviation) { |
|
138 | + foreach ($abbreviation as $timezone) { |
|
139 | + if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) { |
|
140 | + try { |
|
141 | + $offset = self::get_timezone_offset(new DateTimeZone($timezone['timezone_id'])); |
|
142 | + if ($offset !== $gmt_offset) { |
|
143 | + continue; |
|
144 | + } |
|
145 | + return $timezone['timezone_id']; |
|
146 | + } catch (Exception $e) { |
|
147 | + continue; |
|
148 | + } |
|
149 | + } |
|
150 | + } |
|
151 | + } |
|
152 | + // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted |
|
153 | + if ($coerce === true) { |
|
154 | + $timezone_string = self::get_timezone_string_from_abbreviations_list( |
|
155 | + self::adjust_invalid_gmt_offsets($gmt_offset), |
|
156 | + false |
|
157 | + ); |
|
158 | + if ($timezone_string) { |
|
159 | + return $timezone_string; |
|
160 | + } |
|
161 | + } |
|
162 | + throw new EE_Error( |
|
163 | + sprintf( |
|
164 | + esc_html__( |
|
165 | + 'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used', |
|
166 | + 'event_espresso' |
|
167 | + ), |
|
168 | + $gmt_offset / HOUR_IN_SECONDS, |
|
169 | + '<a href="http://www.php.net/manual/en/timezones.php">', |
|
170 | + '</a>' |
|
171 | + ) |
|
172 | + ); |
|
173 | + } |
|
174 | 174 | |
175 | 175 | |
176 | - /** |
|
177 | - * Get Timezone Transitions |
|
178 | - * |
|
179 | - * @param DateTimeZone $date_time_zone |
|
180 | - * @param int|null $time |
|
181 | - * @param bool $first_only |
|
182 | - * @return array |
|
183 | - * @throws InvalidArgumentException |
|
184 | - * @throws InvalidDataTypeException |
|
185 | - * @throws InvalidInterfaceException |
|
186 | - */ |
|
187 | - public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true) |
|
188 | - { |
|
189 | - return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only); |
|
190 | - } |
|
176 | + /** |
|
177 | + * Get Timezone Transitions |
|
178 | + * |
|
179 | + * @param DateTimeZone $date_time_zone |
|
180 | + * @param int|null $time |
|
181 | + * @param bool $first_only |
|
182 | + * @return array |
|
183 | + * @throws InvalidArgumentException |
|
184 | + * @throws InvalidDataTypeException |
|
185 | + * @throws InvalidInterfaceException |
|
186 | + */ |
|
187 | + public static function get_timezone_transitions(DateTimeZone $date_time_zone, $time = null, $first_only = true) |
|
188 | + { |
|
189 | + return self::getHelperAdapter()->getTimezoneTransitions($date_time_zone, $time, $first_only); |
|
190 | + } |
|
191 | 191 | |
192 | 192 | |
193 | - /** |
|
194 | - * Get Timezone Offset for given timezone object. |
|
195 | - * |
|
196 | - * @param DateTimeZone $date_time_zone |
|
197 | - * @param null $time |
|
198 | - * @return mixed |
|
199 | - * @throws InvalidArgumentException |
|
200 | - * @throws InvalidDataTypeException |
|
201 | - * @throws InvalidInterfaceException |
|
202 | - */ |
|
203 | - public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null) |
|
204 | - { |
|
205 | - return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time); |
|
206 | - } |
|
193 | + /** |
|
194 | + * Get Timezone Offset for given timezone object. |
|
195 | + * |
|
196 | + * @param DateTimeZone $date_time_zone |
|
197 | + * @param null $time |
|
198 | + * @return mixed |
|
199 | + * @throws InvalidArgumentException |
|
200 | + * @throws InvalidDataTypeException |
|
201 | + * @throws InvalidInterfaceException |
|
202 | + */ |
|
203 | + public static function get_timezone_offset(DateTimeZone $date_time_zone, $time = null) |
|
204 | + { |
|
205 | + return self::getHelperAdapter()->getTimezoneOffset($date_time_zone, $time); |
|
206 | + } |
|
207 | 207 | |
208 | 208 | |
209 | - /** |
|
210 | - * Prints a select input for the given timezone string. |
|
211 | - * @param string $timezone_string |
|
212 | - * @deprecatd 4.9.54.rc Soft deprecation. Consider using \EEH_DTT_Helper::wp_timezone_choice instead. |
|
213 | - * @throws InvalidArgumentException |
|
214 | - * @throws InvalidDataTypeException |
|
215 | - * @throws InvalidInterfaceException |
|
216 | - */ |
|
217 | - public static function timezone_select_input($timezone_string = '') |
|
218 | - { |
|
219 | - self::getHelperAdapter()->timezoneSelectInput($timezone_string); |
|
220 | - } |
|
209 | + /** |
|
210 | + * Prints a select input for the given timezone string. |
|
211 | + * @param string $timezone_string |
|
212 | + * @deprecatd 4.9.54.rc Soft deprecation. Consider using \EEH_DTT_Helper::wp_timezone_choice instead. |
|
213 | + * @throws InvalidArgumentException |
|
214 | + * @throws InvalidDataTypeException |
|
215 | + * @throws InvalidInterfaceException |
|
216 | + */ |
|
217 | + public static function timezone_select_input($timezone_string = '') |
|
218 | + { |
|
219 | + self::getHelperAdapter()->timezoneSelectInput($timezone_string); |
|
220 | + } |
|
221 | 221 | |
222 | 222 | |
223 | - /** |
|
224 | - * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
225 | - * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
226 | - * the site is used. |
|
227 | - * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
228 | - * computed timestamp (i.e. date_i18n() ) |
|
229 | - * |
|
230 | - * @param int $unix_timestamp if 0, then time() will be used. |
|
231 | - * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
232 | - * site will be used. |
|
233 | - * @return int $unix_timestamp with the offset applied for the given timezone. |
|
234 | - * @throws InvalidArgumentException |
|
235 | - * @throws InvalidDataTypeException |
|
236 | - * @throws InvalidInterfaceException |
|
237 | - */ |
|
238 | - public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '') |
|
239 | - { |
|
240 | - return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string); |
|
241 | - } |
|
223 | + /** |
|
224 | + * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
225 | + * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
226 | + * the site is used. |
|
227 | + * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
228 | + * computed timestamp (i.e. date_i18n() ) |
|
229 | + * |
|
230 | + * @param int $unix_timestamp if 0, then time() will be used. |
|
231 | + * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
232 | + * site will be used. |
|
233 | + * @return int $unix_timestamp with the offset applied for the given timezone. |
|
234 | + * @throws InvalidArgumentException |
|
235 | + * @throws InvalidDataTypeException |
|
236 | + * @throws InvalidInterfaceException |
|
237 | + */ |
|
238 | + public static function get_timestamp_with_offset($unix_timestamp = 0, $timezone_string = '') |
|
239 | + { |
|
240 | + return self::getHelperAdapter()->getTimestampWithOffset($unix_timestamp, $timezone_string); |
|
241 | + } |
|
242 | 242 | |
243 | 243 | |
244 | - /** |
|
245 | - * _set_date_time_field |
|
246 | - * modifies EE_Base_Class EE_Datetime_Field objects |
|
247 | - * |
|
248 | - * @param EE_Base_Class $obj EE_Base_Class object |
|
249 | - * @param DateTime $DateTime PHP DateTime object |
|
250 | - * @param string $datetime_field_name the datetime fieldname to be manipulated |
|
251 | - * @return EE_Base_Class |
|
252 | - * @throws EE_Error |
|
253 | - */ |
|
254 | - protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name) |
|
255 | - { |
|
256 | - // grab current datetime format |
|
257 | - $current_format = $obj->get_format(); |
|
258 | - // set new full timestamp format |
|
259 | - $obj->set_date_format(EE_Datetime_Field::mysql_date_format); |
|
260 | - $obj->set_time_format(EE_Datetime_Field::mysql_time_format); |
|
261 | - // set the new date value using a full timestamp format so that no data is lost |
|
262 | - $obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format)); |
|
263 | - // reset datetime formats |
|
264 | - $obj->set_date_format($current_format[0]); |
|
265 | - $obj->set_time_format($current_format[1]); |
|
266 | - return $obj; |
|
267 | - } |
|
244 | + /** |
|
245 | + * _set_date_time_field |
|
246 | + * modifies EE_Base_Class EE_Datetime_Field objects |
|
247 | + * |
|
248 | + * @param EE_Base_Class $obj EE_Base_Class object |
|
249 | + * @param DateTime $DateTime PHP DateTime object |
|
250 | + * @param string $datetime_field_name the datetime fieldname to be manipulated |
|
251 | + * @return EE_Base_Class |
|
252 | + * @throws EE_Error |
|
253 | + */ |
|
254 | + protected static function _set_date_time_field(EE_Base_Class $obj, DateTime $DateTime, $datetime_field_name) |
|
255 | + { |
|
256 | + // grab current datetime format |
|
257 | + $current_format = $obj->get_format(); |
|
258 | + // set new full timestamp format |
|
259 | + $obj->set_date_format(EE_Datetime_Field::mysql_date_format); |
|
260 | + $obj->set_time_format(EE_Datetime_Field::mysql_time_format); |
|
261 | + // set the new date value using a full timestamp format so that no data is lost |
|
262 | + $obj->set($datetime_field_name, $DateTime->format(EE_Datetime_Field::mysql_timestamp_format)); |
|
263 | + // reset datetime formats |
|
264 | + $obj->set_date_format($current_format[0]); |
|
265 | + $obj->set_time_format($current_format[1]); |
|
266 | + return $obj; |
|
267 | + } |
|
268 | 268 | |
269 | 269 | |
270 | - /** |
|
271 | - * date_time_add |
|
272 | - * helper for doing simple datetime calculations on a given datetime from EE_Base_Class |
|
273 | - * and modifying it IN the EE_Base_Class so you don't have to do anything else. |
|
274 | - * |
|
275 | - * @param EE_Base_Class $obj EE_Base_Class object |
|
276 | - * @param string $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated |
|
277 | - * @param string $period what you are adding. The options are (years, months, days, hours, |
|
278 | - * minutes, seconds) defaults to years |
|
279 | - * @param integer $value what you want to increment the time by |
|
280 | - * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it |
|
281 | - * (chaining) |
|
282 | - * @throws EE_Error |
|
283 | - * @throws Exception |
|
284 | - */ |
|
285 | - public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) |
|
286 | - { |
|
287 | - // get the raw UTC date. |
|
288 | - $DateTime = $obj->get_DateTime_object($datetime_field_name); |
|
289 | - $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value); |
|
290 | - return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name); |
|
291 | - } |
|
270 | + /** |
|
271 | + * date_time_add |
|
272 | + * helper for doing simple datetime calculations on a given datetime from EE_Base_Class |
|
273 | + * and modifying it IN the EE_Base_Class so you don't have to do anything else. |
|
274 | + * |
|
275 | + * @param EE_Base_Class $obj EE_Base_Class object |
|
276 | + * @param string $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated |
|
277 | + * @param string $period what you are adding. The options are (years, months, days, hours, |
|
278 | + * minutes, seconds) defaults to years |
|
279 | + * @param integer $value what you want to increment the time by |
|
280 | + * @return EE_Base_Class return the EE_Base_Class object so right away you can do something with it |
|
281 | + * (chaining) |
|
282 | + * @throws EE_Error |
|
283 | + * @throws Exception |
|
284 | + */ |
|
285 | + public static function date_time_add(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) |
|
286 | + { |
|
287 | + // get the raw UTC date. |
|
288 | + $DateTime = $obj->get_DateTime_object($datetime_field_name); |
|
289 | + $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value); |
|
290 | + return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name); |
|
291 | + } |
|
292 | 292 | |
293 | 293 | |
294 | - /** |
|
295 | - * date_time_subtract |
|
296 | - * same as date_time_add except subtracting value instead of adding. |
|
297 | - * |
|
298 | - * @param EE_Base_Class $obj |
|
299 | - * @param string $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated |
|
300 | - * @param string $period |
|
301 | - * @param int $value |
|
302 | - * @return EE_Base_Class |
|
303 | - * @throws EE_Error |
|
304 | - * @throws Exception |
|
305 | - */ |
|
306 | - public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) |
|
307 | - { |
|
308 | - // get the raw UTC date |
|
309 | - $DateTime = $obj->get_DateTime_object($datetime_field_name); |
|
310 | - $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-'); |
|
311 | - return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name); |
|
312 | - } |
|
294 | + /** |
|
295 | + * date_time_subtract |
|
296 | + * same as date_time_add except subtracting value instead of adding. |
|
297 | + * |
|
298 | + * @param EE_Base_Class $obj |
|
299 | + * @param string $datetime_field_name name of the EE_Datetime_Filed datatype db column to be manipulated |
|
300 | + * @param string $period |
|
301 | + * @param int $value |
|
302 | + * @return EE_Base_Class |
|
303 | + * @throws EE_Error |
|
304 | + * @throws Exception |
|
305 | + */ |
|
306 | + public static function date_time_subtract(EE_Base_Class $obj, $datetime_field_name, $period = 'years', $value = 1) |
|
307 | + { |
|
308 | + // get the raw UTC date |
|
309 | + $DateTime = $obj->get_DateTime_object($datetime_field_name); |
|
310 | + $DateTime = EEH_DTT_Helper::calc_date($DateTime, $period, $value, '-'); |
|
311 | + return EEH_DTT_Helper::_set_date_time_field($obj, $DateTime, $datetime_field_name); |
|
312 | + } |
|
313 | 313 | |
314 | 314 | |
315 | - /** |
|
316 | - * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters |
|
317 | - * |
|
318 | - * @param DateTime $DateTime DateTime object |
|
319 | - * @param string $period a value to indicate what interval is being used in the calculation. The options are |
|
320 | - * 'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years. |
|
321 | - * @param int|string $value What you want to increment the date by |
|
322 | - * @param string $operand What operand you wish to use for the calculation |
|
323 | - * @return DateTime return whatever type came in. |
|
324 | - * @throws Exception |
|
325 | - * @throws EE_Error |
|
326 | - */ |
|
327 | - protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+') |
|
328 | - { |
|
329 | - if (! $DateTime instanceof DateTime) { |
|
330 | - throw new EE_Error( |
|
331 | - sprintf( |
|
332 | - esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'), |
|
333 | - print_r($DateTime, true) |
|
334 | - ) |
|
335 | - ); |
|
336 | - } |
|
337 | - switch ($period) { |
|
338 | - case 'years': |
|
339 | - $value = 'P' . $value . 'Y'; |
|
340 | - break; |
|
341 | - case 'months': |
|
342 | - $value = 'P' . $value . 'M'; |
|
343 | - break; |
|
344 | - case 'weeks': |
|
345 | - $value = 'P' . $value . 'W'; |
|
346 | - break; |
|
347 | - case 'days': |
|
348 | - $value = 'P' . $value . 'D'; |
|
349 | - break; |
|
350 | - case 'hours': |
|
351 | - $value = 'PT' . $value . 'H'; |
|
352 | - break; |
|
353 | - case 'minutes': |
|
354 | - $value = 'PT' . $value . 'M'; |
|
355 | - break; |
|
356 | - case 'seconds': |
|
357 | - $value = 'PT' . $value . 'S'; |
|
358 | - break; |
|
359 | - } |
|
360 | - switch ($operand) { |
|
361 | - case '+': |
|
362 | - $DateTime->add(new DateInterval($value)); |
|
363 | - break; |
|
364 | - case '-': |
|
365 | - $DateTime->sub(new DateInterval($value)); |
|
366 | - break; |
|
367 | - } |
|
368 | - return $DateTime; |
|
369 | - } |
|
315 | + /** |
|
316 | + * Simply takes an incoming DateTime object and does calculations on it based on the incoming parameters |
|
317 | + * |
|
318 | + * @param DateTime $DateTime DateTime object |
|
319 | + * @param string $period a value to indicate what interval is being used in the calculation. The options are |
|
320 | + * 'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years. |
|
321 | + * @param int|string $value What you want to increment the date by |
|
322 | + * @param string $operand What operand you wish to use for the calculation |
|
323 | + * @return DateTime return whatever type came in. |
|
324 | + * @throws Exception |
|
325 | + * @throws EE_Error |
|
326 | + */ |
|
327 | + protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+') |
|
328 | + { |
|
329 | + if (! $DateTime instanceof DateTime) { |
|
330 | + throw new EE_Error( |
|
331 | + sprintf( |
|
332 | + esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'), |
|
333 | + print_r($DateTime, true) |
|
334 | + ) |
|
335 | + ); |
|
336 | + } |
|
337 | + switch ($period) { |
|
338 | + case 'years': |
|
339 | + $value = 'P' . $value . 'Y'; |
|
340 | + break; |
|
341 | + case 'months': |
|
342 | + $value = 'P' . $value . 'M'; |
|
343 | + break; |
|
344 | + case 'weeks': |
|
345 | + $value = 'P' . $value . 'W'; |
|
346 | + break; |
|
347 | + case 'days': |
|
348 | + $value = 'P' . $value . 'D'; |
|
349 | + break; |
|
350 | + case 'hours': |
|
351 | + $value = 'PT' . $value . 'H'; |
|
352 | + break; |
|
353 | + case 'minutes': |
|
354 | + $value = 'PT' . $value . 'M'; |
|
355 | + break; |
|
356 | + case 'seconds': |
|
357 | + $value = 'PT' . $value . 'S'; |
|
358 | + break; |
|
359 | + } |
|
360 | + switch ($operand) { |
|
361 | + case '+': |
|
362 | + $DateTime->add(new DateInterval($value)); |
|
363 | + break; |
|
364 | + case '-': |
|
365 | + $DateTime->sub(new DateInterval($value)); |
|
366 | + break; |
|
367 | + } |
|
368 | + return $DateTime; |
|
369 | + } |
|
370 | 370 | |
371 | 371 | |
372 | - /** |
|
373 | - * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters |
|
374 | - * |
|
375 | - * @param int $timestamp Unix timestamp |
|
376 | - * @param string $period a value to indicate what interval is being used in the calculation. The options are |
|
377 | - * 'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years. |
|
378 | - * @param integer $value What you want to increment the date by |
|
379 | - * @param string $operand What operand you wish to use for the calculation |
|
380 | - * @return int |
|
381 | - * @throws EE_Error |
|
382 | - */ |
|
383 | - protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+') |
|
384 | - { |
|
385 | - if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) { |
|
386 | - throw new EE_Error( |
|
387 | - sprintf( |
|
388 | - esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'), |
|
389 | - print_r($timestamp, true) |
|
390 | - ) |
|
391 | - ); |
|
392 | - } |
|
393 | - switch ($period) { |
|
394 | - case 'years': |
|
395 | - $value = YEAR_IN_SECONDS * $value; |
|
396 | - break; |
|
397 | - case 'months': |
|
398 | - $value = YEAR_IN_SECONDS / 12 * $value; |
|
399 | - break; |
|
400 | - case 'weeks': |
|
401 | - $value = WEEK_IN_SECONDS * $value; |
|
402 | - break; |
|
403 | - case 'days': |
|
404 | - $value = DAY_IN_SECONDS * $value; |
|
405 | - break; |
|
406 | - case 'hours': |
|
407 | - $value = HOUR_IN_SECONDS * $value; |
|
408 | - break; |
|
409 | - case 'minutes': |
|
410 | - $value = MINUTE_IN_SECONDS * $value; |
|
411 | - break; |
|
412 | - } |
|
413 | - switch ($operand) { |
|
414 | - case '+': |
|
415 | - $timestamp += $value; |
|
416 | - break; |
|
417 | - case '-': |
|
418 | - $timestamp -= $value; |
|
419 | - break; |
|
420 | - } |
|
421 | - return $timestamp; |
|
422 | - } |
|
372 | + /** |
|
373 | + * Simply takes an incoming Unix timestamp and does calculations on it based on the incoming parameters |
|
374 | + * |
|
375 | + * @param int $timestamp Unix timestamp |
|
376 | + * @param string $period a value to indicate what interval is being used in the calculation. The options are |
|
377 | + * 'years', 'months', 'days', 'hours', 'minutes', 'seconds'. Defaults to years. |
|
378 | + * @param integer $value What you want to increment the date by |
|
379 | + * @param string $operand What operand you wish to use for the calculation |
|
380 | + * @return int |
|
381 | + * @throws EE_Error |
|
382 | + */ |
|
383 | + protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+') |
|
384 | + { |
|
385 | + if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) { |
|
386 | + throw new EE_Error( |
|
387 | + sprintf( |
|
388 | + esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'), |
|
389 | + print_r($timestamp, true) |
|
390 | + ) |
|
391 | + ); |
|
392 | + } |
|
393 | + switch ($period) { |
|
394 | + case 'years': |
|
395 | + $value = YEAR_IN_SECONDS * $value; |
|
396 | + break; |
|
397 | + case 'months': |
|
398 | + $value = YEAR_IN_SECONDS / 12 * $value; |
|
399 | + break; |
|
400 | + case 'weeks': |
|
401 | + $value = WEEK_IN_SECONDS * $value; |
|
402 | + break; |
|
403 | + case 'days': |
|
404 | + $value = DAY_IN_SECONDS * $value; |
|
405 | + break; |
|
406 | + case 'hours': |
|
407 | + $value = HOUR_IN_SECONDS * $value; |
|
408 | + break; |
|
409 | + case 'minutes': |
|
410 | + $value = MINUTE_IN_SECONDS * $value; |
|
411 | + break; |
|
412 | + } |
|
413 | + switch ($operand) { |
|
414 | + case '+': |
|
415 | + $timestamp += $value; |
|
416 | + break; |
|
417 | + case '-': |
|
418 | + $timestamp -= $value; |
|
419 | + break; |
|
420 | + } |
|
421 | + return $timestamp; |
|
422 | + } |
|
423 | 423 | |
424 | 424 | |
425 | - /** |
|
426 | - * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming |
|
427 | - * parameters and returns the new timestamp or DateTime. |
|
428 | - * |
|
429 | - * @param int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp |
|
430 | - * @param string $period a value to indicate what interval is being used in the |
|
431 | - * calculation. The options are 'years', 'months', 'days', 'hours', |
|
432 | - * 'minutes', 'seconds'. Defaults to years. |
|
433 | - * @param integer $value What you want to increment the date by |
|
434 | - * @param string $operand What operand you wish to use for the calculation |
|
435 | - * @return mixed string|DateTime return whatever type came in. |
|
436 | - * @throws Exception |
|
437 | - * @throws EE_Error |
|
438 | - */ |
|
439 | - public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+') |
|
440 | - { |
|
441 | - if ($DateTime_or_timestamp instanceof DateTime) { |
|
442 | - return EEH_DTT_Helper::_modify_datetime_object( |
|
443 | - $DateTime_or_timestamp, |
|
444 | - $period, |
|
445 | - $value, |
|
446 | - $operand |
|
447 | - ); |
|
448 | - } |
|
449 | - if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) { |
|
450 | - return EEH_DTT_Helper::_modify_timestamp( |
|
451 | - $DateTime_or_timestamp, |
|
452 | - $period, |
|
453 | - $value, |
|
454 | - $operand |
|
455 | - ); |
|
456 | - } |
|
457 | - // error |
|
458 | - return $DateTime_or_timestamp; |
|
459 | - } |
|
425 | + /** |
|
426 | + * Simply takes an incoming UTC timestamp or DateTime object and does calculations on it based on the incoming |
|
427 | + * parameters and returns the new timestamp or DateTime. |
|
428 | + * |
|
429 | + * @param int | DateTime $DateTime_or_timestamp DateTime object or Unix timestamp |
|
430 | + * @param string $period a value to indicate what interval is being used in the |
|
431 | + * calculation. The options are 'years', 'months', 'days', 'hours', |
|
432 | + * 'minutes', 'seconds'. Defaults to years. |
|
433 | + * @param integer $value What you want to increment the date by |
|
434 | + * @param string $operand What operand you wish to use for the calculation |
|
435 | + * @return mixed string|DateTime return whatever type came in. |
|
436 | + * @throws Exception |
|
437 | + * @throws EE_Error |
|
438 | + */ |
|
439 | + public static function calc_date($DateTime_or_timestamp, $period = 'years', $value = 1, $operand = '+') |
|
440 | + { |
|
441 | + if ($DateTime_or_timestamp instanceof DateTime) { |
|
442 | + return EEH_DTT_Helper::_modify_datetime_object( |
|
443 | + $DateTime_or_timestamp, |
|
444 | + $period, |
|
445 | + $value, |
|
446 | + $operand |
|
447 | + ); |
|
448 | + } |
|
449 | + if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $DateTime_or_timestamp)) { |
|
450 | + return EEH_DTT_Helper::_modify_timestamp( |
|
451 | + $DateTime_or_timestamp, |
|
452 | + $period, |
|
453 | + $value, |
|
454 | + $operand |
|
455 | + ); |
|
456 | + } |
|
457 | + // error |
|
458 | + return $DateTime_or_timestamp; |
|
459 | + } |
|
460 | 460 | |
461 | 461 | |
462 | - /** |
|
463 | - * The purpose of this helper method is to receive an incoming format string in php date/time format |
|
464 | - * and spit out the js and moment.js equivalent formats. |
|
465 | - * Note, if no format string is given, then it is assumed the user wants what is set for WP. |
|
466 | - * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date- |
|
467 | - * time picker. |
|
468 | - * |
|
469 | - * @see http://stackoverflow.com/posts/16725290/ for the code inspiration. |
|
470 | - * @param string $date_format_string |
|
471 | - * @param string $time_format_string |
|
472 | - * @return array |
|
473 | - * array( |
|
474 | - * 'js' => array ( |
|
475 | - * 'date' => //date format |
|
476 | - * 'time' => //time format |
|
477 | - * ), |
|
478 | - * 'moment' => //date and time format. |
|
479 | - * ) |
|
480 | - */ |
|
481 | - public static function convert_php_to_js_and_moment_date_formats( |
|
482 | - $date_format_string = null, |
|
483 | - $time_format_string = null |
|
484 | - ) { |
|
485 | - if ($date_format_string === null) { |
|
486 | - $date_format_string = (string) get_option('date_format'); |
|
487 | - } |
|
488 | - if ($time_format_string === null) { |
|
489 | - $time_format_string = (string) get_option('time_format'); |
|
490 | - } |
|
491 | - $date_format = self::_php_to_js_moment_converter($date_format_string); |
|
492 | - $time_format = self::_php_to_js_moment_converter($time_format_string); |
|
493 | - return array( |
|
494 | - 'js' => array( |
|
495 | - 'date' => $date_format['js'], |
|
496 | - 'time' => $time_format['js'], |
|
497 | - ), |
|
498 | - 'moment' => $date_format['moment'] . ' ' . $time_format['moment'], |
|
499 | - 'moment_split' => array( |
|
500 | - 'date' => $date_format['moment'], |
|
501 | - 'time' => $time_format['moment'] |
|
502 | - ) |
|
503 | - ); |
|
504 | - } |
|
462 | + /** |
|
463 | + * The purpose of this helper method is to receive an incoming format string in php date/time format |
|
464 | + * and spit out the js and moment.js equivalent formats. |
|
465 | + * Note, if no format string is given, then it is assumed the user wants what is set for WP. |
|
466 | + * Note, js date and time formats are those used by the jquery-ui datepicker and the jquery-ui date- |
|
467 | + * time picker. |
|
468 | + * |
|
469 | + * @see http://stackoverflow.com/posts/16725290/ for the code inspiration. |
|
470 | + * @param string $date_format_string |
|
471 | + * @param string $time_format_string |
|
472 | + * @return array |
|
473 | + * array( |
|
474 | + * 'js' => array ( |
|
475 | + * 'date' => //date format |
|
476 | + * 'time' => //time format |
|
477 | + * ), |
|
478 | + * 'moment' => //date and time format. |
|
479 | + * ) |
|
480 | + */ |
|
481 | + public static function convert_php_to_js_and_moment_date_formats( |
|
482 | + $date_format_string = null, |
|
483 | + $time_format_string = null |
|
484 | + ) { |
|
485 | + if ($date_format_string === null) { |
|
486 | + $date_format_string = (string) get_option('date_format'); |
|
487 | + } |
|
488 | + if ($time_format_string === null) { |
|
489 | + $time_format_string = (string) get_option('time_format'); |
|
490 | + } |
|
491 | + $date_format = self::_php_to_js_moment_converter($date_format_string); |
|
492 | + $time_format = self::_php_to_js_moment_converter($time_format_string); |
|
493 | + return array( |
|
494 | + 'js' => array( |
|
495 | + 'date' => $date_format['js'], |
|
496 | + 'time' => $time_format['js'], |
|
497 | + ), |
|
498 | + 'moment' => $date_format['moment'] . ' ' . $time_format['moment'], |
|
499 | + 'moment_split' => array( |
|
500 | + 'date' => $date_format['moment'], |
|
501 | + 'time' => $time_format['moment'] |
|
502 | + ) |
|
503 | + ); |
|
504 | + } |
|
505 | 505 | |
506 | 506 | |
507 | - /** |
|
508 | - * This converts incoming format string into js and moment variations. |
|
509 | - * |
|
510 | - * @param string $format_string incoming php format string |
|
511 | - * @return array js and moment formats. |
|
512 | - */ |
|
513 | - protected static function _php_to_js_moment_converter($format_string) |
|
514 | - { |
|
515 | - /** |
|
516 | - * This is a map of symbols for formats. |
|
517 | - * The index is the php symbol, the equivalent values are in the array. |
|
518 | - * |
|
519 | - * @var array |
|
520 | - */ |
|
521 | - $symbols_map = array( |
|
522 | - // Day |
|
523 | - // 01 |
|
524 | - 'd' => array( |
|
525 | - 'js' => 'dd', |
|
526 | - 'moment' => 'DD', |
|
527 | - ), |
|
528 | - // Mon |
|
529 | - 'D' => array( |
|
530 | - 'js' => 'D', |
|
531 | - 'moment' => 'ddd', |
|
532 | - ), |
|
533 | - // 1,2,...31 |
|
534 | - 'j' => array( |
|
535 | - 'js' => 'd', |
|
536 | - 'moment' => 'D', |
|
537 | - ), |
|
538 | - // Monday |
|
539 | - 'l' => array( |
|
540 | - 'js' => 'DD', |
|
541 | - 'moment' => 'dddd', |
|
542 | - ), |
|
543 | - // ISO numeric representation of the day of the week (1-6) |
|
544 | - 'N' => array( |
|
545 | - 'js' => '', |
|
546 | - 'moment' => 'E', |
|
547 | - ), |
|
548 | - // st,nd.rd |
|
549 | - 'S' => array( |
|
550 | - 'js' => '', |
|
551 | - 'moment' => 'o', |
|
552 | - ), |
|
553 | - // numeric representation of day of week (0-6) |
|
554 | - 'w' => array( |
|
555 | - 'js' => '', |
|
556 | - 'moment' => 'd', |
|
557 | - ), |
|
558 | - // day of year starting from 0 (0-365) |
|
559 | - 'z' => array( |
|
560 | - 'js' => 'o', |
|
561 | - 'moment' => 'DDD' // note moment does not start with 0 so will need to modify by subtracting 1 |
|
562 | - ), |
|
563 | - // Week |
|
564 | - // ISO-8601 week number of year (weeks starting on monday) |
|
565 | - 'W' => array( |
|
566 | - 'js' => '', |
|
567 | - 'moment' => 'w', |
|
568 | - ), |
|
569 | - // Month |
|
570 | - // January...December |
|
571 | - 'F' => array( |
|
572 | - 'js' => 'MM', |
|
573 | - 'moment' => 'MMMM', |
|
574 | - ), |
|
575 | - // 01...12 |
|
576 | - 'm' => array( |
|
577 | - 'js' => 'mm', |
|
578 | - 'moment' => 'MM', |
|
579 | - ), |
|
580 | - // Jan...Dec |
|
581 | - 'M' => array( |
|
582 | - 'js' => 'M', |
|
583 | - 'moment' => 'MMM', |
|
584 | - ), |
|
585 | - // 1-12 |
|
586 | - 'n' => array( |
|
587 | - 'js' => 'm', |
|
588 | - 'moment' => 'M', |
|
589 | - ), |
|
590 | - // number of days in given month |
|
591 | - 't' => array( |
|
592 | - 'js' => '', |
|
593 | - 'moment' => '', |
|
594 | - ), |
|
595 | - // Year |
|
596 | - // whether leap year or not 1/0 |
|
597 | - 'L' => array( |
|
598 | - 'js' => '', |
|
599 | - 'moment' => '', |
|
600 | - ), |
|
601 | - // ISO-8601 year number |
|
602 | - 'o' => array( |
|
603 | - 'js' => '', |
|
604 | - 'moment' => 'GGGG', |
|
605 | - ), |
|
606 | - // 1999...2003 |
|
607 | - 'Y' => array( |
|
608 | - 'js' => 'yy', |
|
609 | - 'moment' => 'YYYY', |
|
610 | - ), |
|
611 | - // 99...03 |
|
612 | - 'y' => array( |
|
613 | - 'js' => 'y', |
|
614 | - 'moment' => 'YY', |
|
615 | - ), |
|
616 | - // Time |
|
617 | - // am/pm |
|
618 | - 'a' => array( |
|
619 | - 'js' => 'tt', |
|
620 | - 'moment' => 'a', |
|
621 | - ), |
|
622 | - // AM/PM |
|
623 | - 'A' => array( |
|
624 | - 'js' => 'TT', |
|
625 | - 'moment' => 'A', |
|
626 | - ), |
|
627 | - // Swatch Internet Time?!? |
|
628 | - 'B' => array( |
|
629 | - 'js' => '', |
|
630 | - 'moment' => '', |
|
631 | - ), |
|
632 | - // 1...12 |
|
633 | - 'g' => array( |
|
634 | - 'js' => 'h', |
|
635 | - 'moment' => 'h', |
|
636 | - ), |
|
637 | - // 0...23 |
|
638 | - 'G' => array( |
|
639 | - 'js' => 'H', |
|
640 | - 'moment' => 'H', |
|
641 | - ), |
|
642 | - // 01...12 |
|
643 | - 'h' => array( |
|
644 | - 'js' => 'hh', |
|
645 | - 'moment' => 'hh', |
|
646 | - ), |
|
647 | - // 00...23 |
|
648 | - 'H' => array( |
|
649 | - 'js' => 'HH', |
|
650 | - 'moment' => 'HH', |
|
651 | - ), |
|
652 | - // 00..59 |
|
653 | - 'i' => array( |
|
654 | - 'js' => 'mm', |
|
655 | - 'moment' => 'mm', |
|
656 | - ), |
|
657 | - // seconds... 00...59 |
|
658 | - 's' => array( |
|
659 | - 'js' => 'ss', |
|
660 | - 'moment' => 'ss', |
|
661 | - ), |
|
662 | - // microseconds |
|
663 | - 'u' => array( |
|
664 | - 'js' => '', |
|
665 | - 'moment' => '', |
|
666 | - ), |
|
667 | - ); |
|
668 | - $jquery_ui_format = ''; |
|
669 | - $moment_format = ''; |
|
670 | - $escaping = false; |
|
671 | - $format_string_length = strlen($format_string); |
|
672 | - for ($i = 0; $i < $format_string_length; $i++) { |
|
673 | - $char = $format_string[ $i ]; |
|
674 | - if ($char === '\\') { // PHP date format escaping character |
|
675 | - $i++; |
|
676 | - if ($escaping) { |
|
677 | - $jquery_ui_format .= $format_string[ $i ]; |
|
678 | - $moment_format .= $format_string[ $i ]; |
|
679 | - } else { |
|
680 | - $jquery_ui_format .= '\'' . $format_string[ $i ]; |
|
681 | - $moment_format .= $format_string[ $i ]; |
|
682 | - } |
|
683 | - $escaping = true; |
|
684 | - } else { |
|
685 | - if ($escaping) { |
|
686 | - $jquery_ui_format .= "'"; |
|
687 | - $moment_format .= "'"; |
|
688 | - $escaping = false; |
|
689 | - } |
|
690 | - if (isset($symbols_map[ $char ])) { |
|
691 | - $jquery_ui_format .= $symbols_map[ $char ]['js']; |
|
692 | - $moment_format .= $symbols_map[ $char ]['moment']; |
|
693 | - } else { |
|
694 | - $jquery_ui_format .= $char; |
|
695 | - $moment_format .= $char; |
|
696 | - } |
|
697 | - } |
|
698 | - } |
|
699 | - return array('js' => $jquery_ui_format, 'moment' => $moment_format); |
|
700 | - } |
|
507 | + /** |
|
508 | + * This converts incoming format string into js and moment variations. |
|
509 | + * |
|
510 | + * @param string $format_string incoming php format string |
|
511 | + * @return array js and moment formats. |
|
512 | + */ |
|
513 | + protected static function _php_to_js_moment_converter($format_string) |
|
514 | + { |
|
515 | + /** |
|
516 | + * This is a map of symbols for formats. |
|
517 | + * The index is the php symbol, the equivalent values are in the array. |
|
518 | + * |
|
519 | + * @var array |
|
520 | + */ |
|
521 | + $symbols_map = array( |
|
522 | + // Day |
|
523 | + // 01 |
|
524 | + 'd' => array( |
|
525 | + 'js' => 'dd', |
|
526 | + 'moment' => 'DD', |
|
527 | + ), |
|
528 | + // Mon |
|
529 | + 'D' => array( |
|
530 | + 'js' => 'D', |
|
531 | + 'moment' => 'ddd', |
|
532 | + ), |
|
533 | + // 1,2,...31 |
|
534 | + 'j' => array( |
|
535 | + 'js' => 'd', |
|
536 | + 'moment' => 'D', |
|
537 | + ), |
|
538 | + // Monday |
|
539 | + 'l' => array( |
|
540 | + 'js' => 'DD', |
|
541 | + 'moment' => 'dddd', |
|
542 | + ), |
|
543 | + // ISO numeric representation of the day of the week (1-6) |
|
544 | + 'N' => array( |
|
545 | + 'js' => '', |
|
546 | + 'moment' => 'E', |
|
547 | + ), |
|
548 | + // st,nd.rd |
|
549 | + 'S' => array( |
|
550 | + 'js' => '', |
|
551 | + 'moment' => 'o', |
|
552 | + ), |
|
553 | + // numeric representation of day of week (0-6) |
|
554 | + 'w' => array( |
|
555 | + 'js' => '', |
|
556 | + 'moment' => 'd', |
|
557 | + ), |
|
558 | + // day of year starting from 0 (0-365) |
|
559 | + 'z' => array( |
|
560 | + 'js' => 'o', |
|
561 | + 'moment' => 'DDD' // note moment does not start with 0 so will need to modify by subtracting 1 |
|
562 | + ), |
|
563 | + // Week |
|
564 | + // ISO-8601 week number of year (weeks starting on monday) |
|
565 | + 'W' => array( |
|
566 | + 'js' => '', |
|
567 | + 'moment' => 'w', |
|
568 | + ), |
|
569 | + // Month |
|
570 | + // January...December |
|
571 | + 'F' => array( |
|
572 | + 'js' => 'MM', |
|
573 | + 'moment' => 'MMMM', |
|
574 | + ), |
|
575 | + // 01...12 |
|
576 | + 'm' => array( |
|
577 | + 'js' => 'mm', |
|
578 | + 'moment' => 'MM', |
|
579 | + ), |
|
580 | + // Jan...Dec |
|
581 | + 'M' => array( |
|
582 | + 'js' => 'M', |
|
583 | + 'moment' => 'MMM', |
|
584 | + ), |
|
585 | + // 1-12 |
|
586 | + 'n' => array( |
|
587 | + 'js' => 'm', |
|
588 | + 'moment' => 'M', |
|
589 | + ), |
|
590 | + // number of days in given month |
|
591 | + 't' => array( |
|
592 | + 'js' => '', |
|
593 | + 'moment' => '', |
|
594 | + ), |
|
595 | + // Year |
|
596 | + // whether leap year or not 1/0 |
|
597 | + 'L' => array( |
|
598 | + 'js' => '', |
|
599 | + 'moment' => '', |
|
600 | + ), |
|
601 | + // ISO-8601 year number |
|
602 | + 'o' => array( |
|
603 | + 'js' => '', |
|
604 | + 'moment' => 'GGGG', |
|
605 | + ), |
|
606 | + // 1999...2003 |
|
607 | + 'Y' => array( |
|
608 | + 'js' => 'yy', |
|
609 | + 'moment' => 'YYYY', |
|
610 | + ), |
|
611 | + // 99...03 |
|
612 | + 'y' => array( |
|
613 | + 'js' => 'y', |
|
614 | + 'moment' => 'YY', |
|
615 | + ), |
|
616 | + // Time |
|
617 | + // am/pm |
|
618 | + 'a' => array( |
|
619 | + 'js' => 'tt', |
|
620 | + 'moment' => 'a', |
|
621 | + ), |
|
622 | + // AM/PM |
|
623 | + 'A' => array( |
|
624 | + 'js' => 'TT', |
|
625 | + 'moment' => 'A', |
|
626 | + ), |
|
627 | + // Swatch Internet Time?!? |
|
628 | + 'B' => array( |
|
629 | + 'js' => '', |
|
630 | + 'moment' => '', |
|
631 | + ), |
|
632 | + // 1...12 |
|
633 | + 'g' => array( |
|
634 | + 'js' => 'h', |
|
635 | + 'moment' => 'h', |
|
636 | + ), |
|
637 | + // 0...23 |
|
638 | + 'G' => array( |
|
639 | + 'js' => 'H', |
|
640 | + 'moment' => 'H', |
|
641 | + ), |
|
642 | + // 01...12 |
|
643 | + 'h' => array( |
|
644 | + 'js' => 'hh', |
|
645 | + 'moment' => 'hh', |
|
646 | + ), |
|
647 | + // 00...23 |
|
648 | + 'H' => array( |
|
649 | + 'js' => 'HH', |
|
650 | + 'moment' => 'HH', |
|
651 | + ), |
|
652 | + // 00..59 |
|
653 | + 'i' => array( |
|
654 | + 'js' => 'mm', |
|
655 | + 'moment' => 'mm', |
|
656 | + ), |
|
657 | + // seconds... 00...59 |
|
658 | + 's' => array( |
|
659 | + 'js' => 'ss', |
|
660 | + 'moment' => 'ss', |
|
661 | + ), |
|
662 | + // microseconds |
|
663 | + 'u' => array( |
|
664 | + 'js' => '', |
|
665 | + 'moment' => '', |
|
666 | + ), |
|
667 | + ); |
|
668 | + $jquery_ui_format = ''; |
|
669 | + $moment_format = ''; |
|
670 | + $escaping = false; |
|
671 | + $format_string_length = strlen($format_string); |
|
672 | + for ($i = 0; $i < $format_string_length; $i++) { |
|
673 | + $char = $format_string[ $i ]; |
|
674 | + if ($char === '\\') { // PHP date format escaping character |
|
675 | + $i++; |
|
676 | + if ($escaping) { |
|
677 | + $jquery_ui_format .= $format_string[ $i ]; |
|
678 | + $moment_format .= $format_string[ $i ]; |
|
679 | + } else { |
|
680 | + $jquery_ui_format .= '\'' . $format_string[ $i ]; |
|
681 | + $moment_format .= $format_string[ $i ]; |
|
682 | + } |
|
683 | + $escaping = true; |
|
684 | + } else { |
|
685 | + if ($escaping) { |
|
686 | + $jquery_ui_format .= "'"; |
|
687 | + $moment_format .= "'"; |
|
688 | + $escaping = false; |
|
689 | + } |
|
690 | + if (isset($symbols_map[ $char ])) { |
|
691 | + $jquery_ui_format .= $symbols_map[ $char ]['js']; |
|
692 | + $moment_format .= $symbols_map[ $char ]['moment']; |
|
693 | + } else { |
|
694 | + $jquery_ui_format .= $char; |
|
695 | + $moment_format .= $char; |
|
696 | + } |
|
697 | + } |
|
698 | + } |
|
699 | + return array('js' => $jquery_ui_format, 'moment' => $moment_format); |
|
700 | + } |
|
701 | 701 | |
702 | 702 | |
703 | - /** |
|
704 | - * This takes an incoming format string and validates it to ensure it will work fine with PHP. |
|
705 | - * |
|
706 | - * @param string $format_string Incoming format string for php date(). |
|
707 | - * @return mixed bool|array If all is okay then TRUE is returned. Otherwise an array of validation |
|
708 | - * errors is returned. So for client code calling, check for is_array() to |
|
709 | - * indicate failed validations. |
|
710 | - */ |
|
711 | - public static function validate_format_string($format_string) |
|
712 | - { |
|
713 | - $error_msg = array(); |
|
714 | - // time format checks |
|
715 | - switch (true) { |
|
716 | - case strpos($format_string, 'h') !== false: |
|
717 | - case strpos($format_string, 'g') !== false: |
|
718 | - /** |
|
719 | - * if the time string has a lowercase 'h' which == 12 hour time format and there |
|
720 | - * is not any ante meridiem format ('a' or 'A'). Then throw an error because its |
|
721 | - * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am. |
|
722 | - */ |
|
723 | - if (stripos($format_string, 'A') === false) { |
|
724 | - $error_msg[] = esc_html__( |
|
725 | - 'There is a time format for 12 hour time but no "a" or "A" to indicate am/pm. Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".', |
|
726 | - 'event_espresso' |
|
727 | - ); |
|
728 | - } |
|
729 | - break; |
|
730 | - } |
|
731 | - return empty($error_msg) ? true : $error_msg; |
|
732 | - } |
|
703 | + /** |
|
704 | + * This takes an incoming format string and validates it to ensure it will work fine with PHP. |
|
705 | + * |
|
706 | + * @param string $format_string Incoming format string for php date(). |
|
707 | + * @return mixed bool|array If all is okay then TRUE is returned. Otherwise an array of validation |
|
708 | + * errors is returned. So for client code calling, check for is_array() to |
|
709 | + * indicate failed validations. |
|
710 | + */ |
|
711 | + public static function validate_format_string($format_string) |
|
712 | + { |
|
713 | + $error_msg = array(); |
|
714 | + // time format checks |
|
715 | + switch (true) { |
|
716 | + case strpos($format_string, 'h') !== false: |
|
717 | + case strpos($format_string, 'g') !== false: |
|
718 | + /** |
|
719 | + * if the time string has a lowercase 'h' which == 12 hour time format and there |
|
720 | + * is not any ante meridiem format ('a' or 'A'). Then throw an error because its |
|
721 | + * too ambiguous and PHP won't be able to figure out whether 1 = 1pm or 1am. |
|
722 | + */ |
|
723 | + if (stripos($format_string, 'A') === false) { |
|
724 | + $error_msg[] = esc_html__( |
|
725 | + 'There is a time format for 12 hour time but no "a" or "A" to indicate am/pm. Without this distinction, PHP is unable to determine if a "1" for the hour value equals "1pm" or "1am".', |
|
726 | + 'event_espresso' |
|
727 | + ); |
|
728 | + } |
|
729 | + break; |
|
730 | + } |
|
731 | + return empty($error_msg) ? true : $error_msg; |
|
732 | + } |
|
733 | 733 | |
734 | 734 | |
735 | - /** |
|
736 | - * If the the first date starts at midnight on one day, and the next date ends at midnight on the |
|
737 | - * very next day then this method will return true. |
|
738 | - * If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true. |
|
739 | - * If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false. |
|
740 | - * If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true. |
|
741 | - * |
|
742 | - * @param mixed $date_1 |
|
743 | - * @param mixed $date_2 |
|
744 | - * @return bool |
|
745 | - */ |
|
746 | - public static function dates_represent_one_24_hour_date($date_1, $date_2) |
|
747 | - { |
|
735 | + /** |
|
736 | + * If the the first date starts at midnight on one day, and the next date ends at midnight on the |
|
737 | + * very next day then this method will return true. |
|
738 | + * If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-16 00:00:00 then this function will return true. |
|
739 | + * If $date_1 = 2015-12-15 03:00:00 and $date_2 = 2015-12_16 03:00:00 then this function will return false. |
|
740 | + * If $date_1 = 2015-12-15 00:00:00 and $date_2 = 2015-12-15 00:00:00 then this function will return true. |
|
741 | + * |
|
742 | + * @param mixed $date_1 |
|
743 | + * @param mixed $date_2 |
|
744 | + * @return bool |
|
745 | + */ |
|
746 | + public static function dates_represent_one_24_hour_date($date_1, $date_2) |
|
747 | + { |
|
748 | 748 | |
749 | - if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) |
|
750 | - || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00' |
|
751 | - || $date_2->format( |
|
752 | - EE_Datetime_Field::mysql_time_format |
|
753 | - ) !== '00:00:00') |
|
754 | - ) { |
|
755 | - return false; |
|
756 | - } |
|
757 | - return $date_2->format('U') - $date_1->format('U') === 86400; |
|
758 | - } |
|
749 | + if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) |
|
750 | + || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00' |
|
751 | + || $date_2->format( |
|
752 | + EE_Datetime_Field::mysql_time_format |
|
753 | + ) !== '00:00:00') |
|
754 | + ) { |
|
755 | + return false; |
|
756 | + } |
|
757 | + return $date_2->format('U') - $date_1->format('U') === 86400; |
|
758 | + } |
|
759 | 759 | |
760 | 760 | |
761 | - /** |
|
762 | - * This returns the appropriate query interval string that can be used in sql queries involving mysql Date |
|
763 | - * Functions. |
|
764 | - * |
|
765 | - * @param string $timezone_string A timezone string in a valid format to instantiate a DateTimeZone object. |
|
766 | - * @param string $field_for_interval The Database field that is the interval is applied to in the query. |
|
767 | - * @return string |
|
768 | - */ |
|
769 | - public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval) |
|
770 | - { |
|
771 | - try { |
|
772 | - /** need to account for timezone offset on the selects */ |
|
773 | - $DateTimeZone = new DateTimeZone($timezone_string); |
|
774 | - } catch (Exception $e) { |
|
775 | - $DateTimeZone = null; |
|
776 | - } |
|
777 | - /** |
|
778 | - * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds. |
|
779 | - * Hence we do the calc for DateTimeZone::getOffset. |
|
780 | - */ |
|
781 | - $offset = $DateTimeZone instanceof DateTimeZone |
|
782 | - ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS |
|
783 | - : (float) get_option('gmt_offset'); |
|
784 | - $query_interval = $offset < 0 |
|
785 | - ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)' |
|
786 | - : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)'; |
|
787 | - return $query_interval; |
|
788 | - } |
|
761 | + /** |
|
762 | + * This returns the appropriate query interval string that can be used in sql queries involving mysql Date |
|
763 | + * Functions. |
|
764 | + * |
|
765 | + * @param string $timezone_string A timezone string in a valid format to instantiate a DateTimeZone object. |
|
766 | + * @param string $field_for_interval The Database field that is the interval is applied to in the query. |
|
767 | + * @return string |
|
768 | + */ |
|
769 | + public static function get_sql_query_interval_for_offset($timezone_string, $field_for_interval) |
|
770 | + { |
|
771 | + try { |
|
772 | + /** need to account for timezone offset on the selects */ |
|
773 | + $DateTimeZone = new DateTimeZone($timezone_string); |
|
774 | + } catch (Exception $e) { |
|
775 | + $DateTimeZone = null; |
|
776 | + } |
|
777 | + /** |
|
778 | + * Note get_option( 'gmt_offset') returns a value in hours, whereas DateTimeZone::getOffset returns values in seconds. |
|
779 | + * Hence we do the calc for DateTimeZone::getOffset. |
|
780 | + */ |
|
781 | + $offset = $DateTimeZone instanceof DateTimeZone |
|
782 | + ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS |
|
783 | + : (float) get_option('gmt_offset'); |
|
784 | + $query_interval = $offset < 0 |
|
785 | + ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)' |
|
786 | + : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)'; |
|
787 | + return $query_interval; |
|
788 | + } |
|
789 | 789 | |
790 | 790 | |
791 | - /** |
|
792 | - * Retrieves the site's default timezone and returns it formatted so it's ready for display |
|
793 | - * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string' |
|
794 | - * and 'gmt_offset' WordPress options directly; or use the filter |
|
795 | - * FHEE__EEH_DTT_Helper__get_timezone_string_for_display |
|
796 | - * (although note that we remove any HTML that may be added) |
|
797 | - * |
|
798 | - * @return string |
|
799 | - */ |
|
800 | - public static function get_timezone_string_for_display() |
|
801 | - { |
|
802 | - $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', ''); |
|
803 | - if (! empty($pretty_timezone)) { |
|
804 | - return esc_html($pretty_timezone); |
|
805 | - } |
|
806 | - $timezone_string = get_option('timezone_string'); |
|
807 | - if ($timezone_string) { |
|
808 | - static $mo_loaded = false; |
|
809 | - // Load translations for continents and cities just like wp_timezone_choice does |
|
810 | - if (! $mo_loaded) { |
|
811 | - $locale = get_locale(); |
|
812 | - $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo'; |
|
813 | - load_textdomain('continents-cities', $mofile); |
|
814 | - $mo_loaded = true; |
|
815 | - } |
|
816 | - // well that was easy. |
|
817 | - $parts = explode('/', $timezone_string); |
|
818 | - // remove the continent |
|
819 | - unset($parts[0]); |
|
820 | - $t_parts = array(); |
|
821 | - // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText |
|
822 | - // phpcs:disable WordPress.WP.I18n.TextDomainMismatch |
|
823 | - // disabled because this code is copied from WordPress and is a WordPress domain |
|
824 | - foreach ($parts as $part) { |
|
825 | - $t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities'); |
|
826 | - } |
|
827 | - return implode(' - ', $t_parts); |
|
828 | - // phpcs:enable |
|
829 | - } |
|
830 | - // they haven't set the timezone string, so let's return a string like "UTC+1" |
|
831 | - $gmt_offset = get_option('gmt_offset'); |
|
832 | - $prefix = (int) $gmt_offset >= 0 ? '+' : ''; |
|
833 | - $parts = explode('.', (string) $gmt_offset); |
|
834 | - if (count($parts) === 1) { |
|
835 | - $parts[1] = '00'; |
|
836 | - } else { |
|
837 | - // convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25) |
|
838 | - // to minutes, eg 30 or 15, respectively |
|
839 | - $hour_fraction = (float) ('0.' . $parts[1]); |
|
840 | - $parts[1] = (string) $hour_fraction * 60; |
|
841 | - } |
|
842 | - return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts)); |
|
843 | - } |
|
791 | + /** |
|
792 | + * Retrieves the site's default timezone and returns it formatted so it's ready for display |
|
793 | + * to users. If you want to customize how its displayed feel free to fetch the 'timezone_string' |
|
794 | + * and 'gmt_offset' WordPress options directly; or use the filter |
|
795 | + * FHEE__EEH_DTT_Helper__get_timezone_string_for_display |
|
796 | + * (although note that we remove any HTML that may be added) |
|
797 | + * |
|
798 | + * @return string |
|
799 | + */ |
|
800 | + public static function get_timezone_string_for_display() |
|
801 | + { |
|
802 | + $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', ''); |
|
803 | + if (! empty($pretty_timezone)) { |
|
804 | + return esc_html($pretty_timezone); |
|
805 | + } |
|
806 | + $timezone_string = get_option('timezone_string'); |
|
807 | + if ($timezone_string) { |
|
808 | + static $mo_loaded = false; |
|
809 | + // Load translations for continents and cities just like wp_timezone_choice does |
|
810 | + if (! $mo_loaded) { |
|
811 | + $locale = get_locale(); |
|
812 | + $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo'; |
|
813 | + load_textdomain('continents-cities', $mofile); |
|
814 | + $mo_loaded = true; |
|
815 | + } |
|
816 | + // well that was easy. |
|
817 | + $parts = explode('/', $timezone_string); |
|
818 | + // remove the continent |
|
819 | + unset($parts[0]); |
|
820 | + $t_parts = array(); |
|
821 | + // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText |
|
822 | + // phpcs:disable WordPress.WP.I18n.TextDomainMismatch |
|
823 | + // disabled because this code is copied from WordPress and is a WordPress domain |
|
824 | + foreach ($parts as $part) { |
|
825 | + $t_parts[] = translate(str_replace('_', ' ', $part), 'continents-cities'); |
|
826 | + } |
|
827 | + return implode(' - ', $t_parts); |
|
828 | + // phpcs:enable |
|
829 | + } |
|
830 | + // they haven't set the timezone string, so let's return a string like "UTC+1" |
|
831 | + $gmt_offset = get_option('gmt_offset'); |
|
832 | + $prefix = (int) $gmt_offset >= 0 ? '+' : ''; |
|
833 | + $parts = explode('.', (string) $gmt_offset); |
|
834 | + if (count($parts) === 1) { |
|
835 | + $parts[1] = '00'; |
|
836 | + } else { |
|
837 | + // convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25) |
|
838 | + // to minutes, eg 30 or 15, respectively |
|
839 | + $hour_fraction = (float) ('0.' . $parts[1]); |
|
840 | + $parts[1] = (string) $hour_fraction * 60; |
|
841 | + } |
|
842 | + return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts)); |
|
843 | + } |
|
844 | 844 | |
845 | 845 | |
846 | 846 | |
847 | - /** |
|
848 | - * So PHP does this awesome thing where if you are trying to get a timestamp |
|
849 | - * for a month using a string like "February" or "February 2017", |
|
850 | - * and you don't specify a day as part of your string, |
|
851 | - * then PHP will use whatever the current day of the month is. |
|
852 | - * IF the current day of the month happens to be the 30th or 31st, |
|
853 | - * then PHP gets really confused by a date like February 30, |
|
854 | - * so instead of saying |
|
855 | - * "Hey February only has 28 days (this year)... |
|
856 | - * ...you must have meant the last day of the month!" |
|
857 | - * PHP does the next most logical thing, and bumps the date up to March 2nd, |
|
858 | - * because someone requesting February 30th obviously meant March 1st! |
|
859 | - * The way around this is to always set the day to the first, |
|
860 | - * so that the month will stay on the month you wanted. |
|
861 | - * this method will add that "1" into your date regardless of the format. |
|
862 | - * |
|
863 | - * @param string $month |
|
864 | - * @return string |
|
865 | - */ |
|
866 | - public static function first_of_month_timestamp($month = '') |
|
867 | - { |
|
868 | - $month = (string) $month; |
|
869 | - $year = ''; |
|
870 | - // check if the incoming string has a year in it or not |
|
871 | - if (preg_match('/\b\d{4}\b/', $month, $matches)) { |
|
872 | - $year = $matches[0]; |
|
873 | - // ten remove that from the month string as well as any spaces |
|
874 | - $month = trim(str_replace($year, '', $month)); |
|
875 | - // add a space before the year |
|
876 | - $year = " {$year}"; |
|
877 | - } |
|
878 | - // return timestamp for something like "February 1 2017" |
|
879 | - return strtotime("{$month} 1{$year}"); |
|
880 | - } |
|
847 | + /** |
|
848 | + * So PHP does this awesome thing where if you are trying to get a timestamp |
|
849 | + * for a month using a string like "February" or "February 2017", |
|
850 | + * and you don't specify a day as part of your string, |
|
851 | + * then PHP will use whatever the current day of the month is. |
|
852 | + * IF the current day of the month happens to be the 30th or 31st, |
|
853 | + * then PHP gets really confused by a date like February 30, |
|
854 | + * so instead of saying |
|
855 | + * "Hey February only has 28 days (this year)... |
|
856 | + * ...you must have meant the last day of the month!" |
|
857 | + * PHP does the next most logical thing, and bumps the date up to March 2nd, |
|
858 | + * because someone requesting February 30th obviously meant March 1st! |
|
859 | + * The way around this is to always set the day to the first, |
|
860 | + * so that the month will stay on the month you wanted. |
|
861 | + * this method will add that "1" into your date regardless of the format. |
|
862 | + * |
|
863 | + * @param string $month |
|
864 | + * @return string |
|
865 | + */ |
|
866 | + public static function first_of_month_timestamp($month = '') |
|
867 | + { |
|
868 | + $month = (string) $month; |
|
869 | + $year = ''; |
|
870 | + // check if the incoming string has a year in it or not |
|
871 | + if (preg_match('/\b\d{4}\b/', $month, $matches)) { |
|
872 | + $year = $matches[0]; |
|
873 | + // ten remove that from the month string as well as any spaces |
|
874 | + $month = trim(str_replace($year, '', $month)); |
|
875 | + // add a space before the year |
|
876 | + $year = " {$year}"; |
|
877 | + } |
|
878 | + // return timestamp for something like "February 1 2017" |
|
879 | + return strtotime("{$month} 1{$year}"); |
|
880 | + } |
|
881 | 881 | |
882 | 882 | |
883 | - /** |
|
884 | - * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone. So it may be midnight |
|
885 | - * for this sites timezone, but the timestamp could be some other time GMT. |
|
886 | - */ |
|
887 | - public static function tomorrow() |
|
888 | - { |
|
889 | - // The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive |
|
890 | - // before adding to the timestamp. Why? Because we want tomorrow to be for midnight the next day in THIS timezone |
|
891 | - // not an offset from midnight in UTC. So if we're starting with UTC 00:00:00, then we want to make sure the |
|
892 | - // final timestamp is equivalent to midnight in this timezone as represented in GMT. |
|
893 | - return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1); |
|
894 | - } |
|
883 | + /** |
|
884 | + * This simply returns the timestamp for tomorrow (midnight next day) in this sites timezone. So it may be midnight |
|
885 | + * for this sites timezone, but the timestamp could be some other time GMT. |
|
886 | + */ |
|
887 | + public static function tomorrow() |
|
888 | + { |
|
889 | + // The multiplication of -1 ensures that we switch positive offsets to negative and negative offsets to positive |
|
890 | + // before adding to the timestamp. Why? Because we want tomorrow to be for midnight the next day in THIS timezone |
|
891 | + // not an offset from midnight in UTC. So if we're starting with UTC 00:00:00, then we want to make sure the |
|
892 | + // final timestamp is equivalent to midnight in this timezone as represented in GMT. |
|
893 | + return strtotime('tomorrow') + (self::get_site_timezone_gmt_offset() * -1); |
|
894 | + } |
|
895 | 895 | |
896 | 896 | |
897 | - /** |
|
898 | - * ** |
|
899 | - * Gives a nicely-formatted list of timezone strings. |
|
900 | - * Copied from the core wp function by the same name so we could customize to remove UTC offsets. |
|
901 | - * |
|
902 | - * @since 4.9.40.rc.008 |
|
903 | - * @staticvar bool $mo_loaded |
|
904 | - * @staticvar string $locale_loaded |
|
905 | - * @param string $selected_zone Selected timezone. |
|
906 | - * @param string $locale Optional. Locale to load the timezones in. Default current site locale. |
|
907 | - * @return string |
|
908 | - */ |
|
909 | - public static function wp_timezone_choice($selected_zone, $locale = null) |
|
910 | - { |
|
911 | - static $mo_loaded = false, $locale_loaded = null; |
|
912 | - $continents = array( |
|
913 | - 'Africa', |
|
914 | - 'America', |
|
915 | - 'Antarctica', |
|
916 | - 'Arctic', |
|
917 | - 'Asia', |
|
918 | - 'Atlantic', |
|
919 | - 'Australia', |
|
920 | - 'Europe', |
|
921 | - 'Indian', |
|
922 | - 'Pacific', |
|
923 | - ); |
|
924 | - // Load translations for continents and cities. |
|
925 | - if (! $mo_loaded || $locale !== $locale_loaded) { |
|
926 | - $locale_loaded = $locale ? $locale : get_locale(); |
|
927 | - $mofile = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo'; |
|
928 | - unload_textdomain('continents-cities'); |
|
929 | - load_textdomain('continents-cities', $mofile); |
|
930 | - $mo_loaded = true; |
|
931 | - } |
|
932 | - $zone_data = array(); |
|
933 | - foreach (timezone_identifiers_list() as $zone) { |
|
934 | - $zone = explode('/', $zone); |
|
935 | - if (! in_array($zone[0], $continents, true)) { |
|
936 | - continue; |
|
937 | - } |
|
938 | - // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later |
|
939 | - $exists = array( |
|
940 | - 0 => isset($zone[0]) && $zone[0], |
|
941 | - 1 => isset($zone[1]) && $zone[1], |
|
942 | - 2 => isset($zone[2]) && $zone[2], |
|
943 | - ); |
|
944 | - $exists[3] = $exists[0] && $zone[0] !== 'Etc'; |
|
945 | - $exists[4] = $exists[1] && $exists[3]; |
|
946 | - $exists[5] = $exists[2] && $exists[3]; |
|
947 | - // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText |
|
948 | - // phpcs:disable WordPress.WP.I18n.TextDomainMismatch |
|
949 | - // disabled because this code is copied from WordPress and is a WordPress domain |
|
950 | - $zone_data[] = array( |
|
951 | - 'continent' => $exists[0] ? $zone[0] : '', |
|
952 | - 'city' => $exists[1] ? $zone[1] : '', |
|
953 | - 'subcity' => $exists[2] ? $zone[2] : '', |
|
954 | - 't_continent' => $exists[3] |
|
955 | - ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities') |
|
956 | - : '', |
|
957 | - 't_city' => $exists[4] |
|
958 | - ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities') |
|
959 | - : '', |
|
960 | - 't_subcity' => $exists[5] |
|
961 | - ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities') |
|
962 | - : '', |
|
963 | - ); |
|
964 | - // phpcs:enable |
|
965 | - } |
|
966 | - usort($zone_data, '_wp_timezone_choice_usort_callback'); |
|
967 | - $structure = array(); |
|
968 | - if (empty($selected_zone)) { |
|
969 | - $structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>'; |
|
970 | - } |
|
971 | - foreach ($zone_data as $key => $zone) { |
|
972 | - // Build value in an array to join later |
|
973 | - $value = array($zone['continent']); |
|
974 | - if (empty($zone['city'])) { |
|
975 | - // It's at the continent level (generally won't happen) |
|
976 | - $display = $zone['t_continent']; |
|
977 | - } else { |
|
978 | - // It's inside a continent group |
|
979 | - // Continent optgroup |
|
980 | - if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) { |
|
981 | - $label = $zone['t_continent']; |
|
982 | - $structure[] = '<optgroup label="' . esc_attr($label) . '">'; |
|
983 | - } |
|
984 | - // Add the city to the value |
|
985 | - $value[] = $zone['city']; |
|
986 | - $display = $zone['t_city']; |
|
987 | - if (! empty($zone['subcity'])) { |
|
988 | - // Add the subcity to the value |
|
989 | - $value[] = $zone['subcity']; |
|
990 | - $display .= ' - ' . $zone['t_subcity']; |
|
991 | - } |
|
992 | - } |
|
993 | - // Build the value |
|
994 | - $value = implode('/', $value); |
|
995 | - $selected = $value === $selected_zone ? ' selected="selected"' : ''; |
|
996 | - $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>' |
|
997 | - . esc_html($display) |
|
998 | - . '</option>'; |
|
999 | - // Close continent optgroup |
|
1000 | - if (! empty($zone['city']) |
|
1001 | - && ( |
|
1002 | - ! isset($zone_data[ $key + 1 ]) |
|
1003 | - || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent']) |
|
1004 | - ) |
|
1005 | - ) { |
|
1006 | - $structure[] = '</optgroup>'; |
|
1007 | - } |
|
1008 | - } |
|
1009 | - return implode("\n", $structure); |
|
1010 | - } |
|
897 | + /** |
|
898 | + * ** |
|
899 | + * Gives a nicely-formatted list of timezone strings. |
|
900 | + * Copied from the core wp function by the same name so we could customize to remove UTC offsets. |
|
901 | + * |
|
902 | + * @since 4.9.40.rc.008 |
|
903 | + * @staticvar bool $mo_loaded |
|
904 | + * @staticvar string $locale_loaded |
|
905 | + * @param string $selected_zone Selected timezone. |
|
906 | + * @param string $locale Optional. Locale to load the timezones in. Default current site locale. |
|
907 | + * @return string |
|
908 | + */ |
|
909 | + public static function wp_timezone_choice($selected_zone, $locale = null) |
|
910 | + { |
|
911 | + static $mo_loaded = false, $locale_loaded = null; |
|
912 | + $continents = array( |
|
913 | + 'Africa', |
|
914 | + 'America', |
|
915 | + 'Antarctica', |
|
916 | + 'Arctic', |
|
917 | + 'Asia', |
|
918 | + 'Atlantic', |
|
919 | + 'Australia', |
|
920 | + 'Europe', |
|
921 | + 'Indian', |
|
922 | + 'Pacific', |
|
923 | + ); |
|
924 | + // Load translations for continents and cities. |
|
925 | + if (! $mo_loaded || $locale !== $locale_loaded) { |
|
926 | + $locale_loaded = $locale ? $locale : get_locale(); |
|
927 | + $mofile = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo'; |
|
928 | + unload_textdomain('continents-cities'); |
|
929 | + load_textdomain('continents-cities', $mofile); |
|
930 | + $mo_loaded = true; |
|
931 | + } |
|
932 | + $zone_data = array(); |
|
933 | + foreach (timezone_identifiers_list() as $zone) { |
|
934 | + $zone = explode('/', $zone); |
|
935 | + if (! in_array($zone[0], $continents, true)) { |
|
936 | + continue; |
|
937 | + } |
|
938 | + // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later |
|
939 | + $exists = array( |
|
940 | + 0 => isset($zone[0]) && $zone[0], |
|
941 | + 1 => isset($zone[1]) && $zone[1], |
|
942 | + 2 => isset($zone[2]) && $zone[2], |
|
943 | + ); |
|
944 | + $exists[3] = $exists[0] && $zone[0] !== 'Etc'; |
|
945 | + $exists[4] = $exists[1] && $exists[3]; |
|
946 | + $exists[5] = $exists[2] && $exists[3]; |
|
947 | + // phpcs:disable WordPress.WP.I18n.NonSingularStringLiteralText |
|
948 | + // phpcs:disable WordPress.WP.I18n.TextDomainMismatch |
|
949 | + // disabled because this code is copied from WordPress and is a WordPress domain |
|
950 | + $zone_data[] = array( |
|
951 | + 'continent' => $exists[0] ? $zone[0] : '', |
|
952 | + 'city' => $exists[1] ? $zone[1] : '', |
|
953 | + 'subcity' => $exists[2] ? $zone[2] : '', |
|
954 | + 't_continent' => $exists[3] |
|
955 | + ? translate(str_replace('_', ' ', $zone[0]), 'continents-cities') |
|
956 | + : '', |
|
957 | + 't_city' => $exists[4] |
|
958 | + ? translate(str_replace('_', ' ', $zone[1]), 'continents-cities') |
|
959 | + : '', |
|
960 | + 't_subcity' => $exists[5] |
|
961 | + ? translate(str_replace('_', ' ', $zone[2]), 'continents-cities') |
|
962 | + : '', |
|
963 | + ); |
|
964 | + // phpcs:enable |
|
965 | + } |
|
966 | + usort($zone_data, '_wp_timezone_choice_usort_callback'); |
|
967 | + $structure = array(); |
|
968 | + if (empty($selected_zone)) { |
|
969 | + $structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>'; |
|
970 | + } |
|
971 | + foreach ($zone_data as $key => $zone) { |
|
972 | + // Build value in an array to join later |
|
973 | + $value = array($zone['continent']); |
|
974 | + if (empty($zone['city'])) { |
|
975 | + // It's at the continent level (generally won't happen) |
|
976 | + $display = $zone['t_continent']; |
|
977 | + } else { |
|
978 | + // It's inside a continent group |
|
979 | + // Continent optgroup |
|
980 | + if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) { |
|
981 | + $label = $zone['t_continent']; |
|
982 | + $structure[] = '<optgroup label="' . esc_attr($label) . '">'; |
|
983 | + } |
|
984 | + // Add the city to the value |
|
985 | + $value[] = $zone['city']; |
|
986 | + $display = $zone['t_city']; |
|
987 | + if (! empty($zone['subcity'])) { |
|
988 | + // Add the subcity to the value |
|
989 | + $value[] = $zone['subcity']; |
|
990 | + $display .= ' - ' . $zone['t_subcity']; |
|
991 | + } |
|
992 | + } |
|
993 | + // Build the value |
|
994 | + $value = implode('/', $value); |
|
995 | + $selected = $value === $selected_zone ? ' selected="selected"' : ''; |
|
996 | + $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>' |
|
997 | + . esc_html($display) |
|
998 | + . '</option>'; |
|
999 | + // Close continent optgroup |
|
1000 | + if (! empty($zone['city']) |
|
1001 | + && ( |
|
1002 | + ! isset($zone_data[ $key + 1 ]) |
|
1003 | + || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent']) |
|
1004 | + ) |
|
1005 | + ) { |
|
1006 | + $structure[] = '</optgroup>'; |
|
1007 | + } |
|
1008 | + } |
|
1009 | + return implode("\n", $structure); |
|
1010 | + } |
|
1011 | 1011 | |
1012 | 1012 | |
1013 | - /** |
|
1014 | - * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0 |
|
1015 | - * |
|
1016 | - * @param int|WP_User $user_id |
|
1017 | - * @return string |
|
1018 | - */ |
|
1019 | - public static function get_user_locale($user_id = 0) |
|
1020 | - { |
|
1021 | - if (function_exists('get_user_locale')) { |
|
1022 | - return get_user_locale($user_id); |
|
1023 | - } |
|
1024 | - return get_locale(); |
|
1025 | - } |
|
1013 | + /** |
|
1014 | + * Shim for the WP function `get_user_locale` that was added in WordPress 4.7.0 |
|
1015 | + * |
|
1016 | + * @param int|WP_User $user_id |
|
1017 | + * @return string |
|
1018 | + */ |
|
1019 | + public static function get_user_locale($user_id = 0) |
|
1020 | + { |
|
1021 | + if (function_exists('get_user_locale')) { |
|
1022 | + return get_user_locale($user_id); |
|
1023 | + } |
|
1024 | + return get_locale(); |
|
1025 | + } |
|
1026 | 1026 | |
1027 | 1027 | |
1028 | - /** |
|
1029 | - * Return the appropriate helper adapter for DTT related things. |
|
1030 | - * |
|
1031 | - * @return HelperInterface |
|
1032 | - * @throws InvalidArgumentException |
|
1033 | - * @throws InvalidDataTypeException |
|
1034 | - * @throws InvalidInterfaceException |
|
1035 | - */ |
|
1036 | - private static function getHelperAdapter() |
|
1037 | - { |
|
1038 | - $dtt_helper_fqcn = PHP_VERSION_ID < 50600 |
|
1039 | - ? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper' |
|
1040 | - : 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'; |
|
1041 | - return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn); |
|
1042 | - } |
|
1028 | + /** |
|
1029 | + * Return the appropriate helper adapter for DTT related things. |
|
1030 | + * |
|
1031 | + * @return HelperInterface |
|
1032 | + * @throws InvalidArgumentException |
|
1033 | + * @throws InvalidDataTypeException |
|
1034 | + * @throws InvalidInterfaceException |
|
1035 | + */ |
|
1036 | + private static function getHelperAdapter() |
|
1037 | + { |
|
1038 | + $dtt_helper_fqcn = PHP_VERSION_ID < 50600 |
|
1039 | + ? 'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper' |
|
1040 | + : 'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'; |
|
1041 | + return LoaderFactory::getLoader()->getShared($dtt_helper_fqcn); |
|
1042 | + } |
|
1043 | 1043 | |
1044 | 1044 | |
1045 | - /** |
|
1046 | - * Helper function for setting the timezone on a DateTime object. |
|
1047 | - * This is implemented to standardize a workaround for a PHP bug outlined in |
|
1048 | - * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and |
|
1049 | - * https://events.codebasehq.com/projects/event-espresso/tickets/11233 |
|
1050 | - * |
|
1051 | - * @param DateTime $datetime |
|
1052 | - * @param DateTimeZone $timezone |
|
1053 | - */ |
|
1054 | - public static function setTimezone(DateTime $datetime, DateTimeZone $timezone) |
|
1055 | - { |
|
1056 | - $datetime->setTimezone($timezone); |
|
1057 | - $datetime->getTimestamp(); |
|
1058 | - } |
|
1045 | + /** |
|
1046 | + * Helper function for setting the timezone on a DateTime object. |
|
1047 | + * This is implemented to standardize a workaround for a PHP bug outlined in |
|
1048 | + * https://events.codebasehq.com/projects/event-espresso/tickets/11407 and |
|
1049 | + * https://events.codebasehq.com/projects/event-espresso/tickets/11233 |
|
1050 | + * |
|
1051 | + * @param DateTime $datetime |
|
1052 | + * @param DateTimeZone $timezone |
|
1053 | + */ |
|
1054 | + public static function setTimezone(DateTime $datetime, DateTimeZone $timezone) |
|
1055 | + { |
|
1056 | + $datetime->setTimezone($timezone); |
|
1057 | + $datetime->getTimestamp(); |
|
1058 | + } |
|
1059 | 1059 | } |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | */ |
132 | 132 | public static function get_timezone_string_from_abbreviations_list($gmt_offset = 0, $coerce = true) |
133 | 133 | { |
134 | - $gmt_offset = (int) $gmt_offset; |
|
134 | + $gmt_offset = (int) $gmt_offset; |
|
135 | 135 | /** @var array[] $abbreviations */ |
136 | 136 | $abbreviations = DateTimeZone::listAbbreviations(); |
137 | 137 | foreach ($abbreviations as $abbreviation) { |
@@ -326,7 +326,7 @@ discard block |
||
326 | 326 | */ |
327 | 327 | protected static function _modify_datetime_object(DateTime $DateTime, $period = 'years', $value = 1, $operand = '+') |
328 | 328 | { |
329 | - if (! $DateTime instanceof DateTime) { |
|
329 | + if ( ! $DateTime instanceof DateTime) { |
|
330 | 330 | throw new EE_Error( |
331 | 331 | sprintf( |
332 | 332 | esc_html__('Expected a PHP DateTime object, but instead received %1$s', 'event_espresso'), |
@@ -336,25 +336,25 @@ discard block |
||
336 | 336 | } |
337 | 337 | switch ($period) { |
338 | 338 | case 'years': |
339 | - $value = 'P' . $value . 'Y'; |
|
339 | + $value = 'P'.$value.'Y'; |
|
340 | 340 | break; |
341 | 341 | case 'months': |
342 | - $value = 'P' . $value . 'M'; |
|
342 | + $value = 'P'.$value.'M'; |
|
343 | 343 | break; |
344 | 344 | case 'weeks': |
345 | - $value = 'P' . $value . 'W'; |
|
345 | + $value = 'P'.$value.'W'; |
|
346 | 346 | break; |
347 | 347 | case 'days': |
348 | - $value = 'P' . $value . 'D'; |
|
348 | + $value = 'P'.$value.'D'; |
|
349 | 349 | break; |
350 | 350 | case 'hours': |
351 | - $value = 'PT' . $value . 'H'; |
|
351 | + $value = 'PT'.$value.'H'; |
|
352 | 352 | break; |
353 | 353 | case 'minutes': |
354 | - $value = 'PT' . $value . 'M'; |
|
354 | + $value = 'PT'.$value.'M'; |
|
355 | 355 | break; |
356 | 356 | case 'seconds': |
357 | - $value = 'PT' . $value . 'S'; |
|
357 | + $value = 'PT'.$value.'S'; |
|
358 | 358 | break; |
359 | 359 | } |
360 | 360 | switch ($operand) { |
@@ -382,7 +382,7 @@ discard block |
||
382 | 382 | */ |
383 | 383 | protected static function _modify_timestamp($timestamp, $period = 'years', $value = 1, $operand = '+') |
384 | 384 | { |
385 | - if (! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) { |
|
385 | + if ( ! preg_match(EE_Datetime_Field::unix_timestamp_regex, $timestamp)) { |
|
386 | 386 | throw new EE_Error( |
387 | 387 | sprintf( |
388 | 388 | esc_html__('Expected a Unix timestamp, but instead received %1$s', 'event_espresso'), |
@@ -495,7 +495,7 @@ discard block |
||
495 | 495 | 'date' => $date_format['js'], |
496 | 496 | 'time' => $time_format['js'], |
497 | 497 | ), |
498 | - 'moment' => $date_format['moment'] . ' ' . $time_format['moment'], |
|
498 | + 'moment' => $date_format['moment'].' '.$time_format['moment'], |
|
499 | 499 | 'moment_split' => array( |
500 | 500 | 'date' => $date_format['moment'], |
501 | 501 | 'time' => $time_format['moment'] |
@@ -518,7 +518,7 @@ discard block |
||
518 | 518 | * |
519 | 519 | * @var array |
520 | 520 | */ |
521 | - $symbols_map = array( |
|
521 | + $symbols_map = array( |
|
522 | 522 | // Day |
523 | 523 | // 01 |
524 | 524 | 'd' => array( |
@@ -670,26 +670,26 @@ discard block |
||
670 | 670 | $escaping = false; |
671 | 671 | $format_string_length = strlen($format_string); |
672 | 672 | for ($i = 0; $i < $format_string_length; $i++) { |
673 | - $char = $format_string[ $i ]; |
|
673 | + $char = $format_string[$i]; |
|
674 | 674 | if ($char === '\\') { // PHP date format escaping character |
675 | 675 | $i++; |
676 | 676 | if ($escaping) { |
677 | - $jquery_ui_format .= $format_string[ $i ]; |
|
678 | - $moment_format .= $format_string[ $i ]; |
|
677 | + $jquery_ui_format .= $format_string[$i]; |
|
678 | + $moment_format .= $format_string[$i]; |
|
679 | 679 | } else { |
680 | - $jquery_ui_format .= '\'' . $format_string[ $i ]; |
|
681 | - $moment_format .= $format_string[ $i ]; |
|
680 | + $jquery_ui_format .= '\''.$format_string[$i]; |
|
681 | + $moment_format .= $format_string[$i]; |
|
682 | 682 | } |
683 | 683 | $escaping = true; |
684 | 684 | } else { |
685 | 685 | if ($escaping) { |
686 | 686 | $jquery_ui_format .= "'"; |
687 | 687 | $moment_format .= "'"; |
688 | - $escaping = false; |
|
688 | + $escaping = false; |
|
689 | 689 | } |
690 | - if (isset($symbols_map[ $char ])) { |
|
691 | - $jquery_ui_format .= $symbols_map[ $char ]['js']; |
|
692 | - $moment_format .= $symbols_map[ $char ]['moment']; |
|
690 | + if (isset($symbols_map[$char])) { |
|
691 | + $jquery_ui_format .= $symbols_map[$char]['js']; |
|
692 | + $moment_format .= $symbols_map[$char]['moment']; |
|
693 | 693 | } else { |
694 | 694 | $jquery_ui_format .= $char; |
695 | 695 | $moment_format .= $char; |
@@ -746,7 +746,7 @@ discard block |
||
746 | 746 | public static function dates_represent_one_24_hour_date($date_1, $date_2) |
747 | 747 | { |
748 | 748 | |
749 | - if ((! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) |
|
749 | + if (( ! $date_1 instanceof DateTime || ! $date_2 instanceof DateTime) |
|
750 | 750 | || ($date_1->format(EE_Datetime_Field::mysql_time_format) !== '00:00:00' |
751 | 751 | || $date_2->format( |
752 | 752 | EE_Datetime_Field::mysql_time_format |
@@ -782,8 +782,8 @@ discard block |
||
782 | 782 | ? $DateTimeZone->getOffset(new DateTime('now')) / HOUR_IN_SECONDS |
783 | 783 | : (float) get_option('gmt_offset'); |
784 | 784 | $query_interval = $offset < 0 |
785 | - ? 'DATE_SUB(' . $field_for_interval . ', INTERVAL ' . $offset * -1 . ' HOUR)' |
|
786 | - : 'DATE_ADD(' . $field_for_interval . ', INTERVAL ' . $offset . ' HOUR)'; |
|
785 | + ? 'DATE_SUB('.$field_for_interval.', INTERVAL '.$offset * -1.' HOUR)' |
|
786 | + : 'DATE_ADD('.$field_for_interval.', INTERVAL '.$offset.' HOUR)'; |
|
787 | 787 | return $query_interval; |
788 | 788 | } |
789 | 789 | |
@@ -800,16 +800,16 @@ discard block |
||
800 | 800 | public static function get_timezone_string_for_display() |
801 | 801 | { |
802 | 802 | $pretty_timezone = apply_filters('FHEE__EEH_DTT_Helper__get_timezone_string_for_display', ''); |
803 | - if (! empty($pretty_timezone)) { |
|
803 | + if ( ! empty($pretty_timezone)) { |
|
804 | 804 | return esc_html($pretty_timezone); |
805 | 805 | } |
806 | 806 | $timezone_string = get_option('timezone_string'); |
807 | 807 | if ($timezone_string) { |
808 | 808 | static $mo_loaded = false; |
809 | 809 | // Load translations for continents and cities just like wp_timezone_choice does |
810 | - if (! $mo_loaded) { |
|
810 | + if ( ! $mo_loaded) { |
|
811 | 811 | $locale = get_locale(); |
812 | - $mofile = WP_LANG_DIR . '/continents-cities-' . $locale . '.mo'; |
|
812 | + $mofile = WP_LANG_DIR.'/continents-cities-'.$locale.'.mo'; |
|
813 | 813 | load_textdomain('continents-cities', $mofile); |
814 | 814 | $mo_loaded = true; |
815 | 815 | } |
@@ -836,10 +836,10 @@ discard block |
||
836 | 836 | } else { |
837 | 837 | // convert the part after the decimal, eg "5" (from x.5) or "25" (from x.25) |
838 | 838 | // to minutes, eg 30 or 15, respectively |
839 | - $hour_fraction = (float) ('0.' . $parts[1]); |
|
839 | + $hour_fraction = (float) ('0.'.$parts[1]); |
|
840 | 840 | $parts[1] = (string) $hour_fraction * 60; |
841 | 841 | } |
842 | - return sprintf(__('UTC%1$s', 'event_espresso'), $prefix . implode(':', $parts)); |
|
842 | + return sprintf(__('UTC%1$s', 'event_espresso'), $prefix.implode(':', $parts)); |
|
843 | 843 | } |
844 | 844 | |
845 | 845 | |
@@ -922,9 +922,9 @@ discard block |
||
922 | 922 | 'Pacific', |
923 | 923 | ); |
924 | 924 | // Load translations for continents and cities. |
925 | - if (! $mo_loaded || $locale !== $locale_loaded) { |
|
925 | + if ( ! $mo_loaded || $locale !== $locale_loaded) { |
|
926 | 926 | $locale_loaded = $locale ? $locale : get_locale(); |
927 | - $mofile = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo'; |
|
927 | + $mofile = WP_LANG_DIR.'/continents-cities-'.$locale_loaded.'.mo'; |
|
928 | 928 | unload_textdomain('continents-cities'); |
929 | 929 | load_textdomain('continents-cities', $mofile); |
930 | 930 | $mo_loaded = true; |
@@ -932,11 +932,11 @@ discard block |
||
932 | 932 | $zone_data = array(); |
933 | 933 | foreach (timezone_identifiers_list() as $zone) { |
934 | 934 | $zone = explode('/', $zone); |
935 | - if (! in_array($zone[0], $continents, true)) { |
|
935 | + if ( ! in_array($zone[0], $continents, true)) { |
|
936 | 936 | continue; |
937 | 937 | } |
938 | 938 | // This determines what gets set and translated - we don't translate Etc/* strings here, they are done later |
939 | - $exists = array( |
|
939 | + $exists = array( |
|
940 | 940 | 0 => isset($zone[0]) && $zone[0], |
941 | 941 | 1 => isset($zone[1]) && $zone[1], |
942 | 942 | 2 => isset($zone[2]) && $zone[2], |
@@ -966,7 +966,7 @@ discard block |
||
966 | 966 | usort($zone_data, '_wp_timezone_choice_usort_callback'); |
967 | 967 | $structure = array(); |
968 | 968 | if (empty($selected_zone)) { |
969 | - $structure[] = '<option selected="selected" value="">' . __('Select a city', 'event_espresso') . '</option>'; |
|
969 | + $structure[] = '<option selected="selected" value="">'.__('Select a city', 'event_espresso').'</option>'; |
|
970 | 970 | } |
971 | 971 | foreach ($zone_data as $key => $zone) { |
972 | 972 | // Build value in an array to join later |
@@ -977,30 +977,30 @@ discard block |
||
977 | 977 | } else { |
978 | 978 | // It's inside a continent group |
979 | 979 | // Continent optgroup |
980 | - if (! isset($zone_data[ $key - 1 ]) || $zone_data[ $key - 1 ]['continent'] !== $zone['continent']) { |
|
980 | + if ( ! isset($zone_data[$key - 1]) || $zone_data[$key - 1]['continent'] !== $zone['continent']) { |
|
981 | 981 | $label = $zone['t_continent']; |
982 | - $structure[] = '<optgroup label="' . esc_attr($label) . '">'; |
|
982 | + $structure[] = '<optgroup label="'.esc_attr($label).'">'; |
|
983 | 983 | } |
984 | 984 | // Add the city to the value |
985 | 985 | $value[] = $zone['city']; |
986 | 986 | $display = $zone['t_city']; |
987 | - if (! empty($zone['subcity'])) { |
|
987 | + if ( ! empty($zone['subcity'])) { |
|
988 | 988 | // Add the subcity to the value |
989 | 989 | $value[] = $zone['subcity']; |
990 | - $display .= ' - ' . $zone['t_subcity']; |
|
990 | + $display .= ' - '.$zone['t_subcity']; |
|
991 | 991 | } |
992 | 992 | } |
993 | 993 | // Build the value |
994 | 994 | $value = implode('/', $value); |
995 | 995 | $selected = $value === $selected_zone ? ' selected="selected"' : ''; |
996 | - $structure[] = '<option value="' . esc_attr($value) . '"' . $selected . '>' |
|
996 | + $structure[] = '<option value="'.esc_attr($value).'"'.$selected.'>' |
|
997 | 997 | . esc_html($display) |
998 | 998 | . '</option>'; |
999 | 999 | // Close continent optgroup |
1000 | - if (! empty($zone['city']) |
|
1000 | + if ( ! empty($zone['city']) |
|
1001 | 1001 | && ( |
1002 | - ! isset($zone_data[ $key + 1 ]) |
|
1003 | - || (isset($zone_data[ $key + 1 ]) && $zone_data[ $key + 1 ]['continent'] !== $zone['continent']) |
|
1002 | + ! isset($zone_data[$key + 1]) |
|
1003 | + || (isset($zone_data[$key + 1]) && $zone_data[$key + 1]['continent'] !== $zone['continent']) |
|
1004 | 1004 | ) |
1005 | 1005 | ) { |
1006 | 1006 | $structure[] = '</optgroup>'; |
@@ -27,1275 +27,1275 @@ |
||
27 | 27 | final class EE_System implements ResettableInterface |
28 | 28 | { |
29 | 29 | |
30 | - /** |
|
31 | - * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
32 | - * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
33 | - */ |
|
34 | - const req_type_normal = 0; |
|
35 | - |
|
36 | - /** |
|
37 | - * Indicates this is a brand new installation of EE so we should install |
|
38 | - * tables and default data etc |
|
39 | - */ |
|
40 | - const req_type_new_activation = 1; |
|
41 | - |
|
42 | - /** |
|
43 | - * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
44 | - * and we just exited maintenance mode). We MUST check the database is setup properly |
|
45 | - * and that default data is setup too |
|
46 | - */ |
|
47 | - const req_type_reactivation = 2; |
|
48 | - |
|
49 | - /** |
|
50 | - * indicates that EE has been upgraded since its previous request. |
|
51 | - * We may have data migration scripts to call and will want to trigger maintenance mode |
|
52 | - */ |
|
53 | - const req_type_upgrade = 3; |
|
54 | - |
|
55 | - /** |
|
56 | - * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
57 | - */ |
|
58 | - const req_type_downgrade = 4; |
|
59 | - |
|
60 | - /** |
|
61 | - * @deprecated since version 4.6.0.dev.006 |
|
62 | - * Now whenever a new_activation is detected the request type is still just |
|
63 | - * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
64 | - * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
65 | - * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
66 | - * (Specifically, when the migration manager indicates migrations are finished |
|
67 | - * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
68 | - */ |
|
69 | - const req_type_activation_but_not_installed = 5; |
|
70 | - |
|
71 | - /** |
|
72 | - * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
73 | - */ |
|
74 | - const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
75 | - |
|
76 | - /** |
|
77 | - * @var EE_System $_instance |
|
78 | - */ |
|
79 | - private static $_instance; |
|
80 | - |
|
81 | - /** |
|
82 | - * @var EE_Registry $registry |
|
83 | - */ |
|
84 | - private $registry; |
|
85 | - |
|
86 | - /** |
|
87 | - * @var LoaderInterface $loader |
|
88 | - */ |
|
89 | - private $loader; |
|
90 | - |
|
91 | - /** |
|
92 | - * @var EE_Capabilities $capabilities |
|
93 | - */ |
|
94 | - private $capabilities; |
|
95 | - |
|
96 | - /** |
|
97 | - * @var RequestInterface $request |
|
98 | - */ |
|
99 | - private $request; |
|
100 | - |
|
101 | - /** |
|
102 | - * @var EE_Maintenance_Mode $maintenance_mode |
|
103 | - */ |
|
104 | - private $maintenance_mode; |
|
105 | - |
|
106 | - /** |
|
107 | - * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
108 | - * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
109 | - * |
|
110 | - * @var int $_req_type |
|
111 | - */ |
|
112 | - private $_req_type; |
|
113 | - |
|
114 | - /** |
|
115 | - * Whether or not there was a non-micro version change in EE core version during this request |
|
116 | - * |
|
117 | - * @var boolean $_major_version_change |
|
118 | - */ |
|
119 | - private $_major_version_change = false; |
|
120 | - |
|
121 | - /** |
|
122 | - * A Context DTO dedicated solely to identifying the current request type. |
|
123 | - * |
|
124 | - * @var RequestTypeContextCheckerInterface $request_type |
|
125 | - */ |
|
126 | - private $request_type; |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * @singleton method used to instantiate class object |
|
131 | - * @param EE_Registry|null $registry |
|
132 | - * @param LoaderInterface|null $loader |
|
133 | - * @param RequestInterface|null $request |
|
134 | - * @param EE_Maintenance_Mode|null $maintenance_mode |
|
135 | - * @return EE_System |
|
136 | - */ |
|
137 | - public static function instance( |
|
138 | - EE_Registry $registry = null, |
|
139 | - LoaderInterface $loader = null, |
|
140 | - RequestInterface $request = null, |
|
141 | - EE_Maintenance_Mode $maintenance_mode = null |
|
142 | - ) { |
|
143 | - // check if class object is instantiated |
|
144 | - if (! self::$_instance instanceof EE_System) { |
|
145 | - self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
146 | - } |
|
147 | - return self::$_instance; |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * resets the instance and returns it |
|
153 | - * |
|
154 | - * @return EE_System |
|
155 | - */ |
|
156 | - public static function reset() |
|
157 | - { |
|
158 | - self::$_instance->_req_type = null; |
|
159 | - // make sure none of the old hooks are left hanging around |
|
160 | - remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
161 | - // we need to reset the migration manager in order for it to detect DMSs properly |
|
162 | - EE_Data_Migration_Manager::reset(); |
|
163 | - self::instance()->detect_activations_or_upgrades(); |
|
164 | - self::instance()->perform_activations_upgrades_and_migrations(); |
|
165 | - return self::instance(); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * sets hooks for running rest of system |
|
171 | - * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
172 | - * starting EE Addons from any other point may lead to problems |
|
173 | - * |
|
174 | - * @param EE_Registry $registry |
|
175 | - * @param LoaderInterface $loader |
|
176 | - * @param RequestInterface $request |
|
177 | - * @param EE_Maintenance_Mode $maintenance_mode |
|
178 | - */ |
|
179 | - private function __construct( |
|
180 | - EE_Registry $registry, |
|
181 | - LoaderInterface $loader, |
|
182 | - RequestInterface $request, |
|
183 | - EE_Maintenance_Mode $maintenance_mode |
|
184 | - ) { |
|
185 | - $this->registry = $registry; |
|
186 | - $this->loader = $loader; |
|
187 | - $this->request = $request; |
|
188 | - $this->maintenance_mode = $maintenance_mode; |
|
189 | - do_action('AHEE__EE_System__construct__begin', $this); |
|
190 | - add_action( |
|
191 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
192 | - array($this, 'loadCapabilities'), |
|
193 | - 5 |
|
194 | - ); |
|
195 | - add_action( |
|
196 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
197 | - array($this, 'loadCommandBus'), |
|
198 | - 7 |
|
199 | - ); |
|
200 | - add_action( |
|
201 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
202 | - array($this, 'loadPluginApi'), |
|
203 | - 9 |
|
204 | - ); |
|
205 | - // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
206 | - add_action( |
|
207 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
208 | - array($this, 'load_espresso_addons') |
|
209 | - ); |
|
210 | - // when an ee addon is activated, we want to call the core hook(s) again |
|
211 | - // because the newly-activated addon didn't get a chance to run at all |
|
212 | - add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
213 | - // detect whether install or upgrade |
|
214 | - add_action( |
|
215 | - 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
216 | - array($this, 'detect_activations_or_upgrades'), |
|
217 | - 3 |
|
218 | - ); |
|
219 | - // load EE_Config, EE_Textdomain, etc |
|
220 | - add_action( |
|
221 | - 'AHEE__EE_Bootstrap__load_core_configuration', |
|
222 | - array($this, 'load_core_configuration'), |
|
223 | - 5 |
|
224 | - ); |
|
225 | - // load EE_Config, EE_Textdomain, etc |
|
226 | - add_action( |
|
227 | - 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
228 | - array($this, 'register_shortcodes_modules_and_widgets'), |
|
229 | - 7 |
|
230 | - ); |
|
231 | - // you wanna get going? I wanna get going... let's get going! |
|
232 | - add_action( |
|
233 | - 'AHEE__EE_Bootstrap__brew_espresso', |
|
234 | - array($this, 'brew_espresso'), |
|
235 | - 9 |
|
236 | - ); |
|
237 | - // other housekeeping |
|
238 | - // exclude EE critical pages from wp_list_pages |
|
239 | - add_filter( |
|
240 | - 'wp_list_pages_excludes', |
|
241 | - array($this, 'remove_pages_from_wp_list_pages'), |
|
242 | - 10 |
|
243 | - ); |
|
244 | - // ALL EE Addons should use the following hook point to attach their initial setup too |
|
245 | - // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
246 | - do_action('AHEE__EE_System__construct__complete', $this); |
|
247 | - } |
|
248 | - |
|
249 | - |
|
250 | - /** |
|
251 | - * load and setup EE_Capabilities |
|
252 | - * |
|
253 | - * @return void |
|
254 | - * @throws EE_Error |
|
255 | - */ |
|
256 | - public function loadCapabilities() |
|
257 | - { |
|
258 | - $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
259 | - add_action( |
|
260 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
261 | - function () { |
|
262 | - LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
263 | - } |
|
264 | - ); |
|
265 | - } |
|
266 | - |
|
267 | - |
|
268 | - /** |
|
269 | - * create and cache the CommandBus, and also add middleware |
|
270 | - * The CapChecker middleware requires the use of EE_Capabilities |
|
271 | - * which is why we need to load the CommandBus after Caps are set up |
|
272 | - * |
|
273 | - * @return void |
|
274 | - * @throws EE_Error |
|
275 | - */ |
|
276 | - public function loadCommandBus() |
|
277 | - { |
|
278 | - $this->loader->getShared( |
|
279 | - 'CommandBusInterface', |
|
280 | - array( |
|
281 | - null, |
|
282 | - apply_filters( |
|
283 | - 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
284 | - array( |
|
285 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
286 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
287 | - ) |
|
288 | - ), |
|
289 | - ) |
|
290 | - ); |
|
291 | - } |
|
292 | - |
|
293 | - |
|
294 | - /** |
|
295 | - * @return void |
|
296 | - * @throws EE_Error |
|
297 | - */ |
|
298 | - public function loadPluginApi() |
|
299 | - { |
|
300 | - // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
301 | - // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
302 | - EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
303 | - $this->loader->getShared('EE_Request_Handler'); |
|
304 | - } |
|
305 | - |
|
306 | - |
|
307 | - /** |
|
308 | - * @param string $addon_name |
|
309 | - * @param string $version_constant |
|
310 | - * @param string $min_version_required |
|
311 | - * @param string $load_callback |
|
312 | - * @param string $plugin_file_constant |
|
313 | - * @return void |
|
314 | - */ |
|
315 | - private function deactivateIncompatibleAddon( |
|
316 | - $addon_name, |
|
317 | - $version_constant, |
|
318 | - $min_version_required, |
|
319 | - $load_callback, |
|
320 | - $plugin_file_constant |
|
321 | - ) { |
|
322 | - if (! defined($version_constant)) { |
|
323 | - return; |
|
324 | - } |
|
325 | - $addon_version = constant($version_constant); |
|
326 | - if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
327 | - remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
328 | - if (! function_exists('deactivate_plugins')) { |
|
329 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
330 | - } |
|
331 | - deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
332 | - unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
333 | - EE_Error::add_error( |
|
334 | - sprintf( |
|
335 | - esc_html__( |
|
336 | - 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
337 | - 'event_espresso' |
|
338 | - ), |
|
339 | - $addon_name, |
|
340 | - $min_version_required |
|
341 | - ), |
|
342 | - __FILE__, |
|
343 | - __FUNCTION__ . "({$addon_name})", |
|
344 | - __LINE__ |
|
345 | - ); |
|
346 | - EE_Error::get_notices(false, true); |
|
347 | - } |
|
348 | - } |
|
349 | - |
|
350 | - |
|
351 | - /** |
|
352 | - * load_espresso_addons |
|
353 | - * allow addons to load first so that they can set hooks for running DMS's, etc |
|
354 | - * this is hooked into both: |
|
355 | - * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
356 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
357 | - * and the WP 'activate_plugin' hook point |
|
358 | - * |
|
359 | - * @access public |
|
360 | - * @return void |
|
361 | - */ |
|
362 | - public function load_espresso_addons() |
|
363 | - { |
|
364 | - $this->deactivateIncompatibleAddon( |
|
365 | - 'Wait Lists', |
|
366 | - 'EE_WAIT_LISTS_VERSION', |
|
367 | - '1.0.0.beta.074', |
|
368 | - 'load_espresso_wait_lists', |
|
369 | - 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
370 | - ); |
|
371 | - $this->deactivateIncompatibleAddon( |
|
372 | - 'Automated Upcoming Event Notifications', |
|
373 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
374 | - '1.0.0.beta.091', |
|
375 | - 'load_espresso_automated_upcoming_event_notification', |
|
376 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
377 | - ); |
|
378 | - do_action('AHEE__EE_System__load_espresso_addons'); |
|
379 | - // if the WP API basic auth plugin isn't already loaded, load it now. |
|
380 | - // We want it for mobile apps. Just include the entire plugin |
|
381 | - // also, don't load the basic auth when a plugin is getting activated, because |
|
382 | - // it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
383 | - // and causes a fatal error |
|
384 | - if ($this->request->getRequestParam('activate') !== 'true' |
|
385 | - && ! function_exists('json_basic_auth_handler') |
|
386 | - && ! function_exists('json_basic_auth_error') |
|
387 | - && ! in_array( |
|
388 | - $this->request->getRequestParam('action'), |
|
389 | - array('activate', 'activate-selected'), |
|
390 | - true |
|
391 | - ) |
|
392 | - ) { |
|
393 | - include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
394 | - } |
|
395 | - do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
396 | - } |
|
397 | - |
|
398 | - |
|
399 | - /** |
|
400 | - * detect_activations_or_upgrades |
|
401 | - * Checks for activation or upgrade of core first; |
|
402 | - * then also checks if any registered addons have been activated or upgraded |
|
403 | - * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
404 | - * which runs during the WP 'plugins_loaded' action at priority 3 |
|
405 | - * |
|
406 | - * @access public |
|
407 | - * @return void |
|
408 | - */ |
|
409 | - public function detect_activations_or_upgrades() |
|
410 | - { |
|
411 | - // first off: let's make sure to handle core |
|
412 | - $this->detect_if_activation_or_upgrade(); |
|
413 | - foreach ($this->registry->addons as $addon) { |
|
414 | - if ($addon instanceof EE_Addon) { |
|
415 | - // detect teh request type for that addon |
|
416 | - $addon->detect_activation_or_upgrade(); |
|
417 | - } |
|
418 | - } |
|
419 | - } |
|
420 | - |
|
421 | - |
|
422 | - /** |
|
423 | - * detect_if_activation_or_upgrade |
|
424 | - * Takes care of detecting whether this is a brand new install or code upgrade, |
|
425 | - * and either setting up the DB or setting up maintenance mode etc. |
|
426 | - * |
|
427 | - * @access public |
|
428 | - * @return void |
|
429 | - */ |
|
430 | - public function detect_if_activation_or_upgrade() |
|
431 | - { |
|
432 | - do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
433 | - // check if db has been updated, or if its a brand-new installation |
|
434 | - $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
435 | - $request_type = $this->detect_req_type($espresso_db_update); |
|
436 | - // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
437 | - switch ($request_type) { |
|
438 | - case EE_System::req_type_new_activation: |
|
439 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
440 | - $this->_handle_core_version_change($espresso_db_update); |
|
441 | - break; |
|
442 | - case EE_System::req_type_reactivation: |
|
443 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
444 | - $this->_handle_core_version_change($espresso_db_update); |
|
445 | - break; |
|
446 | - case EE_System::req_type_upgrade: |
|
447 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
448 | - // migrations may be required now that we've upgraded |
|
449 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
450 | - $this->_handle_core_version_change($espresso_db_update); |
|
451 | - break; |
|
452 | - case EE_System::req_type_downgrade: |
|
453 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
454 | - // its possible migrations are no longer required |
|
455 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
456 | - $this->_handle_core_version_change($espresso_db_update); |
|
457 | - break; |
|
458 | - case EE_System::req_type_normal: |
|
459 | - default: |
|
460 | - break; |
|
461 | - } |
|
462 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
463 | - } |
|
464 | - |
|
465 | - |
|
466 | - /** |
|
467 | - * Updates the list of installed versions and sets hooks for |
|
468 | - * initializing the database later during the request |
|
469 | - * |
|
470 | - * @param array $espresso_db_update |
|
471 | - */ |
|
472 | - private function _handle_core_version_change($espresso_db_update) |
|
473 | - { |
|
474 | - $this->update_list_of_installed_versions($espresso_db_update); |
|
475 | - // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
476 | - add_action( |
|
477 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
478 | - array($this, 'initialize_db_if_no_migrations_required') |
|
479 | - ); |
|
480 | - } |
|
481 | - |
|
482 | - |
|
483 | - /** |
|
484 | - * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
485 | - * information about what versions of EE have been installed and activated, |
|
486 | - * NOT necessarily the state of the database |
|
487 | - * |
|
488 | - * @param mixed $espresso_db_update the value of the WordPress option. |
|
489 | - * If not supplied, fetches it from the options table |
|
490 | - * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
491 | - */ |
|
492 | - private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
493 | - { |
|
494 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
495 | - if (! $espresso_db_update) { |
|
496 | - $espresso_db_update = get_option('espresso_db_update'); |
|
497 | - } |
|
498 | - // check that option is an array |
|
499 | - if (! is_array($espresso_db_update)) { |
|
500 | - // if option is FALSE, then it never existed |
|
501 | - if ($espresso_db_update === false) { |
|
502 | - // make $espresso_db_update an array and save option with autoload OFF |
|
503 | - $espresso_db_update = array(); |
|
504 | - add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
505 | - } else { |
|
506 | - // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
507 | - $espresso_db_update = array($espresso_db_update => array()); |
|
508 | - update_option('espresso_db_update', $espresso_db_update); |
|
509 | - } |
|
510 | - } else { |
|
511 | - $corrected_db_update = array(); |
|
512 | - // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
513 | - foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
514 | - if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
515 | - // the key is an int, and the value IS NOT an array |
|
516 | - // so it must be numerically-indexed, where values are versions installed... |
|
517 | - // fix it! |
|
518 | - $version_string = $should_be_array; |
|
519 | - $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
520 | - } else { |
|
521 | - // ok it checks out |
|
522 | - $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
523 | - } |
|
524 | - } |
|
525 | - $espresso_db_update = $corrected_db_update; |
|
526 | - update_option('espresso_db_update', $espresso_db_update); |
|
527 | - } |
|
528 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
529 | - return $espresso_db_update; |
|
530 | - } |
|
531 | - |
|
532 | - |
|
533 | - /** |
|
534 | - * Does the traditional work of setting up the plugin's database and adding default data. |
|
535 | - * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
536 | - * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
537 | - * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
538 | - * so that it will be done when migrations are finished |
|
539 | - * |
|
540 | - * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
541 | - * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
542 | - * This is a resource-intensive job |
|
543 | - * so we prefer to only do it when necessary |
|
544 | - * @return void |
|
545 | - * @throws EE_Error |
|
546 | - */ |
|
547 | - public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
548 | - { |
|
549 | - $request_type = $this->detect_req_type(); |
|
550 | - // only initialize system if we're not in maintenance mode. |
|
551 | - if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
552 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
553 | - $rewrite_rules = $this->loader->getShared( |
|
554 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
555 | - ); |
|
556 | - $rewrite_rules->flush(); |
|
557 | - if ($verify_schema) { |
|
558 | - EEH_Activation::initialize_db_and_folders(); |
|
559 | - } |
|
560 | - EEH_Activation::initialize_db_content(); |
|
561 | - EEH_Activation::system_initialization(); |
|
562 | - if ($initialize_addons_too) { |
|
563 | - $this->initialize_addons(); |
|
564 | - } |
|
565 | - } else { |
|
566 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
567 | - } |
|
568 | - if ($request_type === EE_System::req_type_new_activation |
|
569 | - || $request_type === EE_System::req_type_reactivation |
|
570 | - || ( |
|
571 | - $request_type === EE_System::req_type_upgrade |
|
572 | - && $this->is_major_version_change() |
|
573 | - ) |
|
574 | - ) { |
|
575 | - add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
576 | - } |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - /** |
|
581 | - * Initializes the db for all registered addons |
|
582 | - * |
|
583 | - * @throws EE_Error |
|
584 | - */ |
|
585 | - public function initialize_addons() |
|
586 | - { |
|
587 | - // foreach registered addon, make sure its db is up-to-date too |
|
588 | - foreach ($this->registry->addons as $addon) { |
|
589 | - if ($addon instanceof EE_Addon) { |
|
590 | - $addon->initialize_db_if_no_migrations_required(); |
|
591 | - } |
|
592 | - } |
|
593 | - } |
|
594 | - |
|
595 | - |
|
596 | - /** |
|
597 | - * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
598 | - * |
|
599 | - * @param array $version_history |
|
600 | - * @param string $current_version_to_add version to be added to the version history |
|
601 | - * @return boolean success as to whether or not this option was changed |
|
602 | - */ |
|
603 | - public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
604 | - { |
|
605 | - if (! $version_history) { |
|
606 | - $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
607 | - } |
|
608 | - if ($current_version_to_add === null) { |
|
609 | - $current_version_to_add = espresso_version(); |
|
610 | - } |
|
611 | - $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
612 | - // re-save |
|
613 | - return update_option('espresso_db_update', $version_history); |
|
614 | - } |
|
615 | - |
|
616 | - |
|
617 | - /** |
|
618 | - * Detects if the current version indicated in the has existed in the list of |
|
619 | - * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
620 | - * |
|
621 | - * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
622 | - * If not supplied, fetches it from the options table. |
|
623 | - * Also, caches its result so later parts of the code can also know whether |
|
624 | - * there's been an update or not. This way we can add the current version to |
|
625 | - * espresso_db_update, but still know if this is a new install or not |
|
626 | - * @return int one of the constants on EE_System::req_type_ |
|
627 | - */ |
|
628 | - public function detect_req_type($espresso_db_update = null) |
|
629 | - { |
|
630 | - if ($this->_req_type === null) { |
|
631 | - $espresso_db_update = ! empty($espresso_db_update) |
|
632 | - ? $espresso_db_update |
|
633 | - : $this->fix_espresso_db_upgrade_option(); |
|
634 | - $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
635 | - $espresso_db_update, |
|
636 | - 'ee_espresso_activation', |
|
637 | - espresso_version() |
|
638 | - ); |
|
639 | - $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
640 | - $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
641 | - } |
|
642 | - return $this->_req_type; |
|
643 | - } |
|
644 | - |
|
645 | - |
|
646 | - /** |
|
647 | - * Returns whether or not there was a non-micro version change (ie, change in either |
|
648 | - * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
649 | - * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
650 | - * |
|
651 | - * @param $activation_history |
|
652 | - * @return bool |
|
653 | - */ |
|
654 | - private function _detect_major_version_change($activation_history) |
|
655 | - { |
|
656 | - $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
657 | - $previous_version_parts = explode('.', $previous_version); |
|
658 | - $current_version_parts = explode('.', espresso_version()); |
|
659 | - return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
660 | - && ($previous_version_parts[0] !== $current_version_parts[0] |
|
661 | - || $previous_version_parts[1] !== $current_version_parts[1] |
|
662 | - ); |
|
663 | - } |
|
664 | - |
|
665 | - |
|
666 | - /** |
|
667 | - * Returns true if either the major or minor version of EE changed during this request. |
|
668 | - * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
669 | - * |
|
670 | - * @return bool |
|
671 | - */ |
|
672 | - public function is_major_version_change() |
|
673 | - { |
|
674 | - return $this->_major_version_change; |
|
675 | - } |
|
676 | - |
|
677 | - |
|
678 | - /** |
|
679 | - * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
680 | - * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
681 | - * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
682 | - * just activated to (for core that will always be espresso_version()) |
|
683 | - * |
|
684 | - * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
685 | - * ee plugin. for core that's 'espresso_db_update' |
|
686 | - * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
687 | - * indicate that this plugin was just activated |
|
688 | - * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
689 | - * espresso_version()) |
|
690 | - * @return int one of the constants on EE_System::req_type_* |
|
691 | - */ |
|
692 | - public static function detect_req_type_given_activation_history( |
|
693 | - $activation_history_for_addon, |
|
694 | - $activation_indicator_option_name, |
|
695 | - $version_to_upgrade_to |
|
696 | - ) { |
|
697 | - $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
698 | - if ($activation_history_for_addon) { |
|
699 | - // it exists, so this isn't a completely new install |
|
700 | - // check if this version already in that list of previously installed versions |
|
701 | - if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
702 | - // it a version we haven't seen before |
|
703 | - if ($version_is_higher === 1) { |
|
704 | - $req_type = EE_System::req_type_upgrade; |
|
705 | - } else { |
|
706 | - $req_type = EE_System::req_type_downgrade; |
|
707 | - } |
|
708 | - delete_option($activation_indicator_option_name); |
|
709 | - } else { |
|
710 | - // its not an update. maybe a reactivation? |
|
711 | - if (get_option($activation_indicator_option_name, false)) { |
|
712 | - if ($version_is_higher === -1) { |
|
713 | - $req_type = EE_System::req_type_downgrade; |
|
714 | - } elseif ($version_is_higher === 0) { |
|
715 | - // we've seen this version before, but it's an activation. must be a reactivation |
|
716 | - $req_type = EE_System::req_type_reactivation; |
|
717 | - } else {// $version_is_higher === 1 |
|
718 | - $req_type = EE_System::req_type_upgrade; |
|
719 | - } |
|
720 | - delete_option($activation_indicator_option_name); |
|
721 | - } else { |
|
722 | - // we've seen this version before and the activation indicate doesn't show it was just activated |
|
723 | - if ($version_is_higher === -1) { |
|
724 | - $req_type = EE_System::req_type_downgrade; |
|
725 | - } elseif ($version_is_higher === 0) { |
|
726 | - // we've seen this version before and it's not an activation. its normal request |
|
727 | - $req_type = EE_System::req_type_normal; |
|
728 | - } else {// $version_is_higher === 1 |
|
729 | - $req_type = EE_System::req_type_upgrade; |
|
730 | - } |
|
731 | - } |
|
732 | - } |
|
733 | - } else { |
|
734 | - // brand new install |
|
735 | - $req_type = EE_System::req_type_new_activation; |
|
736 | - delete_option($activation_indicator_option_name); |
|
737 | - } |
|
738 | - return $req_type; |
|
739 | - } |
|
740 | - |
|
741 | - |
|
742 | - /** |
|
743 | - * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
744 | - * the $activation_history_for_addon |
|
745 | - * |
|
746 | - * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
747 | - * sometimes containing 'unknown-date' |
|
748 | - * @param string $version_to_upgrade_to (current version) |
|
749 | - * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
750 | - * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
751 | - * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
752 | - * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
753 | - */ |
|
754 | - private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
755 | - { |
|
756 | - // find the most recently-activated version |
|
757 | - $most_recently_active_version = |
|
758 | - EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
759 | - return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
760 | - } |
|
761 | - |
|
762 | - |
|
763 | - /** |
|
764 | - * Gets the most recently active version listed in the activation history, |
|
765 | - * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
766 | - * |
|
767 | - * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
768 | - * sometimes containing 'unknown-date' |
|
769 | - * @return string |
|
770 | - */ |
|
771 | - private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
772 | - { |
|
773 | - $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
774 | - $most_recently_active_version = '0.0.0.dev.000'; |
|
775 | - if (is_array($activation_history)) { |
|
776 | - foreach ($activation_history as $version => $times_activated) { |
|
777 | - // check there is a record of when this version was activated. Otherwise, |
|
778 | - // mark it as unknown |
|
779 | - if (! $times_activated) { |
|
780 | - $times_activated = array('unknown-date'); |
|
781 | - } |
|
782 | - if (is_string($times_activated)) { |
|
783 | - $times_activated = array($times_activated); |
|
784 | - } |
|
785 | - foreach ($times_activated as $an_activation) { |
|
786 | - if ($an_activation !== 'unknown-date' |
|
787 | - && $an_activation |
|
788 | - > $most_recently_active_version_activation) { |
|
789 | - $most_recently_active_version = $version; |
|
790 | - $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
791 | - ? '1970-01-01 00:00:00' |
|
792 | - : $an_activation; |
|
793 | - } |
|
794 | - } |
|
795 | - } |
|
796 | - } |
|
797 | - return $most_recently_active_version; |
|
798 | - } |
|
799 | - |
|
800 | - |
|
801 | - /** |
|
802 | - * This redirects to the about EE page after activation |
|
803 | - * |
|
804 | - * @return void |
|
805 | - */ |
|
806 | - public function redirect_to_about_ee() |
|
807 | - { |
|
808 | - $notices = EE_Error::get_notices(false); |
|
809 | - // if current user is an admin and it's not an ajax or rest request |
|
810 | - if (! isset($notices['errors']) |
|
811 | - && $this->request->isAdmin() |
|
812 | - && apply_filters( |
|
813 | - 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
814 | - $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
815 | - ) |
|
816 | - ) { |
|
817 | - $query_params = array('page' => 'espresso_about'); |
|
818 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
819 | - $query_params['new_activation'] = true; |
|
820 | - } |
|
821 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
822 | - $query_params['reactivation'] = true; |
|
823 | - } |
|
824 | - $url = add_query_arg($query_params, admin_url('admin.php')); |
|
825 | - wp_safe_redirect($url); |
|
826 | - exit(); |
|
827 | - } |
|
828 | - } |
|
829 | - |
|
830 | - |
|
831 | - /** |
|
832 | - * load_core_configuration |
|
833 | - * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
834 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
835 | - * |
|
836 | - * @return void |
|
837 | - * @throws ReflectionException |
|
838 | - */ |
|
839 | - public function load_core_configuration() |
|
840 | - { |
|
841 | - do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
842 | - $this->loader->getShared('EE_Load_Textdomain'); |
|
843 | - // load textdomain |
|
844 | - EE_Load_Textdomain::load_textdomain(); |
|
845 | - // load and setup EE_Config and EE_Network_Config |
|
846 | - $config = $this->loader->getShared('EE_Config'); |
|
847 | - $this->loader->getShared('EE_Network_Config'); |
|
848 | - // setup autoloaders |
|
849 | - // enable logging? |
|
850 | - if ($config->admin->use_full_logging) { |
|
851 | - $this->loader->getShared('EE_Log'); |
|
852 | - } |
|
853 | - // check for activation errors |
|
854 | - $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
855 | - if ($activation_errors) { |
|
856 | - EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
857 | - update_option('ee_plugin_activation_errors', false); |
|
858 | - } |
|
859 | - // get model names |
|
860 | - $this->_parse_model_names(); |
|
861 | - // load caf stuff a chance to play during the activation process too. |
|
862 | - $this->_maybe_brew_regular(); |
|
863 | - // configure custom post type definitions |
|
864 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
865 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
866 | - do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
867 | - } |
|
868 | - |
|
869 | - |
|
870 | - /** |
|
871 | - * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
872 | - * |
|
873 | - * @return void |
|
874 | - * @throws ReflectionException |
|
875 | - */ |
|
876 | - private function _parse_model_names() |
|
877 | - { |
|
878 | - // get all the files in the EE_MODELS folder that end in .model.php |
|
879 | - $models = glob(EE_MODELS . '*.model.php'); |
|
880 | - $model_names = array(); |
|
881 | - $non_abstract_db_models = array(); |
|
882 | - foreach ($models as $model) { |
|
883 | - // get model classname |
|
884 | - $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
885 | - $short_name = str_replace('EEM_', '', $classname); |
|
886 | - $reflectionClass = new ReflectionClass($classname); |
|
887 | - if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
888 | - $non_abstract_db_models[ $short_name ] = $classname; |
|
889 | - } |
|
890 | - $model_names[ $short_name ] = $classname; |
|
891 | - } |
|
892 | - $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
893 | - $this->registry->non_abstract_db_models = apply_filters( |
|
894 | - 'FHEE__EE_System__parse_implemented_model_names', |
|
895 | - $non_abstract_db_models |
|
896 | - ); |
|
897 | - } |
|
898 | - |
|
899 | - |
|
900 | - /** |
|
901 | - * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
902 | - * that need to be setup before our EE_System launches. |
|
903 | - * |
|
904 | - * @return void |
|
905 | - * @throws DomainException |
|
906 | - * @throws InvalidArgumentException |
|
907 | - * @throws InvalidDataTypeException |
|
908 | - * @throws InvalidInterfaceException |
|
909 | - * @throws InvalidClassException |
|
910 | - * @throws InvalidFilePathException |
|
911 | - */ |
|
912 | - private function _maybe_brew_regular() |
|
913 | - { |
|
914 | - /** @var Domain $domain */ |
|
915 | - $domain = DomainFactory::getShared( |
|
916 | - new FullyQualifiedName( |
|
917 | - 'EventEspresso\core\domain\Domain' |
|
918 | - ), |
|
919 | - array( |
|
920 | - new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
921 | - Version::fromString(espresso_version()), |
|
922 | - ) |
|
923 | - ); |
|
924 | - if ($domain->isCaffeinated()) { |
|
925 | - require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
926 | - } |
|
927 | - } |
|
928 | - |
|
929 | - |
|
930 | - /** |
|
931 | - * register_shortcodes_modules_and_widgets |
|
932 | - * generate lists of shortcodes and modules, then verify paths and classes |
|
933 | - * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
934 | - * which runs during the WP 'plugins_loaded' action at priority 7 |
|
935 | - * |
|
936 | - * @access public |
|
937 | - * @return void |
|
938 | - * @throws Exception |
|
939 | - */ |
|
940 | - public function register_shortcodes_modules_and_widgets() |
|
941 | - { |
|
942 | - if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
943 | - try { |
|
944 | - // load, register, and add shortcodes the new way |
|
945 | - $this->loader->getShared( |
|
946 | - 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
947 | - array( |
|
948 | - // and the old way, but we'll put it under control of the new system |
|
949 | - EE_Config::getLegacyShortcodesManager(), |
|
950 | - ) |
|
951 | - ); |
|
952 | - } catch (Exception $exception) { |
|
953 | - new ExceptionStackTraceDisplay($exception); |
|
954 | - } |
|
955 | - } |
|
956 | - do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
957 | - // check for addons using old hook point |
|
958 | - if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
959 | - $this->_incompatible_addon_error(); |
|
960 | - } |
|
961 | - } |
|
962 | - |
|
963 | - |
|
964 | - /** |
|
965 | - * _incompatible_addon_error |
|
966 | - * |
|
967 | - * @access public |
|
968 | - * @return void |
|
969 | - */ |
|
970 | - private function _incompatible_addon_error() |
|
971 | - { |
|
972 | - // get array of classes hooking into here |
|
973 | - $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
974 | - 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
975 | - ); |
|
976 | - if (! empty($class_names)) { |
|
977 | - $msg = __( |
|
978 | - 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
979 | - 'event_espresso' |
|
980 | - ); |
|
981 | - $msg .= '<ul>'; |
|
982 | - foreach ($class_names as $class_name) { |
|
983 | - $msg .= '<li><b>Event Espresso - ' |
|
984 | - . str_replace( |
|
985 | - array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
986 | - '', |
|
987 | - $class_name |
|
988 | - ) . '</b></li>'; |
|
989 | - } |
|
990 | - $msg .= '</ul>'; |
|
991 | - $msg .= __( |
|
992 | - 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
993 | - 'event_espresso' |
|
994 | - ); |
|
995 | - // save list of incompatible addons to wp-options for later use |
|
996 | - add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
997 | - if (is_admin()) { |
|
998 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
999 | - } |
|
1000 | - } |
|
1001 | - } |
|
1002 | - |
|
1003 | - |
|
1004 | - /** |
|
1005 | - * brew_espresso |
|
1006 | - * begins the process of setting hooks for initializing EE in the correct order |
|
1007 | - * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1008 | - * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1009 | - * |
|
1010 | - * @return void |
|
1011 | - */ |
|
1012 | - public function brew_espresso() |
|
1013 | - { |
|
1014 | - do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1015 | - // load some final core systems |
|
1016 | - add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1017 | - add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1018 | - add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1019 | - add_action('init', array($this, 'load_controllers'), 7); |
|
1020 | - add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1021 | - add_action('init', array($this, 'initialize'), 10); |
|
1022 | - add_action('init', array($this, 'initialize_last'), 100); |
|
1023 | - if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1024 | - // pew pew pew |
|
1025 | - $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1026 | - do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1027 | - } |
|
1028 | - do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1029 | - } |
|
1030 | - |
|
1031 | - |
|
1032 | - /** |
|
1033 | - * set_hooks_for_core |
|
1034 | - * |
|
1035 | - * @access public |
|
1036 | - * @return void |
|
1037 | - * @throws EE_Error |
|
1038 | - */ |
|
1039 | - public function set_hooks_for_core() |
|
1040 | - { |
|
1041 | - $this->_deactivate_incompatible_addons(); |
|
1042 | - do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1043 | - $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1044 | - // caps need to be initialized on every request so that capability maps are set. |
|
1045 | - // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1046 | - $this->registry->CAP->init_caps(); |
|
1047 | - } |
|
1048 | - |
|
1049 | - |
|
1050 | - /** |
|
1051 | - * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1052 | - * deactivates any addons considered incompatible with the current version of EE |
|
1053 | - */ |
|
1054 | - private function _deactivate_incompatible_addons() |
|
1055 | - { |
|
1056 | - $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1057 | - if (! empty($incompatible_addons)) { |
|
1058 | - $active_plugins = get_option('active_plugins', array()); |
|
1059 | - foreach ($active_plugins as $active_plugin) { |
|
1060 | - foreach ($incompatible_addons as $incompatible_addon) { |
|
1061 | - if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1062 | - unset($_GET['activate']); |
|
1063 | - espresso_deactivate_plugin($active_plugin); |
|
1064 | - } |
|
1065 | - } |
|
1066 | - } |
|
1067 | - } |
|
1068 | - } |
|
1069 | - |
|
1070 | - |
|
1071 | - /** |
|
1072 | - * perform_activations_upgrades_and_migrations |
|
1073 | - * |
|
1074 | - * @access public |
|
1075 | - * @return void |
|
1076 | - */ |
|
1077 | - public function perform_activations_upgrades_and_migrations() |
|
1078 | - { |
|
1079 | - do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1080 | - } |
|
1081 | - |
|
1082 | - |
|
1083 | - /** |
|
1084 | - * @return void |
|
1085 | - * @throws DomainException |
|
1086 | - */ |
|
1087 | - public function load_CPTs_and_session() |
|
1088 | - { |
|
1089 | - do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1090 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
1091 | - $register_custom_taxonomies = $this->loader->getShared( |
|
1092 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
1093 | - ); |
|
1094 | - $register_custom_taxonomies->registerCustomTaxonomies(); |
|
1095 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
1096 | - $register_custom_post_types = $this->loader->getShared( |
|
1097 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
1098 | - ); |
|
1099 | - $register_custom_post_types->registerCustomPostTypes(); |
|
1100 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
1101 | - $register_custom_taxonomy_terms = $this->loader->getShared( |
|
1102 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
1103 | - ); |
|
1104 | - $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
1105 | - // load legacy Custom Post Types and Taxonomies |
|
1106 | - $this->loader->getShared('EE_Register_CPTs'); |
|
1107 | - do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1108 | - } |
|
1109 | - |
|
1110 | - |
|
1111 | - /** |
|
1112 | - * load_controllers |
|
1113 | - * this is the best place to load any additional controllers that needs access to EE core. |
|
1114 | - * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1115 | - * time |
|
1116 | - * |
|
1117 | - * @access public |
|
1118 | - * @return void |
|
1119 | - */ |
|
1120 | - public function load_controllers() |
|
1121 | - { |
|
1122 | - do_action('AHEE__EE_System__load_controllers__start'); |
|
1123 | - // let's get it started |
|
1124 | - if (! $this->maintenance_mode->level() |
|
1125 | - && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1126 | - ) { |
|
1127 | - do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1128 | - $this->loader->getShared('EE_Front_Controller'); |
|
1129 | - } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1130 | - do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1131 | - $this->loader->getShared('EE_Admin'); |
|
1132 | - } |
|
1133 | - do_action('AHEE__EE_System__load_controllers__complete'); |
|
1134 | - } |
|
1135 | - |
|
1136 | - |
|
1137 | - /** |
|
1138 | - * core_loaded_and_ready |
|
1139 | - * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1140 | - * |
|
1141 | - * @access public |
|
1142 | - * @return void |
|
1143 | - * @throws Exception |
|
1144 | - */ |
|
1145 | - public function core_loaded_and_ready() |
|
1146 | - { |
|
1147 | - if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1148 | - try { |
|
1149 | - $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1150 | - $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
1151 | - if (function_exists('register_block_type')) { |
|
1152 | - $this->loader->getShared( |
|
1153 | - 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
1154 | - ); |
|
1155 | - } |
|
1156 | - } catch (Exception $exception) { |
|
1157 | - new ExceptionStackTraceDisplay($exception); |
|
1158 | - } |
|
1159 | - } |
|
1160 | - if ($this->request->isAdmin() |
|
1161 | - || $this->request->isEeAjax() |
|
1162 | - || $this->request->isFrontend() |
|
1163 | - ) { |
|
1164 | - $this->loader->getShared('EE_Session'); |
|
1165 | - } |
|
1166 | - // integrate WP_Query with the EE models |
|
1167 | - $this->loader->getShared('EE_CPT_Strategy'); |
|
1168 | - do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1169 | - // load_espresso_template_tags |
|
1170 | - if (($this->request->isFrontend() |
|
1171 | - || $this->request->isIframe() |
|
1172 | - || $this->request->isFeed() |
|
1173 | - || $this->request->isAjax() |
|
1174 | - ) && is_readable(EE_PUBLIC . 'template_tags.php') |
|
1175 | - ) { |
|
1176 | - require_once EE_PUBLIC . 'template_tags.php'; |
|
1177 | - } |
|
1178 | - do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1179 | - } |
|
1180 | - |
|
1181 | - |
|
1182 | - /** |
|
1183 | - * initialize |
|
1184 | - * this is the best place to begin initializing client code |
|
1185 | - * |
|
1186 | - * @access public |
|
1187 | - * @return void |
|
1188 | - */ |
|
1189 | - public function initialize() |
|
1190 | - { |
|
1191 | - do_action('AHEE__EE_System__initialize'); |
|
1192 | - } |
|
1193 | - |
|
1194 | - |
|
1195 | - /** |
|
1196 | - * initialize_last |
|
1197 | - * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1198 | - * initialize has done so |
|
1199 | - * |
|
1200 | - * @access public |
|
1201 | - * @return void |
|
1202 | - */ |
|
1203 | - public function initialize_last() |
|
1204 | - { |
|
1205 | - do_action('AHEE__EE_System__initialize_last'); |
|
1206 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
1207 | - $rewrite_rules = $this->loader->getShared( |
|
1208 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
1209 | - ); |
|
1210 | - $rewrite_rules->flushRewriteRules(); |
|
1211 | - add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1212 | - if (($this->request->isAjax() || $this->request->isAdmin()) |
|
1213 | - && $this->maintenance_mode->models_can_query()) { |
|
1214 | - $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
1215 | - $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
1216 | - } |
|
1217 | - } |
|
1218 | - |
|
1219 | - |
|
1220 | - /** |
|
1221 | - * @return void |
|
1222 | - * @throws EE_Error |
|
1223 | - */ |
|
1224 | - public function addEspressoToolbar() |
|
1225 | - { |
|
1226 | - $this->loader->getShared( |
|
1227 | - 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1228 | - array($this->registry->CAP) |
|
1229 | - ); |
|
1230 | - } |
|
1231 | - |
|
1232 | - |
|
1233 | - /** |
|
1234 | - * do_not_cache |
|
1235 | - * sets no cache headers and defines no cache constants for WP plugins |
|
1236 | - * |
|
1237 | - * @access public |
|
1238 | - * @return void |
|
1239 | - */ |
|
1240 | - public static function do_not_cache() |
|
1241 | - { |
|
1242 | - // set no cache constants |
|
1243 | - if (! defined('DONOTCACHEPAGE')) { |
|
1244 | - define('DONOTCACHEPAGE', true); |
|
1245 | - } |
|
1246 | - if (! defined('DONOTCACHCEOBJECT')) { |
|
1247 | - define('DONOTCACHCEOBJECT', true); |
|
1248 | - } |
|
1249 | - if (! defined('DONOTCACHEDB')) { |
|
1250 | - define('DONOTCACHEDB', true); |
|
1251 | - } |
|
1252 | - // add no cache headers |
|
1253 | - add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1254 | - // plus a little extra for nginx and Google Chrome |
|
1255 | - add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1256 | - // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1257 | - remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1258 | - } |
|
1259 | - |
|
1260 | - |
|
1261 | - /** |
|
1262 | - * extra_nocache_headers |
|
1263 | - * |
|
1264 | - * @access public |
|
1265 | - * @param $headers |
|
1266 | - * @return array |
|
1267 | - */ |
|
1268 | - public static function extra_nocache_headers($headers) |
|
1269 | - { |
|
1270 | - // for NGINX |
|
1271 | - $headers['X-Accel-Expires'] = 0; |
|
1272 | - // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1273 | - $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1274 | - return $headers; |
|
1275 | - } |
|
1276 | - |
|
1277 | - |
|
1278 | - /** |
|
1279 | - * nocache_headers |
|
1280 | - * |
|
1281 | - * @access public |
|
1282 | - * @return void |
|
1283 | - */ |
|
1284 | - public static function nocache_headers() |
|
1285 | - { |
|
1286 | - nocache_headers(); |
|
1287 | - } |
|
1288 | - |
|
1289 | - |
|
1290 | - /** |
|
1291 | - * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1292 | - * never returned with the function. |
|
1293 | - * |
|
1294 | - * @param array $exclude_array any existing pages being excluded are in this array. |
|
1295 | - * @return array |
|
1296 | - */ |
|
1297 | - public function remove_pages_from_wp_list_pages($exclude_array) |
|
1298 | - { |
|
1299 | - return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1300 | - } |
|
30 | + /** |
|
31 | + * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
32 | + * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
33 | + */ |
|
34 | + const req_type_normal = 0; |
|
35 | + |
|
36 | + /** |
|
37 | + * Indicates this is a brand new installation of EE so we should install |
|
38 | + * tables and default data etc |
|
39 | + */ |
|
40 | + const req_type_new_activation = 1; |
|
41 | + |
|
42 | + /** |
|
43 | + * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
44 | + * and we just exited maintenance mode). We MUST check the database is setup properly |
|
45 | + * and that default data is setup too |
|
46 | + */ |
|
47 | + const req_type_reactivation = 2; |
|
48 | + |
|
49 | + /** |
|
50 | + * indicates that EE has been upgraded since its previous request. |
|
51 | + * We may have data migration scripts to call and will want to trigger maintenance mode |
|
52 | + */ |
|
53 | + const req_type_upgrade = 3; |
|
54 | + |
|
55 | + /** |
|
56 | + * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
57 | + */ |
|
58 | + const req_type_downgrade = 4; |
|
59 | + |
|
60 | + /** |
|
61 | + * @deprecated since version 4.6.0.dev.006 |
|
62 | + * Now whenever a new_activation is detected the request type is still just |
|
63 | + * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
64 | + * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
65 | + * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
66 | + * (Specifically, when the migration manager indicates migrations are finished |
|
67 | + * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
68 | + */ |
|
69 | + const req_type_activation_but_not_installed = 5; |
|
70 | + |
|
71 | + /** |
|
72 | + * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
73 | + */ |
|
74 | + const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
75 | + |
|
76 | + /** |
|
77 | + * @var EE_System $_instance |
|
78 | + */ |
|
79 | + private static $_instance; |
|
80 | + |
|
81 | + /** |
|
82 | + * @var EE_Registry $registry |
|
83 | + */ |
|
84 | + private $registry; |
|
85 | + |
|
86 | + /** |
|
87 | + * @var LoaderInterface $loader |
|
88 | + */ |
|
89 | + private $loader; |
|
90 | + |
|
91 | + /** |
|
92 | + * @var EE_Capabilities $capabilities |
|
93 | + */ |
|
94 | + private $capabilities; |
|
95 | + |
|
96 | + /** |
|
97 | + * @var RequestInterface $request |
|
98 | + */ |
|
99 | + private $request; |
|
100 | + |
|
101 | + /** |
|
102 | + * @var EE_Maintenance_Mode $maintenance_mode |
|
103 | + */ |
|
104 | + private $maintenance_mode; |
|
105 | + |
|
106 | + /** |
|
107 | + * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
108 | + * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
109 | + * |
|
110 | + * @var int $_req_type |
|
111 | + */ |
|
112 | + private $_req_type; |
|
113 | + |
|
114 | + /** |
|
115 | + * Whether or not there was a non-micro version change in EE core version during this request |
|
116 | + * |
|
117 | + * @var boolean $_major_version_change |
|
118 | + */ |
|
119 | + private $_major_version_change = false; |
|
120 | + |
|
121 | + /** |
|
122 | + * A Context DTO dedicated solely to identifying the current request type. |
|
123 | + * |
|
124 | + * @var RequestTypeContextCheckerInterface $request_type |
|
125 | + */ |
|
126 | + private $request_type; |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * @singleton method used to instantiate class object |
|
131 | + * @param EE_Registry|null $registry |
|
132 | + * @param LoaderInterface|null $loader |
|
133 | + * @param RequestInterface|null $request |
|
134 | + * @param EE_Maintenance_Mode|null $maintenance_mode |
|
135 | + * @return EE_System |
|
136 | + */ |
|
137 | + public static function instance( |
|
138 | + EE_Registry $registry = null, |
|
139 | + LoaderInterface $loader = null, |
|
140 | + RequestInterface $request = null, |
|
141 | + EE_Maintenance_Mode $maintenance_mode = null |
|
142 | + ) { |
|
143 | + // check if class object is instantiated |
|
144 | + if (! self::$_instance instanceof EE_System) { |
|
145 | + self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
146 | + } |
|
147 | + return self::$_instance; |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * resets the instance and returns it |
|
153 | + * |
|
154 | + * @return EE_System |
|
155 | + */ |
|
156 | + public static function reset() |
|
157 | + { |
|
158 | + self::$_instance->_req_type = null; |
|
159 | + // make sure none of the old hooks are left hanging around |
|
160 | + remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
161 | + // we need to reset the migration manager in order for it to detect DMSs properly |
|
162 | + EE_Data_Migration_Manager::reset(); |
|
163 | + self::instance()->detect_activations_or_upgrades(); |
|
164 | + self::instance()->perform_activations_upgrades_and_migrations(); |
|
165 | + return self::instance(); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * sets hooks for running rest of system |
|
171 | + * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
172 | + * starting EE Addons from any other point may lead to problems |
|
173 | + * |
|
174 | + * @param EE_Registry $registry |
|
175 | + * @param LoaderInterface $loader |
|
176 | + * @param RequestInterface $request |
|
177 | + * @param EE_Maintenance_Mode $maintenance_mode |
|
178 | + */ |
|
179 | + private function __construct( |
|
180 | + EE_Registry $registry, |
|
181 | + LoaderInterface $loader, |
|
182 | + RequestInterface $request, |
|
183 | + EE_Maintenance_Mode $maintenance_mode |
|
184 | + ) { |
|
185 | + $this->registry = $registry; |
|
186 | + $this->loader = $loader; |
|
187 | + $this->request = $request; |
|
188 | + $this->maintenance_mode = $maintenance_mode; |
|
189 | + do_action('AHEE__EE_System__construct__begin', $this); |
|
190 | + add_action( |
|
191 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
192 | + array($this, 'loadCapabilities'), |
|
193 | + 5 |
|
194 | + ); |
|
195 | + add_action( |
|
196 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
197 | + array($this, 'loadCommandBus'), |
|
198 | + 7 |
|
199 | + ); |
|
200 | + add_action( |
|
201 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
202 | + array($this, 'loadPluginApi'), |
|
203 | + 9 |
|
204 | + ); |
|
205 | + // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
206 | + add_action( |
|
207 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
208 | + array($this, 'load_espresso_addons') |
|
209 | + ); |
|
210 | + // when an ee addon is activated, we want to call the core hook(s) again |
|
211 | + // because the newly-activated addon didn't get a chance to run at all |
|
212 | + add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
213 | + // detect whether install or upgrade |
|
214 | + add_action( |
|
215 | + 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
216 | + array($this, 'detect_activations_or_upgrades'), |
|
217 | + 3 |
|
218 | + ); |
|
219 | + // load EE_Config, EE_Textdomain, etc |
|
220 | + add_action( |
|
221 | + 'AHEE__EE_Bootstrap__load_core_configuration', |
|
222 | + array($this, 'load_core_configuration'), |
|
223 | + 5 |
|
224 | + ); |
|
225 | + // load EE_Config, EE_Textdomain, etc |
|
226 | + add_action( |
|
227 | + 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
228 | + array($this, 'register_shortcodes_modules_and_widgets'), |
|
229 | + 7 |
|
230 | + ); |
|
231 | + // you wanna get going? I wanna get going... let's get going! |
|
232 | + add_action( |
|
233 | + 'AHEE__EE_Bootstrap__brew_espresso', |
|
234 | + array($this, 'brew_espresso'), |
|
235 | + 9 |
|
236 | + ); |
|
237 | + // other housekeeping |
|
238 | + // exclude EE critical pages from wp_list_pages |
|
239 | + add_filter( |
|
240 | + 'wp_list_pages_excludes', |
|
241 | + array($this, 'remove_pages_from_wp_list_pages'), |
|
242 | + 10 |
|
243 | + ); |
|
244 | + // ALL EE Addons should use the following hook point to attach their initial setup too |
|
245 | + // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
246 | + do_action('AHEE__EE_System__construct__complete', $this); |
|
247 | + } |
|
248 | + |
|
249 | + |
|
250 | + /** |
|
251 | + * load and setup EE_Capabilities |
|
252 | + * |
|
253 | + * @return void |
|
254 | + * @throws EE_Error |
|
255 | + */ |
|
256 | + public function loadCapabilities() |
|
257 | + { |
|
258 | + $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
259 | + add_action( |
|
260 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
261 | + function () { |
|
262 | + LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
263 | + } |
|
264 | + ); |
|
265 | + } |
|
266 | + |
|
267 | + |
|
268 | + /** |
|
269 | + * create and cache the CommandBus, and also add middleware |
|
270 | + * The CapChecker middleware requires the use of EE_Capabilities |
|
271 | + * which is why we need to load the CommandBus after Caps are set up |
|
272 | + * |
|
273 | + * @return void |
|
274 | + * @throws EE_Error |
|
275 | + */ |
|
276 | + public function loadCommandBus() |
|
277 | + { |
|
278 | + $this->loader->getShared( |
|
279 | + 'CommandBusInterface', |
|
280 | + array( |
|
281 | + null, |
|
282 | + apply_filters( |
|
283 | + 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
284 | + array( |
|
285 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
286 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
287 | + ) |
|
288 | + ), |
|
289 | + ) |
|
290 | + ); |
|
291 | + } |
|
292 | + |
|
293 | + |
|
294 | + /** |
|
295 | + * @return void |
|
296 | + * @throws EE_Error |
|
297 | + */ |
|
298 | + public function loadPluginApi() |
|
299 | + { |
|
300 | + // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
301 | + // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
302 | + EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
303 | + $this->loader->getShared('EE_Request_Handler'); |
|
304 | + } |
|
305 | + |
|
306 | + |
|
307 | + /** |
|
308 | + * @param string $addon_name |
|
309 | + * @param string $version_constant |
|
310 | + * @param string $min_version_required |
|
311 | + * @param string $load_callback |
|
312 | + * @param string $plugin_file_constant |
|
313 | + * @return void |
|
314 | + */ |
|
315 | + private function deactivateIncompatibleAddon( |
|
316 | + $addon_name, |
|
317 | + $version_constant, |
|
318 | + $min_version_required, |
|
319 | + $load_callback, |
|
320 | + $plugin_file_constant |
|
321 | + ) { |
|
322 | + if (! defined($version_constant)) { |
|
323 | + return; |
|
324 | + } |
|
325 | + $addon_version = constant($version_constant); |
|
326 | + if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
327 | + remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
328 | + if (! function_exists('deactivate_plugins')) { |
|
329 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
330 | + } |
|
331 | + deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
332 | + unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
333 | + EE_Error::add_error( |
|
334 | + sprintf( |
|
335 | + esc_html__( |
|
336 | + 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
337 | + 'event_espresso' |
|
338 | + ), |
|
339 | + $addon_name, |
|
340 | + $min_version_required |
|
341 | + ), |
|
342 | + __FILE__, |
|
343 | + __FUNCTION__ . "({$addon_name})", |
|
344 | + __LINE__ |
|
345 | + ); |
|
346 | + EE_Error::get_notices(false, true); |
|
347 | + } |
|
348 | + } |
|
349 | + |
|
350 | + |
|
351 | + /** |
|
352 | + * load_espresso_addons |
|
353 | + * allow addons to load first so that they can set hooks for running DMS's, etc |
|
354 | + * this is hooked into both: |
|
355 | + * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
356 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
357 | + * and the WP 'activate_plugin' hook point |
|
358 | + * |
|
359 | + * @access public |
|
360 | + * @return void |
|
361 | + */ |
|
362 | + public function load_espresso_addons() |
|
363 | + { |
|
364 | + $this->deactivateIncompatibleAddon( |
|
365 | + 'Wait Lists', |
|
366 | + 'EE_WAIT_LISTS_VERSION', |
|
367 | + '1.0.0.beta.074', |
|
368 | + 'load_espresso_wait_lists', |
|
369 | + 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
370 | + ); |
|
371 | + $this->deactivateIncompatibleAddon( |
|
372 | + 'Automated Upcoming Event Notifications', |
|
373 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
374 | + '1.0.0.beta.091', |
|
375 | + 'load_espresso_automated_upcoming_event_notification', |
|
376 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
377 | + ); |
|
378 | + do_action('AHEE__EE_System__load_espresso_addons'); |
|
379 | + // if the WP API basic auth plugin isn't already loaded, load it now. |
|
380 | + // We want it for mobile apps. Just include the entire plugin |
|
381 | + // also, don't load the basic auth when a plugin is getting activated, because |
|
382 | + // it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
383 | + // and causes a fatal error |
|
384 | + if ($this->request->getRequestParam('activate') !== 'true' |
|
385 | + && ! function_exists('json_basic_auth_handler') |
|
386 | + && ! function_exists('json_basic_auth_error') |
|
387 | + && ! in_array( |
|
388 | + $this->request->getRequestParam('action'), |
|
389 | + array('activate', 'activate-selected'), |
|
390 | + true |
|
391 | + ) |
|
392 | + ) { |
|
393 | + include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
394 | + } |
|
395 | + do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
396 | + } |
|
397 | + |
|
398 | + |
|
399 | + /** |
|
400 | + * detect_activations_or_upgrades |
|
401 | + * Checks for activation or upgrade of core first; |
|
402 | + * then also checks if any registered addons have been activated or upgraded |
|
403 | + * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
404 | + * which runs during the WP 'plugins_loaded' action at priority 3 |
|
405 | + * |
|
406 | + * @access public |
|
407 | + * @return void |
|
408 | + */ |
|
409 | + public function detect_activations_or_upgrades() |
|
410 | + { |
|
411 | + // first off: let's make sure to handle core |
|
412 | + $this->detect_if_activation_or_upgrade(); |
|
413 | + foreach ($this->registry->addons as $addon) { |
|
414 | + if ($addon instanceof EE_Addon) { |
|
415 | + // detect teh request type for that addon |
|
416 | + $addon->detect_activation_or_upgrade(); |
|
417 | + } |
|
418 | + } |
|
419 | + } |
|
420 | + |
|
421 | + |
|
422 | + /** |
|
423 | + * detect_if_activation_or_upgrade |
|
424 | + * Takes care of detecting whether this is a brand new install or code upgrade, |
|
425 | + * and either setting up the DB or setting up maintenance mode etc. |
|
426 | + * |
|
427 | + * @access public |
|
428 | + * @return void |
|
429 | + */ |
|
430 | + public function detect_if_activation_or_upgrade() |
|
431 | + { |
|
432 | + do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
433 | + // check if db has been updated, or if its a brand-new installation |
|
434 | + $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
435 | + $request_type = $this->detect_req_type($espresso_db_update); |
|
436 | + // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
437 | + switch ($request_type) { |
|
438 | + case EE_System::req_type_new_activation: |
|
439 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
440 | + $this->_handle_core_version_change($espresso_db_update); |
|
441 | + break; |
|
442 | + case EE_System::req_type_reactivation: |
|
443 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
444 | + $this->_handle_core_version_change($espresso_db_update); |
|
445 | + break; |
|
446 | + case EE_System::req_type_upgrade: |
|
447 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
448 | + // migrations may be required now that we've upgraded |
|
449 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
450 | + $this->_handle_core_version_change($espresso_db_update); |
|
451 | + break; |
|
452 | + case EE_System::req_type_downgrade: |
|
453 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
454 | + // its possible migrations are no longer required |
|
455 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
456 | + $this->_handle_core_version_change($espresso_db_update); |
|
457 | + break; |
|
458 | + case EE_System::req_type_normal: |
|
459 | + default: |
|
460 | + break; |
|
461 | + } |
|
462 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
463 | + } |
|
464 | + |
|
465 | + |
|
466 | + /** |
|
467 | + * Updates the list of installed versions and sets hooks for |
|
468 | + * initializing the database later during the request |
|
469 | + * |
|
470 | + * @param array $espresso_db_update |
|
471 | + */ |
|
472 | + private function _handle_core_version_change($espresso_db_update) |
|
473 | + { |
|
474 | + $this->update_list_of_installed_versions($espresso_db_update); |
|
475 | + // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
476 | + add_action( |
|
477 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
478 | + array($this, 'initialize_db_if_no_migrations_required') |
|
479 | + ); |
|
480 | + } |
|
481 | + |
|
482 | + |
|
483 | + /** |
|
484 | + * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
485 | + * information about what versions of EE have been installed and activated, |
|
486 | + * NOT necessarily the state of the database |
|
487 | + * |
|
488 | + * @param mixed $espresso_db_update the value of the WordPress option. |
|
489 | + * If not supplied, fetches it from the options table |
|
490 | + * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
491 | + */ |
|
492 | + private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
493 | + { |
|
494 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
495 | + if (! $espresso_db_update) { |
|
496 | + $espresso_db_update = get_option('espresso_db_update'); |
|
497 | + } |
|
498 | + // check that option is an array |
|
499 | + if (! is_array($espresso_db_update)) { |
|
500 | + // if option is FALSE, then it never existed |
|
501 | + if ($espresso_db_update === false) { |
|
502 | + // make $espresso_db_update an array and save option with autoload OFF |
|
503 | + $espresso_db_update = array(); |
|
504 | + add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
505 | + } else { |
|
506 | + // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
507 | + $espresso_db_update = array($espresso_db_update => array()); |
|
508 | + update_option('espresso_db_update', $espresso_db_update); |
|
509 | + } |
|
510 | + } else { |
|
511 | + $corrected_db_update = array(); |
|
512 | + // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
513 | + foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
514 | + if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
515 | + // the key is an int, and the value IS NOT an array |
|
516 | + // so it must be numerically-indexed, where values are versions installed... |
|
517 | + // fix it! |
|
518 | + $version_string = $should_be_array; |
|
519 | + $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
520 | + } else { |
|
521 | + // ok it checks out |
|
522 | + $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
523 | + } |
|
524 | + } |
|
525 | + $espresso_db_update = $corrected_db_update; |
|
526 | + update_option('espresso_db_update', $espresso_db_update); |
|
527 | + } |
|
528 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
529 | + return $espresso_db_update; |
|
530 | + } |
|
531 | + |
|
532 | + |
|
533 | + /** |
|
534 | + * Does the traditional work of setting up the plugin's database and adding default data. |
|
535 | + * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
536 | + * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
537 | + * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
538 | + * so that it will be done when migrations are finished |
|
539 | + * |
|
540 | + * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
541 | + * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
542 | + * This is a resource-intensive job |
|
543 | + * so we prefer to only do it when necessary |
|
544 | + * @return void |
|
545 | + * @throws EE_Error |
|
546 | + */ |
|
547 | + public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
548 | + { |
|
549 | + $request_type = $this->detect_req_type(); |
|
550 | + // only initialize system if we're not in maintenance mode. |
|
551 | + if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
552 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
553 | + $rewrite_rules = $this->loader->getShared( |
|
554 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
555 | + ); |
|
556 | + $rewrite_rules->flush(); |
|
557 | + if ($verify_schema) { |
|
558 | + EEH_Activation::initialize_db_and_folders(); |
|
559 | + } |
|
560 | + EEH_Activation::initialize_db_content(); |
|
561 | + EEH_Activation::system_initialization(); |
|
562 | + if ($initialize_addons_too) { |
|
563 | + $this->initialize_addons(); |
|
564 | + } |
|
565 | + } else { |
|
566 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
567 | + } |
|
568 | + if ($request_type === EE_System::req_type_new_activation |
|
569 | + || $request_type === EE_System::req_type_reactivation |
|
570 | + || ( |
|
571 | + $request_type === EE_System::req_type_upgrade |
|
572 | + && $this->is_major_version_change() |
|
573 | + ) |
|
574 | + ) { |
|
575 | + add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
576 | + } |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + /** |
|
581 | + * Initializes the db for all registered addons |
|
582 | + * |
|
583 | + * @throws EE_Error |
|
584 | + */ |
|
585 | + public function initialize_addons() |
|
586 | + { |
|
587 | + // foreach registered addon, make sure its db is up-to-date too |
|
588 | + foreach ($this->registry->addons as $addon) { |
|
589 | + if ($addon instanceof EE_Addon) { |
|
590 | + $addon->initialize_db_if_no_migrations_required(); |
|
591 | + } |
|
592 | + } |
|
593 | + } |
|
594 | + |
|
595 | + |
|
596 | + /** |
|
597 | + * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
598 | + * |
|
599 | + * @param array $version_history |
|
600 | + * @param string $current_version_to_add version to be added to the version history |
|
601 | + * @return boolean success as to whether or not this option was changed |
|
602 | + */ |
|
603 | + public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
604 | + { |
|
605 | + if (! $version_history) { |
|
606 | + $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
607 | + } |
|
608 | + if ($current_version_to_add === null) { |
|
609 | + $current_version_to_add = espresso_version(); |
|
610 | + } |
|
611 | + $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
612 | + // re-save |
|
613 | + return update_option('espresso_db_update', $version_history); |
|
614 | + } |
|
615 | + |
|
616 | + |
|
617 | + /** |
|
618 | + * Detects if the current version indicated in the has existed in the list of |
|
619 | + * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
620 | + * |
|
621 | + * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
622 | + * If not supplied, fetches it from the options table. |
|
623 | + * Also, caches its result so later parts of the code can also know whether |
|
624 | + * there's been an update or not. This way we can add the current version to |
|
625 | + * espresso_db_update, but still know if this is a new install or not |
|
626 | + * @return int one of the constants on EE_System::req_type_ |
|
627 | + */ |
|
628 | + public function detect_req_type($espresso_db_update = null) |
|
629 | + { |
|
630 | + if ($this->_req_type === null) { |
|
631 | + $espresso_db_update = ! empty($espresso_db_update) |
|
632 | + ? $espresso_db_update |
|
633 | + : $this->fix_espresso_db_upgrade_option(); |
|
634 | + $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
635 | + $espresso_db_update, |
|
636 | + 'ee_espresso_activation', |
|
637 | + espresso_version() |
|
638 | + ); |
|
639 | + $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
640 | + $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
641 | + } |
|
642 | + return $this->_req_type; |
|
643 | + } |
|
644 | + |
|
645 | + |
|
646 | + /** |
|
647 | + * Returns whether or not there was a non-micro version change (ie, change in either |
|
648 | + * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
649 | + * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
650 | + * |
|
651 | + * @param $activation_history |
|
652 | + * @return bool |
|
653 | + */ |
|
654 | + private function _detect_major_version_change($activation_history) |
|
655 | + { |
|
656 | + $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
657 | + $previous_version_parts = explode('.', $previous_version); |
|
658 | + $current_version_parts = explode('.', espresso_version()); |
|
659 | + return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
660 | + && ($previous_version_parts[0] !== $current_version_parts[0] |
|
661 | + || $previous_version_parts[1] !== $current_version_parts[1] |
|
662 | + ); |
|
663 | + } |
|
664 | + |
|
665 | + |
|
666 | + /** |
|
667 | + * Returns true if either the major or minor version of EE changed during this request. |
|
668 | + * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
669 | + * |
|
670 | + * @return bool |
|
671 | + */ |
|
672 | + public function is_major_version_change() |
|
673 | + { |
|
674 | + return $this->_major_version_change; |
|
675 | + } |
|
676 | + |
|
677 | + |
|
678 | + /** |
|
679 | + * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
680 | + * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
681 | + * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
682 | + * just activated to (for core that will always be espresso_version()) |
|
683 | + * |
|
684 | + * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
685 | + * ee plugin. for core that's 'espresso_db_update' |
|
686 | + * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
687 | + * indicate that this plugin was just activated |
|
688 | + * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
689 | + * espresso_version()) |
|
690 | + * @return int one of the constants on EE_System::req_type_* |
|
691 | + */ |
|
692 | + public static function detect_req_type_given_activation_history( |
|
693 | + $activation_history_for_addon, |
|
694 | + $activation_indicator_option_name, |
|
695 | + $version_to_upgrade_to |
|
696 | + ) { |
|
697 | + $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
698 | + if ($activation_history_for_addon) { |
|
699 | + // it exists, so this isn't a completely new install |
|
700 | + // check if this version already in that list of previously installed versions |
|
701 | + if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
702 | + // it a version we haven't seen before |
|
703 | + if ($version_is_higher === 1) { |
|
704 | + $req_type = EE_System::req_type_upgrade; |
|
705 | + } else { |
|
706 | + $req_type = EE_System::req_type_downgrade; |
|
707 | + } |
|
708 | + delete_option($activation_indicator_option_name); |
|
709 | + } else { |
|
710 | + // its not an update. maybe a reactivation? |
|
711 | + if (get_option($activation_indicator_option_name, false)) { |
|
712 | + if ($version_is_higher === -1) { |
|
713 | + $req_type = EE_System::req_type_downgrade; |
|
714 | + } elseif ($version_is_higher === 0) { |
|
715 | + // we've seen this version before, but it's an activation. must be a reactivation |
|
716 | + $req_type = EE_System::req_type_reactivation; |
|
717 | + } else {// $version_is_higher === 1 |
|
718 | + $req_type = EE_System::req_type_upgrade; |
|
719 | + } |
|
720 | + delete_option($activation_indicator_option_name); |
|
721 | + } else { |
|
722 | + // we've seen this version before and the activation indicate doesn't show it was just activated |
|
723 | + if ($version_is_higher === -1) { |
|
724 | + $req_type = EE_System::req_type_downgrade; |
|
725 | + } elseif ($version_is_higher === 0) { |
|
726 | + // we've seen this version before and it's not an activation. its normal request |
|
727 | + $req_type = EE_System::req_type_normal; |
|
728 | + } else {// $version_is_higher === 1 |
|
729 | + $req_type = EE_System::req_type_upgrade; |
|
730 | + } |
|
731 | + } |
|
732 | + } |
|
733 | + } else { |
|
734 | + // brand new install |
|
735 | + $req_type = EE_System::req_type_new_activation; |
|
736 | + delete_option($activation_indicator_option_name); |
|
737 | + } |
|
738 | + return $req_type; |
|
739 | + } |
|
740 | + |
|
741 | + |
|
742 | + /** |
|
743 | + * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
744 | + * the $activation_history_for_addon |
|
745 | + * |
|
746 | + * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
747 | + * sometimes containing 'unknown-date' |
|
748 | + * @param string $version_to_upgrade_to (current version) |
|
749 | + * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
750 | + * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
751 | + * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
752 | + * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
753 | + */ |
|
754 | + private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
755 | + { |
|
756 | + // find the most recently-activated version |
|
757 | + $most_recently_active_version = |
|
758 | + EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
759 | + return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
760 | + } |
|
761 | + |
|
762 | + |
|
763 | + /** |
|
764 | + * Gets the most recently active version listed in the activation history, |
|
765 | + * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
766 | + * |
|
767 | + * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
768 | + * sometimes containing 'unknown-date' |
|
769 | + * @return string |
|
770 | + */ |
|
771 | + private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
772 | + { |
|
773 | + $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
774 | + $most_recently_active_version = '0.0.0.dev.000'; |
|
775 | + if (is_array($activation_history)) { |
|
776 | + foreach ($activation_history as $version => $times_activated) { |
|
777 | + // check there is a record of when this version was activated. Otherwise, |
|
778 | + // mark it as unknown |
|
779 | + if (! $times_activated) { |
|
780 | + $times_activated = array('unknown-date'); |
|
781 | + } |
|
782 | + if (is_string($times_activated)) { |
|
783 | + $times_activated = array($times_activated); |
|
784 | + } |
|
785 | + foreach ($times_activated as $an_activation) { |
|
786 | + if ($an_activation !== 'unknown-date' |
|
787 | + && $an_activation |
|
788 | + > $most_recently_active_version_activation) { |
|
789 | + $most_recently_active_version = $version; |
|
790 | + $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
791 | + ? '1970-01-01 00:00:00' |
|
792 | + : $an_activation; |
|
793 | + } |
|
794 | + } |
|
795 | + } |
|
796 | + } |
|
797 | + return $most_recently_active_version; |
|
798 | + } |
|
799 | + |
|
800 | + |
|
801 | + /** |
|
802 | + * This redirects to the about EE page after activation |
|
803 | + * |
|
804 | + * @return void |
|
805 | + */ |
|
806 | + public function redirect_to_about_ee() |
|
807 | + { |
|
808 | + $notices = EE_Error::get_notices(false); |
|
809 | + // if current user is an admin and it's not an ajax or rest request |
|
810 | + if (! isset($notices['errors']) |
|
811 | + && $this->request->isAdmin() |
|
812 | + && apply_filters( |
|
813 | + 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
814 | + $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
815 | + ) |
|
816 | + ) { |
|
817 | + $query_params = array('page' => 'espresso_about'); |
|
818 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
819 | + $query_params['new_activation'] = true; |
|
820 | + } |
|
821 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
822 | + $query_params['reactivation'] = true; |
|
823 | + } |
|
824 | + $url = add_query_arg($query_params, admin_url('admin.php')); |
|
825 | + wp_safe_redirect($url); |
|
826 | + exit(); |
|
827 | + } |
|
828 | + } |
|
829 | + |
|
830 | + |
|
831 | + /** |
|
832 | + * load_core_configuration |
|
833 | + * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
834 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
835 | + * |
|
836 | + * @return void |
|
837 | + * @throws ReflectionException |
|
838 | + */ |
|
839 | + public function load_core_configuration() |
|
840 | + { |
|
841 | + do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
842 | + $this->loader->getShared('EE_Load_Textdomain'); |
|
843 | + // load textdomain |
|
844 | + EE_Load_Textdomain::load_textdomain(); |
|
845 | + // load and setup EE_Config and EE_Network_Config |
|
846 | + $config = $this->loader->getShared('EE_Config'); |
|
847 | + $this->loader->getShared('EE_Network_Config'); |
|
848 | + // setup autoloaders |
|
849 | + // enable logging? |
|
850 | + if ($config->admin->use_full_logging) { |
|
851 | + $this->loader->getShared('EE_Log'); |
|
852 | + } |
|
853 | + // check for activation errors |
|
854 | + $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
855 | + if ($activation_errors) { |
|
856 | + EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
857 | + update_option('ee_plugin_activation_errors', false); |
|
858 | + } |
|
859 | + // get model names |
|
860 | + $this->_parse_model_names(); |
|
861 | + // load caf stuff a chance to play during the activation process too. |
|
862 | + $this->_maybe_brew_regular(); |
|
863 | + // configure custom post type definitions |
|
864 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
865 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
866 | + do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
867 | + } |
|
868 | + |
|
869 | + |
|
870 | + /** |
|
871 | + * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
872 | + * |
|
873 | + * @return void |
|
874 | + * @throws ReflectionException |
|
875 | + */ |
|
876 | + private function _parse_model_names() |
|
877 | + { |
|
878 | + // get all the files in the EE_MODELS folder that end in .model.php |
|
879 | + $models = glob(EE_MODELS . '*.model.php'); |
|
880 | + $model_names = array(); |
|
881 | + $non_abstract_db_models = array(); |
|
882 | + foreach ($models as $model) { |
|
883 | + // get model classname |
|
884 | + $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
885 | + $short_name = str_replace('EEM_', '', $classname); |
|
886 | + $reflectionClass = new ReflectionClass($classname); |
|
887 | + if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
888 | + $non_abstract_db_models[ $short_name ] = $classname; |
|
889 | + } |
|
890 | + $model_names[ $short_name ] = $classname; |
|
891 | + } |
|
892 | + $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
893 | + $this->registry->non_abstract_db_models = apply_filters( |
|
894 | + 'FHEE__EE_System__parse_implemented_model_names', |
|
895 | + $non_abstract_db_models |
|
896 | + ); |
|
897 | + } |
|
898 | + |
|
899 | + |
|
900 | + /** |
|
901 | + * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
902 | + * that need to be setup before our EE_System launches. |
|
903 | + * |
|
904 | + * @return void |
|
905 | + * @throws DomainException |
|
906 | + * @throws InvalidArgumentException |
|
907 | + * @throws InvalidDataTypeException |
|
908 | + * @throws InvalidInterfaceException |
|
909 | + * @throws InvalidClassException |
|
910 | + * @throws InvalidFilePathException |
|
911 | + */ |
|
912 | + private function _maybe_brew_regular() |
|
913 | + { |
|
914 | + /** @var Domain $domain */ |
|
915 | + $domain = DomainFactory::getShared( |
|
916 | + new FullyQualifiedName( |
|
917 | + 'EventEspresso\core\domain\Domain' |
|
918 | + ), |
|
919 | + array( |
|
920 | + new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
921 | + Version::fromString(espresso_version()), |
|
922 | + ) |
|
923 | + ); |
|
924 | + if ($domain->isCaffeinated()) { |
|
925 | + require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
926 | + } |
|
927 | + } |
|
928 | + |
|
929 | + |
|
930 | + /** |
|
931 | + * register_shortcodes_modules_and_widgets |
|
932 | + * generate lists of shortcodes and modules, then verify paths and classes |
|
933 | + * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
934 | + * which runs during the WP 'plugins_loaded' action at priority 7 |
|
935 | + * |
|
936 | + * @access public |
|
937 | + * @return void |
|
938 | + * @throws Exception |
|
939 | + */ |
|
940 | + public function register_shortcodes_modules_and_widgets() |
|
941 | + { |
|
942 | + if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
943 | + try { |
|
944 | + // load, register, and add shortcodes the new way |
|
945 | + $this->loader->getShared( |
|
946 | + 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
947 | + array( |
|
948 | + // and the old way, but we'll put it under control of the new system |
|
949 | + EE_Config::getLegacyShortcodesManager(), |
|
950 | + ) |
|
951 | + ); |
|
952 | + } catch (Exception $exception) { |
|
953 | + new ExceptionStackTraceDisplay($exception); |
|
954 | + } |
|
955 | + } |
|
956 | + do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
957 | + // check for addons using old hook point |
|
958 | + if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
959 | + $this->_incompatible_addon_error(); |
|
960 | + } |
|
961 | + } |
|
962 | + |
|
963 | + |
|
964 | + /** |
|
965 | + * _incompatible_addon_error |
|
966 | + * |
|
967 | + * @access public |
|
968 | + * @return void |
|
969 | + */ |
|
970 | + private function _incompatible_addon_error() |
|
971 | + { |
|
972 | + // get array of classes hooking into here |
|
973 | + $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
974 | + 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
975 | + ); |
|
976 | + if (! empty($class_names)) { |
|
977 | + $msg = __( |
|
978 | + 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
979 | + 'event_espresso' |
|
980 | + ); |
|
981 | + $msg .= '<ul>'; |
|
982 | + foreach ($class_names as $class_name) { |
|
983 | + $msg .= '<li><b>Event Espresso - ' |
|
984 | + . str_replace( |
|
985 | + array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
986 | + '', |
|
987 | + $class_name |
|
988 | + ) . '</b></li>'; |
|
989 | + } |
|
990 | + $msg .= '</ul>'; |
|
991 | + $msg .= __( |
|
992 | + 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
993 | + 'event_espresso' |
|
994 | + ); |
|
995 | + // save list of incompatible addons to wp-options for later use |
|
996 | + add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
997 | + if (is_admin()) { |
|
998 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
999 | + } |
|
1000 | + } |
|
1001 | + } |
|
1002 | + |
|
1003 | + |
|
1004 | + /** |
|
1005 | + * brew_espresso |
|
1006 | + * begins the process of setting hooks for initializing EE in the correct order |
|
1007 | + * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1008 | + * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1009 | + * |
|
1010 | + * @return void |
|
1011 | + */ |
|
1012 | + public function brew_espresso() |
|
1013 | + { |
|
1014 | + do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1015 | + // load some final core systems |
|
1016 | + add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1017 | + add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1018 | + add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1019 | + add_action('init', array($this, 'load_controllers'), 7); |
|
1020 | + add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1021 | + add_action('init', array($this, 'initialize'), 10); |
|
1022 | + add_action('init', array($this, 'initialize_last'), 100); |
|
1023 | + if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1024 | + // pew pew pew |
|
1025 | + $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1026 | + do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1027 | + } |
|
1028 | + do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1029 | + } |
|
1030 | + |
|
1031 | + |
|
1032 | + /** |
|
1033 | + * set_hooks_for_core |
|
1034 | + * |
|
1035 | + * @access public |
|
1036 | + * @return void |
|
1037 | + * @throws EE_Error |
|
1038 | + */ |
|
1039 | + public function set_hooks_for_core() |
|
1040 | + { |
|
1041 | + $this->_deactivate_incompatible_addons(); |
|
1042 | + do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1043 | + $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1044 | + // caps need to be initialized on every request so that capability maps are set. |
|
1045 | + // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1046 | + $this->registry->CAP->init_caps(); |
|
1047 | + } |
|
1048 | + |
|
1049 | + |
|
1050 | + /** |
|
1051 | + * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1052 | + * deactivates any addons considered incompatible with the current version of EE |
|
1053 | + */ |
|
1054 | + private function _deactivate_incompatible_addons() |
|
1055 | + { |
|
1056 | + $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1057 | + if (! empty($incompatible_addons)) { |
|
1058 | + $active_plugins = get_option('active_plugins', array()); |
|
1059 | + foreach ($active_plugins as $active_plugin) { |
|
1060 | + foreach ($incompatible_addons as $incompatible_addon) { |
|
1061 | + if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1062 | + unset($_GET['activate']); |
|
1063 | + espresso_deactivate_plugin($active_plugin); |
|
1064 | + } |
|
1065 | + } |
|
1066 | + } |
|
1067 | + } |
|
1068 | + } |
|
1069 | + |
|
1070 | + |
|
1071 | + /** |
|
1072 | + * perform_activations_upgrades_and_migrations |
|
1073 | + * |
|
1074 | + * @access public |
|
1075 | + * @return void |
|
1076 | + */ |
|
1077 | + public function perform_activations_upgrades_and_migrations() |
|
1078 | + { |
|
1079 | + do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1080 | + } |
|
1081 | + |
|
1082 | + |
|
1083 | + /** |
|
1084 | + * @return void |
|
1085 | + * @throws DomainException |
|
1086 | + */ |
|
1087 | + public function load_CPTs_and_session() |
|
1088 | + { |
|
1089 | + do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1090 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
1091 | + $register_custom_taxonomies = $this->loader->getShared( |
|
1092 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
1093 | + ); |
|
1094 | + $register_custom_taxonomies->registerCustomTaxonomies(); |
|
1095 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
1096 | + $register_custom_post_types = $this->loader->getShared( |
|
1097 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
1098 | + ); |
|
1099 | + $register_custom_post_types->registerCustomPostTypes(); |
|
1100 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
1101 | + $register_custom_taxonomy_terms = $this->loader->getShared( |
|
1102 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
1103 | + ); |
|
1104 | + $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
1105 | + // load legacy Custom Post Types and Taxonomies |
|
1106 | + $this->loader->getShared('EE_Register_CPTs'); |
|
1107 | + do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1108 | + } |
|
1109 | + |
|
1110 | + |
|
1111 | + /** |
|
1112 | + * load_controllers |
|
1113 | + * this is the best place to load any additional controllers that needs access to EE core. |
|
1114 | + * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1115 | + * time |
|
1116 | + * |
|
1117 | + * @access public |
|
1118 | + * @return void |
|
1119 | + */ |
|
1120 | + public function load_controllers() |
|
1121 | + { |
|
1122 | + do_action('AHEE__EE_System__load_controllers__start'); |
|
1123 | + // let's get it started |
|
1124 | + if (! $this->maintenance_mode->level() |
|
1125 | + && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1126 | + ) { |
|
1127 | + do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1128 | + $this->loader->getShared('EE_Front_Controller'); |
|
1129 | + } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1130 | + do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1131 | + $this->loader->getShared('EE_Admin'); |
|
1132 | + } |
|
1133 | + do_action('AHEE__EE_System__load_controllers__complete'); |
|
1134 | + } |
|
1135 | + |
|
1136 | + |
|
1137 | + /** |
|
1138 | + * core_loaded_and_ready |
|
1139 | + * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1140 | + * |
|
1141 | + * @access public |
|
1142 | + * @return void |
|
1143 | + * @throws Exception |
|
1144 | + */ |
|
1145 | + public function core_loaded_and_ready() |
|
1146 | + { |
|
1147 | + if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
1148 | + try { |
|
1149 | + $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1150 | + $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
1151 | + if (function_exists('register_block_type')) { |
|
1152 | + $this->loader->getShared( |
|
1153 | + 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
1154 | + ); |
|
1155 | + } |
|
1156 | + } catch (Exception $exception) { |
|
1157 | + new ExceptionStackTraceDisplay($exception); |
|
1158 | + } |
|
1159 | + } |
|
1160 | + if ($this->request->isAdmin() |
|
1161 | + || $this->request->isEeAjax() |
|
1162 | + || $this->request->isFrontend() |
|
1163 | + ) { |
|
1164 | + $this->loader->getShared('EE_Session'); |
|
1165 | + } |
|
1166 | + // integrate WP_Query with the EE models |
|
1167 | + $this->loader->getShared('EE_CPT_Strategy'); |
|
1168 | + do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1169 | + // load_espresso_template_tags |
|
1170 | + if (($this->request->isFrontend() |
|
1171 | + || $this->request->isIframe() |
|
1172 | + || $this->request->isFeed() |
|
1173 | + || $this->request->isAjax() |
|
1174 | + ) && is_readable(EE_PUBLIC . 'template_tags.php') |
|
1175 | + ) { |
|
1176 | + require_once EE_PUBLIC . 'template_tags.php'; |
|
1177 | + } |
|
1178 | + do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1179 | + } |
|
1180 | + |
|
1181 | + |
|
1182 | + /** |
|
1183 | + * initialize |
|
1184 | + * this is the best place to begin initializing client code |
|
1185 | + * |
|
1186 | + * @access public |
|
1187 | + * @return void |
|
1188 | + */ |
|
1189 | + public function initialize() |
|
1190 | + { |
|
1191 | + do_action('AHEE__EE_System__initialize'); |
|
1192 | + } |
|
1193 | + |
|
1194 | + |
|
1195 | + /** |
|
1196 | + * initialize_last |
|
1197 | + * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1198 | + * initialize has done so |
|
1199 | + * |
|
1200 | + * @access public |
|
1201 | + * @return void |
|
1202 | + */ |
|
1203 | + public function initialize_last() |
|
1204 | + { |
|
1205 | + do_action('AHEE__EE_System__initialize_last'); |
|
1206 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
1207 | + $rewrite_rules = $this->loader->getShared( |
|
1208 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
1209 | + ); |
|
1210 | + $rewrite_rules->flushRewriteRules(); |
|
1211 | + add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1212 | + if (($this->request->isAjax() || $this->request->isAdmin()) |
|
1213 | + && $this->maintenance_mode->models_can_query()) { |
|
1214 | + $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
1215 | + $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
1216 | + } |
|
1217 | + } |
|
1218 | + |
|
1219 | + |
|
1220 | + /** |
|
1221 | + * @return void |
|
1222 | + * @throws EE_Error |
|
1223 | + */ |
|
1224 | + public function addEspressoToolbar() |
|
1225 | + { |
|
1226 | + $this->loader->getShared( |
|
1227 | + 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1228 | + array($this->registry->CAP) |
|
1229 | + ); |
|
1230 | + } |
|
1231 | + |
|
1232 | + |
|
1233 | + /** |
|
1234 | + * do_not_cache |
|
1235 | + * sets no cache headers and defines no cache constants for WP plugins |
|
1236 | + * |
|
1237 | + * @access public |
|
1238 | + * @return void |
|
1239 | + */ |
|
1240 | + public static function do_not_cache() |
|
1241 | + { |
|
1242 | + // set no cache constants |
|
1243 | + if (! defined('DONOTCACHEPAGE')) { |
|
1244 | + define('DONOTCACHEPAGE', true); |
|
1245 | + } |
|
1246 | + if (! defined('DONOTCACHCEOBJECT')) { |
|
1247 | + define('DONOTCACHCEOBJECT', true); |
|
1248 | + } |
|
1249 | + if (! defined('DONOTCACHEDB')) { |
|
1250 | + define('DONOTCACHEDB', true); |
|
1251 | + } |
|
1252 | + // add no cache headers |
|
1253 | + add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1254 | + // plus a little extra for nginx and Google Chrome |
|
1255 | + add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1256 | + // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1257 | + remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1258 | + } |
|
1259 | + |
|
1260 | + |
|
1261 | + /** |
|
1262 | + * extra_nocache_headers |
|
1263 | + * |
|
1264 | + * @access public |
|
1265 | + * @param $headers |
|
1266 | + * @return array |
|
1267 | + */ |
|
1268 | + public static function extra_nocache_headers($headers) |
|
1269 | + { |
|
1270 | + // for NGINX |
|
1271 | + $headers['X-Accel-Expires'] = 0; |
|
1272 | + // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1273 | + $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1274 | + return $headers; |
|
1275 | + } |
|
1276 | + |
|
1277 | + |
|
1278 | + /** |
|
1279 | + * nocache_headers |
|
1280 | + * |
|
1281 | + * @access public |
|
1282 | + * @return void |
|
1283 | + */ |
|
1284 | + public static function nocache_headers() |
|
1285 | + { |
|
1286 | + nocache_headers(); |
|
1287 | + } |
|
1288 | + |
|
1289 | + |
|
1290 | + /** |
|
1291 | + * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1292 | + * never returned with the function. |
|
1293 | + * |
|
1294 | + * @param array $exclude_array any existing pages being excluded are in this array. |
|
1295 | + * @return array |
|
1296 | + */ |
|
1297 | + public function remove_pages_from_wp_list_pages($exclude_array) |
|
1298 | + { |
|
1299 | + return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1300 | + } |
|
1301 | 1301 | } |