Completed
Branch GDPR/user-data-export (1838dd)
by
unknown
53:17 queued 40:13
created
core/domain/values/assets/BrowserAsset.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
      */
94 94
     private function setSource($source)
95 95
     {
96
-        if (! is_string($source)) {
96
+        if ( ! is_string($source)) {
97 97
             throw new InvalidDataTypeException(
98 98
                 '$source',
99 99
                 $source,
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
      */
127 127
     public function setVersion($version = EVENT_ESPRESSO_VERSION)
128 128
     {
129
-        if (! is_string($version)) {
129
+        if ( ! is_string($version)) {
130 130
             throw new InvalidDataTypeException(
131 131
                 '$version',
132 132
                 $version,
Please login to merge, or discard this patch.
Indentation   +132 added lines, -132 removed lines patch added patch discarded remove patch
@@ -16,136 +16,136 @@
 block discarded – undo
16 16
 abstract class BrowserAsset extends Asset
17 17
 {
18 18
 
19
-    /**
20
-     * @var string $source
21
-     */
22
-    private $source;
23
-
24
-    /**
25
-     * @var array $dependencies
26
-     */
27
-    private $dependencies;
28
-
29
-    /**
30
-     * @var string $version
31
-     */
32
-    private $version;
33
-
34
-
35
-    /**
36
-     * Asset constructor.
37
-     *
38
-     * @param string          $type
39
-     * @param string          $handle
40
-     * @param string          $source
41
-     * @param array           $dependencies
42
-     * @param DomainInterface $domain
43
-     * @throws InvalidDataTypeException
44
-     */
45
-    public function __construct($type, $handle, $source, array $dependencies, DomainInterface $domain)
46
-    {
47
-        parent::__construct($type, $handle, $domain);
48
-        $this->setSource($source);
49
-        $this->setDependencies($dependencies);
50
-    }
51
-
52
-
53
-    /**
54
-     * @since $VID:$
55
-     */
56
-    abstract public function enqueueAsset();
57
-
58
-
59
-    /**
60
-     * @return array
61
-     */
62
-    public function dependencies()
63
-    {
64
-        return $this->dependencies;
65
-    }
66
-
67
-
68
-    /**
69
-     * @param array $dependencies
70
-     */
71
-    private function setDependencies(array $dependencies)
72
-    {
73
-        $this->dependencies = $dependencies;
74
-    }
75
-
76
-
77
-    /**
78
-     * @since $VID:$
79
-     * @return bool
80
-     */
81
-    public function hasDependencies()
82
-    {
83
-        return count($this->dependencies) > 0;
84
-    }
85
-
86
-
87
-    /**
88
-     * @return string
89
-     */
90
-    public function source()
91
-    {
92
-        return $this->source;
93
-    }
94
-
95
-
96
-    /**
97
-     * @param string $source
98
-     * @throws InvalidDataTypeException
99
-     */
100
-    private function setSource($source)
101
-    {
102
-        if (! is_string($source)) {
103
-            throw new InvalidDataTypeException(
104
-                '$source',
105
-                $source,
106
-                'string'
107
-            );
108
-        }
109
-        $this->source = $source;
110
-    }
111
-
112
-
113
-    /**
114
-     * @return string
115
-     * @throws InvalidDataTypeException
116
-     */
117
-    public function version()
118
-    {
119
-        // if version is NOT set and this asset was NOT built for distribution,
120
-        // then set the version equal to the EE core plugin version
121
-        if (
122
-            $this->version === null
123
-            && (
124
-                substr($this->source, -8) !== Asset::FILE_EXTENSION_DISTRIBUTION_JS
125
-                || substr($this->source, -9) !== Asset::FILE_EXTENSION_DISTRIBUTION_CSS
126
-            )
127
-        ) {
128
-            $this->setVersion();
129
-        }
130
-        return $this->version;
131
-    }
132
-
133
-
134
-    /**
135
-     * @param string $version
136
-     * @return BrowserAsset
137
-     * @throws InvalidDataTypeException
138
-     */
139
-    public function setVersion($version = EVENT_ESPRESSO_VERSION)
140
-    {
141
-        if (! is_string($version)) {
142
-            throw new InvalidDataTypeException(
143
-                '$version',
144
-                $version,
145
-                'string'
146
-            );
147
-        }
148
-        $this->version = $version;
149
-        return $this;
150
-    }
19
+	/**
20
+	 * @var string $source
21
+	 */
22
+	private $source;
23
+
24
+	/**
25
+	 * @var array $dependencies
26
+	 */
27
+	private $dependencies;
28
+
29
+	/**
30
+	 * @var string $version
31
+	 */
32
+	private $version;
33
+
34
+
35
+	/**
36
+	 * Asset constructor.
37
+	 *
38
+	 * @param string          $type
39
+	 * @param string          $handle
40
+	 * @param string          $source
41
+	 * @param array           $dependencies
42
+	 * @param DomainInterface $domain
43
+	 * @throws InvalidDataTypeException
44
+	 */
45
+	public function __construct($type, $handle, $source, array $dependencies, DomainInterface $domain)
46
+	{
47
+		parent::__construct($type, $handle, $domain);
48
+		$this->setSource($source);
49
+		$this->setDependencies($dependencies);
50
+	}
51
+
52
+
53
+	/**
54
+	 * @since $VID:$
55
+	 */
56
+	abstract public function enqueueAsset();
57
+
58
+
59
+	/**
60
+	 * @return array
61
+	 */
62
+	public function dependencies()
63
+	{
64
+		return $this->dependencies;
65
+	}
66
+
67
+
68
+	/**
69
+	 * @param array $dependencies
70
+	 */
71
+	private function setDependencies(array $dependencies)
72
+	{
73
+		$this->dependencies = $dependencies;
74
+	}
75
+
76
+
77
+	/**
78
+	 * @since $VID:$
79
+	 * @return bool
80
+	 */
81
+	public function hasDependencies()
82
+	{
83
+		return count($this->dependencies) > 0;
84
+	}
85
+
86
+
87
+	/**
88
+	 * @return string
89
+	 */
90
+	public function source()
91
+	{
92
+		return $this->source;
93
+	}
94
+
95
+
96
+	/**
97
+	 * @param string $source
98
+	 * @throws InvalidDataTypeException
99
+	 */
100
+	private function setSource($source)
101
+	{
102
+		if (! is_string($source)) {
103
+			throw new InvalidDataTypeException(
104
+				'$source',
105
+				$source,
106
+				'string'
107
+			);
108
+		}
109
+		$this->source = $source;
110
+	}
111
+
112
+
113
+	/**
114
+	 * @return string
115
+	 * @throws InvalidDataTypeException
116
+	 */
117
+	public function version()
118
+	{
119
+		// if version is NOT set and this asset was NOT built for distribution,
120
+		// then set the version equal to the EE core plugin version
121
+		if (
122
+			$this->version === null
123
+			&& (
124
+				substr($this->source, -8) !== Asset::FILE_EXTENSION_DISTRIBUTION_JS
125
+				|| substr($this->source, -9) !== Asset::FILE_EXTENSION_DISTRIBUTION_CSS
126
+			)
127
+		) {
128
+			$this->setVersion();
129
+		}
130
+		return $this->version;
131
+	}
132
+
133
+
134
+	/**
135
+	 * @param string $version
136
+	 * @return BrowserAsset
137
+	 * @throws InvalidDataTypeException
138
+	 */
139
+	public function setVersion($version = EVENT_ESPRESSO_VERSION)
140
+	{
141
+		if (! is_string($version)) {
142
+			throw new InvalidDataTypeException(
143
+				'$version',
144
+				$version,
145
+				'string'
146
+			);
147
+		}
148
+		$this->version = $version;
149
+		return $this;
150
+	}
151 151
 }
Please login to merge, or discard this patch.
core/domain/values/assets/StylesheetAsset.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -54,7 +54,7 @@
 block discarded – undo
54 54
      */
55 55
     private function setMedia($media)
56 56
     {
57
-        if (! is_string($media)) {
57
+        if ( ! is_string($media)) {
58 58
             throw new InvalidDataTypeException(
59 59
                 '$media',
60 60
                 $media,
Please login to merge, or discard this patch.
Indentation   +48 added lines, -48 removed lines patch added patch discarded remove patch
@@ -16,60 +16,60 @@
 block discarded – undo
16 16
 class StylesheetAsset extends BrowserAsset
17 17
 {
18 18
 
19
-    /**
20
-     * @var string $media
21
-     */
22
-    private $media;
19
+	/**
20
+	 * @var string $media
21
+	 */
22
+	private $media;
23 23
 
24 24
 
25
-    /**
26
-     * CssFile constructor.
27
-     *
28
-     * @param                 $handle
29
-     * @param string          $source
30
-     * @param array           $dependencies
31
-     * @param DomainInterface $domain
32
-     * @param                 $media
33
-     * @throws InvalidDataTypeException
34
-     */
35
-    public function __construct($handle, $source, array $dependencies, DomainInterface $domain, $media = 'all')
36
-    {
37
-        parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain);
38
-        $this->setMedia($media);
39
-    }
25
+	/**
26
+	 * CssFile constructor.
27
+	 *
28
+	 * @param                 $handle
29
+	 * @param string          $source
30
+	 * @param array           $dependencies
31
+	 * @param DomainInterface $domain
32
+	 * @param                 $media
33
+	 * @throws InvalidDataTypeException
34
+	 */
35
+	public function __construct($handle, $source, array $dependencies, DomainInterface $domain, $media = 'all')
36
+	{
37
+		parent::__construct(Asset::TYPE_CSS, $handle, $source, $dependencies, $domain);
38
+		$this->setMedia($media);
39
+	}
40 40
 
41 41
 
42
-    /**
43
-     * @return string
44
-     */
45
-    public function media()
46
-    {
47
-        return $this->media;
48
-    }
42
+	/**
43
+	 * @return string
44
+	 */
45
+	public function media()
46
+	{
47
+		return $this->media;
48
+	}
49 49
 
50 50
 
51
-    /**
52
-     * @param string $media
53
-     * @throws InvalidDataTypeException
54
-     */
55
-    private function setMedia($media)
56
-    {
57
-        if (! is_string($media)) {
58
-            throw new InvalidDataTypeException(
59
-                '$media',
60
-                $media,
61
-                'string'
62
-            );
63
-        }
64
-        $this->media = $media;
65
-    }
51
+	/**
52
+	 * @param string $media
53
+	 * @throws InvalidDataTypeException
54
+	 */
55
+	private function setMedia($media)
56
+	{
57
+		if (! is_string($media)) {
58
+			throw new InvalidDataTypeException(
59
+				'$media',
60
+				$media,
61
+				'string'
62
+			);
63
+		}
64
+		$this->media = $media;
65
+	}
66 66
 
67 67
 
68
-    /**
69
-     * @since $VID:$
70
-     */
71
-    public function enqueueAsset()
72
-    {
73
-        wp_enqueue_style($this->handle());
74
-    }
68
+	/**
69
+	 * @since $VID:$
70
+	 */
71
+	public function enqueueAsset()
72
+	{
73
+		wp_enqueue_style($this->handle());
74
+	}
75 75
 }
Please login to merge, or discard this patch.
core/services/collections/Collection.php 2 patches
Indentation   +467 added lines, -467 removed lines patch added patch discarded remove patch
@@ -21,471 +21,471 @@
 block discarded – undo
21 21
 class Collection extends SplObjectStorage implements CollectionInterface
22 22
 {
23 23
 
24
-    /**
25
-     * a unique string for identifying this collection
26
-     *
27
-     * @type string $collection_identifier
28
-     */
29
-    protected $collection_identifier;
30
-
31
-    /**
32
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
33
-     * this should be set from within the child class constructor
34
-     *
35
-     * @type string $interface
36
-     */
37
-    protected $collection_interface;
38
-
39
-
40
-    /**
41
-     * Collection constructor
42
-     *
43
-     * @param string $collection_interface
44
-     * @throws InvalidInterfaceException
45
-     */
46
-    public function __construct($collection_interface)
47
-    {
48
-        $this->setCollectionInterface($collection_interface);
49
-        $this->setCollectionIdentifier();
50
-    }
51
-
52
-
53
-    /**
54
-     * @return string
55
-     */
56
-    public function collectionIdentifier()
57
-    {
58
-        return $this->collection_identifier;
59
-    }
60
-
61
-
62
-    /**
63
-     * creates a very readable unique 9 character identifier like:  CF2-532-DAC
64
-     * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
65
-     *
66
-     * @return void
67
-     */
68
-    protected function setCollectionIdentifier()
69
-    {
70
-        // hash a few collection details
71
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
72
-        // grab a few characters from the start, middle, and end of the hash
73
-        $id = array();
74
-        for ($x = 0; $x < 19; $x += 9) {
75
-            $id[] = substr($identifier, $x, 3);
76
-        }
77
-        $identifier = basename(str_replace('\\', '/', get_class($this)));
78
-        $identifier .= '-' . strtoupper(implode('-', $id));
79
-        $this->collection_identifier = $identifier;
80
-    }
81
-
82
-
83
-    /**
84
-     * setCollectionInterface
85
-     *
86
-     * @access protected
87
-     * @param  string $collection_interface
88
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
89
-     */
90
-    protected function setCollectionInterface($collection_interface)
91
-    {
92
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
93
-            throw new InvalidInterfaceException($collection_interface);
94
-        }
95
-        $this->collection_interface = $collection_interface;
96
-    }
97
-
98
-
99
-    /**
100
-     * add
101
-     * attaches an object to the Collection
102
-     * and sets any supplied data associated with the current iterator entry
103
-     * by calling EE_Object_Collection::set_identifier()
104
-     *
105
-     * @access public
106
-     * @param        $object
107
-     * @param  mixed $identifier
108
-     * @return bool
109
-     * @throws InvalidEntityException
110
-     * @throws DuplicateCollectionIdentifierException
111
-     */
112
-    public function add($object, $identifier = null)
113
-    {
114
-        if (! $object instanceof $this->collection_interface) {
115
-            throw new InvalidEntityException($object, $this->collection_interface);
116
-        }
117
-        if ($this->contains($object)) {
118
-            throw new DuplicateCollectionIdentifierException($identifier);
119
-        }
120
-        $this->attach($object);
121
-        $this->setIdentifier($object, $identifier);
122
-        return $this->contains($object);
123
-    }
124
-
125
-
126
-    /**
127
-     * setIdentifier
128
-     * Sets the data associated with an object in the Collection
129
-     * if no $identifier is supplied, then the spl_object_hash() is used
130
-     *
131
-     * @access public
132
-     * @param        $object
133
-     * @param  mixed $identifier
134
-     * @return bool
135
-     */
136
-    public function setIdentifier($object, $identifier = null)
137
-    {
138
-        $identifier = ! empty($identifier)
139
-            ? $identifier
140
-            : spl_object_hash($object);
141
-        $this->rewind();
142
-        while ($this->valid()) {
143
-            if ($object === $this->current()) {
144
-                $this->setInfo($identifier);
145
-                $this->rewind();
146
-                return true;
147
-            }
148
-            $this->next();
149
-        }
150
-        return false;
151
-    }
152
-
153
-
154
-    /**
155
-     * get
156
-     * finds and returns an object in the Collection based on the identifier that was set using addObject()
157
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
158
-     *
159
-     * @access public
160
-     * @param mixed $identifier
161
-     * @return mixed
162
-     */
163
-    public function get($identifier)
164
-    {
165
-        $this->rewind();
166
-        while ($this->valid()) {
167
-            if ($identifier === $this->getInfo()) {
168
-                $object = $this->current();
169
-                $this->rewind();
170
-                return $object;
171
-            }
172
-            $this->next();
173
-        }
174
-        return null;
175
-    }
176
-
177
-
178
-    /**
179
-     * has
180
-     * returns TRUE or FALSE
181
-     * depending on whether the object is within the Collection
182
-     * based on the supplied $identifier
183
-     *
184
-     * @access public
185
-     * @param  mixed $identifier
186
-     * @return bool
187
-     */
188
-    public function has($identifier)
189
-    {
190
-        $this->rewind();
191
-        while ($this->valid()) {
192
-            if ($identifier === $this->getInfo()) {
193
-                $this->rewind();
194
-                return true;
195
-            }
196
-            $this->next();
197
-        }
198
-        return false;
199
-    }
200
-
201
-
202
-    /**
203
-     * hasObject
204
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
205
-     *
206
-     * @access public
207
-     * @param $object
208
-     * @return bool
209
-     */
210
-    public function hasObject($object)
211
-    {
212
-        return $this->contains($object);
213
-    }
214
-
215
-
216
-    /**
217
-     * hasObjects
218
-     * returns true if there are objects within the Collection, and false if it is empty
219
-     *
220
-     * @access public
221
-     * @return bool
222
-     */
223
-    public function hasObjects()
224
-    {
225
-        return $this->count() !== 0;
226
-    }
227
-
228
-
229
-    /**
230
-     * isEmpty
231
-     * returns true if there are no objects within the Collection, and false if there are
232
-     *
233
-     * @access public
234
-     * @return bool
235
-     */
236
-    public function isEmpty()
237
-    {
238
-        return $this->count() === 0;
239
-    }
240
-
241
-
242
-    /**
243
-     * remove
244
-     * detaches an object from the Collection
245
-     *
246
-     * @access public
247
-     * @param $object
248
-     * @return bool
249
-     */
250
-    public function remove($object)
251
-    {
252
-        $this->detach($object);
253
-        return true;
254
-    }
255
-
256
-
257
-    /**
258
-     * setCurrent
259
-     * advances pointer to the object whose identifier matches that which was provided
260
-     *
261
-     * @access public
262
-     * @param mixed $identifier
263
-     * @return boolean
264
-     */
265
-    public function setCurrent($identifier)
266
-    {
267
-        $this->rewind();
268
-        while ($this->valid()) {
269
-            if ($identifier === $this->getInfo()) {
270
-                return true;
271
-            }
272
-            $this->next();
273
-        }
274
-        return false;
275
-    }
276
-
277
-
278
-    /**
279
-     * setCurrentUsingObject
280
-     * advances pointer to the provided object
281
-     *
282
-     * @access public
283
-     * @param $object
284
-     * @return boolean
285
-     */
286
-    public function setCurrentUsingObject($object)
287
-    {
288
-        $this->rewind();
289
-        while ($this->valid()) {
290
-            if ($this->current() === $object) {
291
-                return true;
292
-            }
293
-            $this->next();
294
-        }
295
-        return false;
296
-    }
297
-
298
-
299
-    /**
300
-     * Returns the object occupying the index before the current object,
301
-     * unless this is already the first object, in which case it just returns the first object
302
-     *
303
-     * @return mixed
304
-     */
305
-    public function previous()
306
-    {
307
-        $index = $this->indexOf($this->current());
308
-        if ($index === 0) {
309
-            return $this->current();
310
-        }
311
-        $index--;
312
-        return $this->objectAtIndex($index);
313
-    }
314
-
315
-
316
-    /**
317
-     * Returns the index of a given object, or false if not found
318
-     *
319
-     * @see http://stackoverflow.com/a/8736013
320
-     * @param $object
321
-     * @return boolean|int|string
322
-     */
323
-    public function indexOf($object)
324
-    {
325
-        if (! $this->contains($object)) {
326
-            return false;
327
-        }
328
-        foreach ($this as $index => $obj) {
329
-            if ($obj === $object) {
330
-                return $index;
331
-            }
332
-        }
333
-        return false;
334
-    }
335
-
336
-
337
-    /**
338
-     * Returns the object at the given index
339
-     *
340
-     * @see http://stackoverflow.com/a/8736013
341
-     * @param int $index
342
-     * @return mixed
343
-     */
344
-    public function objectAtIndex($index)
345
-    {
346
-        $iterator = new LimitIterator($this, $index, 1);
347
-        $iterator->rewind();
348
-        return $iterator->current();
349
-    }
350
-
351
-
352
-    /**
353
-     * Returns the sequence of objects as specified by the offset and length
354
-     *
355
-     * @see http://stackoverflow.com/a/8736013
356
-     * @param int $offset
357
-     * @param int $length
358
-     * @return array
359
-     */
360
-    public function slice($offset, $length)
361
-    {
362
-        $slice = array();
363
-        $iterator = new LimitIterator($this, $offset, $length);
364
-        foreach ($iterator as $object) {
365
-            $slice[] = $object;
366
-        }
367
-        return $slice;
368
-    }
369
-
370
-
371
-    /**
372
-     * Inserts an object at a certain point
373
-     *
374
-     * @see http://stackoverflow.com/a/8736013
375
-     * @param mixed $object A single object
376
-     * @param int   $index
377
-     * @param mixed $identifier
378
-     * @return bool
379
-     * @throws DuplicateCollectionIdentifierException
380
-     * @throws InvalidEntityException
381
-     */
382
-    public function insertObjectAt($object, $index, $identifier = null)
383
-    {
384
-        // check to ensure that objects don't already exist in the collection
385
-        if ($this->has($identifier)) {
386
-            throw new DuplicateCollectionIdentifierException($identifier);
387
-        }
388
-        // detach any objects at or past this index
389
-        $remaining_objects = array();
390
-        if ($index < $this->count()) {
391
-            $remaining_objects = $this->slice($index, $this->count() - $index);
392
-            foreach ($remaining_objects as $key => $remaining_object) {
393
-                // we need to grab the identifiers for each object and use them as keys
394
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
395
-                // and then remove the object from the current tracking array
396
-                unset($remaining_objects[ $key ]);
397
-                // and then remove it from the Collection
398
-                $this->detach($remaining_object);
399
-            }
400
-        }
401
-        // add the new object we're splicing in
402
-        $this->add($object, $identifier);
403
-        // attach the objects we previously detached
404
-        foreach ($remaining_objects as $key => $remaining_object) {
405
-            $this->add($remaining_object, $key);
406
-        }
407
-        return $this->contains($object);
408
-    }
409
-
410
-
411
-    /**
412
-     * Inserts an object (or an array of objects) at a certain point
413
-     *
414
-     * @see http://stackoverflow.com/a/8736013
415
-     * @param mixed $objects A single object or an array of objects
416
-     * @param int   $index
417
-     */
418
-    public function insertAt($objects, $index)
419
-    {
420
-        if (! is_array($objects)) {
421
-            $objects = array($objects);
422
-        }
423
-        // check to ensure that objects don't already exist in the collection
424
-        foreach ($objects as $key => $object) {
425
-            if ($this->contains($object)) {
426
-                unset($objects[ $key ]);
427
-            }
428
-        }
429
-        // do we have any objects left?
430
-        if (! $objects) {
431
-            return;
432
-        }
433
-        // detach any objects at or past this index
434
-        $remaining = array();
435
-        if ($index < $this->count()) {
436
-            $remaining = $this->slice($index, $this->count() - $index);
437
-            foreach ($remaining as $object) {
438
-                $this->detach($object);
439
-            }
440
-        }
441
-        // add the new objects we're splicing in
442
-        foreach ($objects as $object) {
443
-            $this->attach($object);
444
-        }
445
-        // attach the objects we previously detached
446
-        foreach ($remaining as $object) {
447
-            $this->attach($object);
448
-        }
449
-    }
450
-
451
-
452
-    /**
453
-     * Removes the object at the given index
454
-     *
455
-     * @see http://stackoverflow.com/a/8736013
456
-     * @param int $index
457
-     */
458
-    public function removeAt($index)
459
-    {
460
-        $this->detach($this->objectAtIndex($index));
461
-    }
462
-
463
-
464
-    /**
465
-     * detaches ALL objects from the Collection
466
-     */
467
-    public function detachAll()
468
-    {
469
-        $this->rewind();
470
-        while ($this->valid()) {
471
-            $object = $this->current();
472
-            $this->next();
473
-            $this->detach($object);
474
-        }
475
-    }
476
-
477
-
478
-    /**
479
-     * unsets and detaches ALL objects from the Collection
480
-     */
481
-    public function trashAndDetachAll()
482
-    {
483
-        $this->rewind();
484
-        while ($this->valid()) {
485
-            $object = $this->current();
486
-            $this->next();
487
-            $this->detach($object);
488
-            unset($object);
489
-        }
490
-    }
24
+	/**
25
+	 * a unique string for identifying this collection
26
+	 *
27
+	 * @type string $collection_identifier
28
+	 */
29
+	protected $collection_identifier;
30
+
31
+	/**
32
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
33
+	 * this should be set from within the child class constructor
34
+	 *
35
+	 * @type string $interface
36
+	 */
37
+	protected $collection_interface;
38
+
39
+
40
+	/**
41
+	 * Collection constructor
42
+	 *
43
+	 * @param string $collection_interface
44
+	 * @throws InvalidInterfaceException
45
+	 */
46
+	public function __construct($collection_interface)
47
+	{
48
+		$this->setCollectionInterface($collection_interface);
49
+		$this->setCollectionIdentifier();
50
+	}
51
+
52
+
53
+	/**
54
+	 * @return string
55
+	 */
56
+	public function collectionIdentifier()
57
+	{
58
+		return $this->collection_identifier;
59
+	}
60
+
61
+
62
+	/**
63
+	 * creates a very readable unique 9 character identifier like:  CF2-532-DAC
64
+	 * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
65
+	 *
66
+	 * @return void
67
+	 */
68
+	protected function setCollectionIdentifier()
69
+	{
70
+		// hash a few collection details
71
+		$identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
72
+		// grab a few characters from the start, middle, and end of the hash
73
+		$id = array();
74
+		for ($x = 0; $x < 19; $x += 9) {
75
+			$id[] = substr($identifier, $x, 3);
76
+		}
77
+		$identifier = basename(str_replace('\\', '/', get_class($this)));
78
+		$identifier .= '-' . strtoupper(implode('-', $id));
79
+		$this->collection_identifier = $identifier;
80
+	}
81
+
82
+
83
+	/**
84
+	 * setCollectionInterface
85
+	 *
86
+	 * @access protected
87
+	 * @param  string $collection_interface
88
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
89
+	 */
90
+	protected function setCollectionInterface($collection_interface)
91
+	{
92
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
93
+			throw new InvalidInterfaceException($collection_interface);
94
+		}
95
+		$this->collection_interface = $collection_interface;
96
+	}
97
+
98
+
99
+	/**
100
+	 * add
101
+	 * attaches an object to the Collection
102
+	 * and sets any supplied data associated with the current iterator entry
103
+	 * by calling EE_Object_Collection::set_identifier()
104
+	 *
105
+	 * @access public
106
+	 * @param        $object
107
+	 * @param  mixed $identifier
108
+	 * @return bool
109
+	 * @throws InvalidEntityException
110
+	 * @throws DuplicateCollectionIdentifierException
111
+	 */
112
+	public function add($object, $identifier = null)
113
+	{
114
+		if (! $object instanceof $this->collection_interface) {
115
+			throw new InvalidEntityException($object, $this->collection_interface);
116
+		}
117
+		if ($this->contains($object)) {
118
+			throw new DuplicateCollectionIdentifierException($identifier);
119
+		}
120
+		$this->attach($object);
121
+		$this->setIdentifier($object, $identifier);
122
+		return $this->contains($object);
123
+	}
124
+
125
+
126
+	/**
127
+	 * setIdentifier
128
+	 * Sets the data associated with an object in the Collection
129
+	 * if no $identifier is supplied, then the spl_object_hash() is used
130
+	 *
131
+	 * @access public
132
+	 * @param        $object
133
+	 * @param  mixed $identifier
134
+	 * @return bool
135
+	 */
136
+	public function setIdentifier($object, $identifier = null)
137
+	{
138
+		$identifier = ! empty($identifier)
139
+			? $identifier
140
+			: spl_object_hash($object);
141
+		$this->rewind();
142
+		while ($this->valid()) {
143
+			if ($object === $this->current()) {
144
+				$this->setInfo($identifier);
145
+				$this->rewind();
146
+				return true;
147
+			}
148
+			$this->next();
149
+		}
150
+		return false;
151
+	}
152
+
153
+
154
+	/**
155
+	 * get
156
+	 * finds and returns an object in the Collection based on the identifier that was set using addObject()
157
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
158
+	 *
159
+	 * @access public
160
+	 * @param mixed $identifier
161
+	 * @return mixed
162
+	 */
163
+	public function get($identifier)
164
+	{
165
+		$this->rewind();
166
+		while ($this->valid()) {
167
+			if ($identifier === $this->getInfo()) {
168
+				$object = $this->current();
169
+				$this->rewind();
170
+				return $object;
171
+			}
172
+			$this->next();
173
+		}
174
+		return null;
175
+	}
176
+
177
+
178
+	/**
179
+	 * has
180
+	 * returns TRUE or FALSE
181
+	 * depending on whether the object is within the Collection
182
+	 * based on the supplied $identifier
183
+	 *
184
+	 * @access public
185
+	 * @param  mixed $identifier
186
+	 * @return bool
187
+	 */
188
+	public function has($identifier)
189
+	{
190
+		$this->rewind();
191
+		while ($this->valid()) {
192
+			if ($identifier === $this->getInfo()) {
193
+				$this->rewind();
194
+				return true;
195
+			}
196
+			$this->next();
197
+		}
198
+		return false;
199
+	}
200
+
201
+
202
+	/**
203
+	 * hasObject
204
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
205
+	 *
206
+	 * @access public
207
+	 * @param $object
208
+	 * @return bool
209
+	 */
210
+	public function hasObject($object)
211
+	{
212
+		return $this->contains($object);
213
+	}
214
+
215
+
216
+	/**
217
+	 * hasObjects
218
+	 * returns true if there are objects within the Collection, and false if it is empty
219
+	 *
220
+	 * @access public
221
+	 * @return bool
222
+	 */
223
+	public function hasObjects()
224
+	{
225
+		return $this->count() !== 0;
226
+	}
227
+
228
+
229
+	/**
230
+	 * isEmpty
231
+	 * returns true if there are no objects within the Collection, and false if there are
232
+	 *
233
+	 * @access public
234
+	 * @return bool
235
+	 */
236
+	public function isEmpty()
237
+	{
238
+		return $this->count() === 0;
239
+	}
240
+
241
+
242
+	/**
243
+	 * remove
244
+	 * detaches an object from the Collection
245
+	 *
246
+	 * @access public
247
+	 * @param $object
248
+	 * @return bool
249
+	 */
250
+	public function remove($object)
251
+	{
252
+		$this->detach($object);
253
+		return true;
254
+	}
255
+
256
+
257
+	/**
258
+	 * setCurrent
259
+	 * advances pointer to the object whose identifier matches that which was provided
260
+	 *
261
+	 * @access public
262
+	 * @param mixed $identifier
263
+	 * @return boolean
264
+	 */
265
+	public function setCurrent($identifier)
266
+	{
267
+		$this->rewind();
268
+		while ($this->valid()) {
269
+			if ($identifier === $this->getInfo()) {
270
+				return true;
271
+			}
272
+			$this->next();
273
+		}
274
+		return false;
275
+	}
276
+
277
+
278
+	/**
279
+	 * setCurrentUsingObject
280
+	 * advances pointer to the provided object
281
+	 *
282
+	 * @access public
283
+	 * @param $object
284
+	 * @return boolean
285
+	 */
286
+	public function setCurrentUsingObject($object)
287
+	{
288
+		$this->rewind();
289
+		while ($this->valid()) {
290
+			if ($this->current() === $object) {
291
+				return true;
292
+			}
293
+			$this->next();
294
+		}
295
+		return false;
296
+	}
297
+
298
+
299
+	/**
300
+	 * Returns the object occupying the index before the current object,
301
+	 * unless this is already the first object, in which case it just returns the first object
302
+	 *
303
+	 * @return mixed
304
+	 */
305
+	public function previous()
306
+	{
307
+		$index = $this->indexOf($this->current());
308
+		if ($index === 0) {
309
+			return $this->current();
310
+		}
311
+		$index--;
312
+		return $this->objectAtIndex($index);
313
+	}
314
+
315
+
316
+	/**
317
+	 * Returns the index of a given object, or false if not found
318
+	 *
319
+	 * @see http://stackoverflow.com/a/8736013
320
+	 * @param $object
321
+	 * @return boolean|int|string
322
+	 */
323
+	public function indexOf($object)
324
+	{
325
+		if (! $this->contains($object)) {
326
+			return false;
327
+		}
328
+		foreach ($this as $index => $obj) {
329
+			if ($obj === $object) {
330
+				return $index;
331
+			}
332
+		}
333
+		return false;
334
+	}
335
+
336
+
337
+	/**
338
+	 * Returns the object at the given index
339
+	 *
340
+	 * @see http://stackoverflow.com/a/8736013
341
+	 * @param int $index
342
+	 * @return mixed
343
+	 */
344
+	public function objectAtIndex($index)
345
+	{
346
+		$iterator = new LimitIterator($this, $index, 1);
347
+		$iterator->rewind();
348
+		return $iterator->current();
349
+	}
350
+
351
+
352
+	/**
353
+	 * Returns the sequence of objects as specified by the offset and length
354
+	 *
355
+	 * @see http://stackoverflow.com/a/8736013
356
+	 * @param int $offset
357
+	 * @param int $length
358
+	 * @return array
359
+	 */
360
+	public function slice($offset, $length)
361
+	{
362
+		$slice = array();
363
+		$iterator = new LimitIterator($this, $offset, $length);
364
+		foreach ($iterator as $object) {
365
+			$slice[] = $object;
366
+		}
367
+		return $slice;
368
+	}
369
+
370
+
371
+	/**
372
+	 * Inserts an object at a certain point
373
+	 *
374
+	 * @see http://stackoverflow.com/a/8736013
375
+	 * @param mixed $object A single object
376
+	 * @param int   $index
377
+	 * @param mixed $identifier
378
+	 * @return bool
379
+	 * @throws DuplicateCollectionIdentifierException
380
+	 * @throws InvalidEntityException
381
+	 */
382
+	public function insertObjectAt($object, $index, $identifier = null)
383
+	{
384
+		// check to ensure that objects don't already exist in the collection
385
+		if ($this->has($identifier)) {
386
+			throw new DuplicateCollectionIdentifierException($identifier);
387
+		}
388
+		// detach any objects at or past this index
389
+		$remaining_objects = array();
390
+		if ($index < $this->count()) {
391
+			$remaining_objects = $this->slice($index, $this->count() - $index);
392
+			foreach ($remaining_objects as $key => $remaining_object) {
393
+				// we need to grab the identifiers for each object and use them as keys
394
+				$remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
395
+				// and then remove the object from the current tracking array
396
+				unset($remaining_objects[ $key ]);
397
+				// and then remove it from the Collection
398
+				$this->detach($remaining_object);
399
+			}
400
+		}
401
+		// add the new object we're splicing in
402
+		$this->add($object, $identifier);
403
+		// attach the objects we previously detached
404
+		foreach ($remaining_objects as $key => $remaining_object) {
405
+			$this->add($remaining_object, $key);
406
+		}
407
+		return $this->contains($object);
408
+	}
409
+
410
+
411
+	/**
412
+	 * Inserts an object (or an array of objects) at a certain point
413
+	 *
414
+	 * @see http://stackoverflow.com/a/8736013
415
+	 * @param mixed $objects A single object or an array of objects
416
+	 * @param int   $index
417
+	 */
418
+	public function insertAt($objects, $index)
419
+	{
420
+		if (! is_array($objects)) {
421
+			$objects = array($objects);
422
+		}
423
+		// check to ensure that objects don't already exist in the collection
424
+		foreach ($objects as $key => $object) {
425
+			if ($this->contains($object)) {
426
+				unset($objects[ $key ]);
427
+			}
428
+		}
429
+		// do we have any objects left?
430
+		if (! $objects) {
431
+			return;
432
+		}
433
+		// detach any objects at or past this index
434
+		$remaining = array();
435
+		if ($index < $this->count()) {
436
+			$remaining = $this->slice($index, $this->count() - $index);
437
+			foreach ($remaining as $object) {
438
+				$this->detach($object);
439
+			}
440
+		}
441
+		// add the new objects we're splicing in
442
+		foreach ($objects as $object) {
443
+			$this->attach($object);
444
+		}
445
+		// attach the objects we previously detached
446
+		foreach ($remaining as $object) {
447
+			$this->attach($object);
448
+		}
449
+	}
450
+
451
+
452
+	/**
453
+	 * Removes the object at the given index
454
+	 *
455
+	 * @see http://stackoverflow.com/a/8736013
456
+	 * @param int $index
457
+	 */
458
+	public function removeAt($index)
459
+	{
460
+		$this->detach($this->objectAtIndex($index));
461
+	}
462
+
463
+
464
+	/**
465
+	 * detaches ALL objects from the Collection
466
+	 */
467
+	public function detachAll()
468
+	{
469
+		$this->rewind();
470
+		while ($this->valid()) {
471
+			$object = $this->current();
472
+			$this->next();
473
+			$this->detach($object);
474
+		}
475
+	}
476
+
477
+
478
+	/**
479
+	 * unsets and detaches ALL objects from the Collection
480
+	 */
481
+	public function trashAndDetachAll()
482
+	{
483
+		$this->rewind();
484
+		while ($this->valid()) {
485
+			$object = $this->current();
486
+			$this->next();
487
+			$this->detach($object);
488
+			unset($object);
489
+		}
490
+	}
491 491
 }
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -68,14 +68,14 @@  discard block
 block discarded – undo
68 68
     protected function setCollectionIdentifier()
69 69
     {
70 70
         // hash a few collection details
71
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
71
+        $identifier = md5(spl_object_hash($this).$this->collection_interface.time());
72 72
         // grab a few characters from the start, middle, and end of the hash
73 73
         $id = array();
74 74
         for ($x = 0; $x < 19; $x += 9) {
75 75
             $id[] = substr($identifier, $x, 3);
76 76
         }
77 77
         $identifier = basename(str_replace('\\', '/', get_class($this)));
78
-        $identifier .= '-' . strtoupper(implode('-', $id));
78
+        $identifier .= '-'.strtoupper(implode('-', $id));
79 79
         $this->collection_identifier = $identifier;
80 80
     }
81 81
 
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
      */
90 90
     protected function setCollectionInterface($collection_interface)
91 91
     {
92
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
92
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
93 93
             throw new InvalidInterfaceException($collection_interface);
94 94
         }
95 95
         $this->collection_interface = $collection_interface;
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
      */
112 112
     public function add($object, $identifier = null)
113 113
     {
114
-        if (! $object instanceof $this->collection_interface) {
114
+        if ( ! $object instanceof $this->collection_interface) {
115 115
             throw new InvalidEntityException($object, $this->collection_interface);
116 116
         }
117 117
         if ($this->contains($object)) {
@@ -322,7 +322,7 @@  discard block
 block discarded – undo
322 322
      */
323 323
     public function indexOf($object)
324 324
     {
325
-        if (! $this->contains($object)) {
325
+        if ( ! $this->contains($object)) {
326 326
             return false;
327 327
         }
328 328
         foreach ($this as $index => $obj) {
@@ -391,9 +391,9 @@  discard block
 block discarded – undo
391 391
             $remaining_objects = $this->slice($index, $this->count() - $index);
392 392
             foreach ($remaining_objects as $key => $remaining_object) {
393 393
                 // we need to grab the identifiers for each object and use them as keys
394
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
394
+                $remaining_objects[$remaining_object->getInfo()] = $remaining_object;
395 395
                 // and then remove the object from the current tracking array
396
-                unset($remaining_objects[ $key ]);
396
+                unset($remaining_objects[$key]);
397 397
                 // and then remove it from the Collection
398 398
                 $this->detach($remaining_object);
399 399
             }
@@ -417,17 +417,17 @@  discard block
 block discarded – undo
417 417
      */
418 418
     public function insertAt($objects, $index)
419 419
     {
420
-        if (! is_array($objects)) {
420
+        if ( ! is_array($objects)) {
421 421
             $objects = array($objects);
422 422
         }
423 423
         // check to ensure that objects don't already exist in the collection
424 424
         foreach ($objects as $key => $object) {
425 425
             if ($this->contains($object)) {
426
-                unset($objects[ $key ]);
426
+                unset($objects[$key]);
427 427
             }
428 428
         }
429 429
         // do we have any objects left?
430
-        if (! $objects) {
430
+        if ( ! $objects) {
431 431
             return;
432 432
         }
433 433
         // detach any objects at or past this index
Please login to merge, or discard this patch.
core/services/assets/AssetRegistrationException.php 1 patch
Indentation   +20 added lines, -20 removed lines patch added patch discarded remove patch
@@ -16,24 +16,24 @@
 block discarded – undo
16 16
  */
17 17
 class AssetRegistrationException extends RuntimeException
18 18
 {
19
-    /**
20
-     * @param                $script_handle
21
-     * @param string         $message
22
-     * @param int            $code
23
-     * @param Exception|null $previous
24
-     */
25
-    public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
26
-    {
27
-        if (empty($message)) {
28
-            $message = sprintf(
29
-                esc_html_x(
30
-                    'The "%1$s" script could not be registered with WordPress core.',
31
-                    'The "script-handle" script could not be registered with WordPress core.',
32
-                    'event_espresso'
33
-                ),
34
-                $script_handle
35
-            );
36
-        }
37
-        parent::__construct($message, $code, $previous);
38
-    }
19
+	/**
20
+	 * @param                $script_handle
21
+	 * @param string         $message
22
+	 * @param int            $code
23
+	 * @param Exception|null $previous
24
+	 */
25
+	public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
26
+	{
27
+		if (empty($message)) {
28
+			$message = sprintf(
29
+				esc_html_x(
30
+					'The "%1$s" script could not be registered with WordPress core.',
31
+					'The "script-handle" script could not be registered with WordPress core.',
32
+					'event_espresso'
33
+				),
34
+				$script_handle
35
+			);
36
+		}
37
+		parent::__construct($message, $code, $previous);
38
+	}
39 39
 }
40 40
\ No newline at end of file
Please login to merge, or discard this patch.
core/EE_System.core.php 2 patches
Spacing   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -143,7 +143,7 @@  discard block
 block discarded – undo
143 143
         EE_Maintenance_Mode $maintenance_mode = null
144 144
     ) {
145 145
         // check if class object is instantiated
146
-        if (! self::$_instance instanceof EE_System) {
146
+        if ( ! self::$_instance instanceof EE_System) {
147 147
             self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
148 148
         }
149 149
         return self::$_instance;
@@ -260,7 +260,7 @@  discard block
 block discarded – undo
260 260
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
261 261
         add_action(
262 262
             'AHEE__EE_Capabilities__init_caps__before_initialization',
263
-            function () {
263
+            function() {
264 264
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
265 265
             }
266 266
         );
@@ -301,7 +301,7 @@  discard block
 block discarded – undo
301 301
     {
302 302
         // set autoloaders for all of the classes implementing EEI_Plugin_API
303 303
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
304
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
304
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
305 305
         $this->loader->getShared('EE_Request_Handler');
306 306
     }
307 307
 
@@ -321,14 +321,14 @@  discard block
 block discarded – undo
321 321
         $load_callback,
322 322
         $plugin_file_constant
323 323
     ) {
324
-        if (! defined($version_constant)) {
324
+        if ( ! defined($version_constant)) {
325 325
             return;
326 326
         }
327 327
         $addon_version = constant($version_constant);
328 328
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
329 329
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
330
-            if (! function_exists('deactivate_plugins')) {
331
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
330
+            if ( ! function_exists('deactivate_plugins')) {
331
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
332 332
             }
333 333
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
334 334
             unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
@@ -342,7 +342,7 @@  discard block
 block discarded – undo
342 342
                     $min_version_required
343 343
                 ),
344 344
                 __FILE__,
345
-                __FUNCTION__ . "({$addon_name})",
345
+                __FUNCTION__."({$addon_name})",
346 346
                 __LINE__
347 347
             );
348 348
             EE_Error::get_notices(false, true);
@@ -392,7 +392,7 @@  discard block
 block discarded – undo
392 392
                 true
393 393
             )
394 394
         ) {
395
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
395
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
396 396
         }
397 397
         do_action('AHEE__EE_System__load_espresso_addons__complete');
398 398
     }
@@ -494,11 +494,11 @@  discard block
 block discarded – undo
494 494
     private function fix_espresso_db_upgrade_option($espresso_db_update = null)
495 495
     {
496 496
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
497
-        if (! $espresso_db_update) {
497
+        if ( ! $espresso_db_update) {
498 498
             $espresso_db_update = get_option('espresso_db_update');
499 499
         }
500 500
         // check that option is an array
501
-        if (! is_array($espresso_db_update)) {
501
+        if ( ! is_array($espresso_db_update)) {
502 502
             // if option is FALSE, then it never existed
503 503
             if ($espresso_db_update === false) {
504 504
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -518,10 +518,10 @@  discard block
 block discarded – undo
518 518
                     // so it must be numerically-indexed, where values are versions installed...
519 519
                     // fix it!
520 520
                     $version_string = $should_be_array;
521
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
521
+                    $corrected_db_update[$version_string] = array('unknown-date');
522 522
                 } else {
523 523
                     // ok it checks out
524
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
524
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
525 525
                 }
526 526
             }
527 527
             $espresso_db_update = $corrected_db_update;
@@ -604,13 +604,13 @@  discard block
 block discarded – undo
604 604
      */
605 605
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
606 606
     {
607
-        if (! $version_history) {
607
+        if ( ! $version_history) {
608 608
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
609 609
         }
610 610
         if ($current_version_to_add === null) {
611 611
             $current_version_to_add = espresso_version();
612 612
         }
613
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
613
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
614 614
         // re-save
615 615
         return update_option('espresso_db_update', $version_history);
616 616
     }
@@ -700,7 +700,7 @@  discard block
 block discarded – undo
700 700
         if ($activation_history_for_addon) {
701 701
             // it exists, so this isn't a completely new install
702 702
             // check if this version already in that list of previously installed versions
703
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
703
+            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
704 704
                 // it a version we haven't seen before
705 705
                 if ($version_is_higher === 1) {
706 706
                     $req_type = EE_System::req_type_upgrade;
@@ -778,7 +778,7 @@  discard block
 block discarded – undo
778 778
             foreach ($activation_history as $version => $times_activated) {
779 779
                 // check there is a record of when this version was activated. Otherwise,
780 780
                 // mark it as unknown
781
-                if (! $times_activated) {
781
+                if ( ! $times_activated) {
782 782
                     $times_activated = array('unknown-date');
783 783
                 }
784 784
                 if (is_string($times_activated)) {
@@ -809,7 +809,7 @@  discard block
 block discarded – undo
809 809
     {
810 810
         $notices = EE_Error::get_notices(false);
811 811
         // if current user is an admin and it's not an ajax or rest request
812
-        if (! isset($notices['errors'])
812
+        if ( ! isset($notices['errors'])
813 813
             && $this->request->isAdmin()
814 814
             && apply_filters(
815 815
                 'FHEE__EE_System__redirect_to_about_ee__do_redirect',
@@ -878,7 +878,7 @@  discard block
 block discarded – undo
878 878
     private function _parse_model_names()
879 879
     {
880 880
         // get all the files in the EE_MODELS folder that end in .model.php
881
-        $models = glob(EE_MODELS . '*.model.php');
881
+        $models = glob(EE_MODELS.'*.model.php');
882 882
         $model_names = array();
883 883
         $non_abstract_db_models = array();
884 884
         foreach ($models as $model) {
@@ -887,9 +887,9 @@  discard block
 block discarded – undo
887 887
             $short_name = str_replace('EEM_', '', $classname);
888 888
             $reflectionClass = new ReflectionClass($classname);
889 889
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
890
-                $non_abstract_db_models[ $short_name ] = $classname;
890
+                $non_abstract_db_models[$short_name] = $classname;
891 891
             }
892
-            $model_names[ $short_name ] = $classname;
892
+            $model_names[$short_name] = $classname;
893 893
         }
894 894
         $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
895 895
         $this->registry->non_abstract_db_models = apply_filters(
@@ -924,7 +924,7 @@  discard block
 block discarded – undo
924 924
             )
925 925
         );
926 926
         if ($domain->isCaffeinated()) {
927
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
927
+            require_once EE_CAFF_PATH.'brewing_regular.php';
928 928
         }
929 929
     }
930 930
 
@@ -975,7 +975,7 @@  discard block
 block discarded – undo
975 975
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
976 976
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
977 977
         );
978
-        if (! empty($class_names)) {
978
+        if ( ! empty($class_names)) {
979 979
             $msg = __(
980 980
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
981 981
                 'event_espresso'
@@ -987,7 +987,7 @@  discard block
 block discarded – undo
987 987
                             array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
988 988
                             '',
989 989
                             $class_name
990
-                        ) . '</b></li>';
990
+                        ).'</b></li>';
991 991
             }
992 992
             $msg .= '</ul>';
993 993
             $msg .= __(
@@ -1056,7 +1056,7 @@  discard block
 block discarded – undo
1056 1056
     private function _deactivate_incompatible_addons()
1057 1057
     {
1058 1058
         $incompatible_addons = get_option('ee_incompatible_addons', array());
1059
-        if (! empty($incompatible_addons)) {
1059
+        if ( ! empty($incompatible_addons)) {
1060 1060
             $active_plugins = get_option('active_plugins', array());
1061 1061
             foreach ($active_plugins as $active_plugin) {
1062 1062
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1123,7 +1123,7 @@  discard block
 block discarded – undo
1123 1123
     {
1124 1124
         do_action('AHEE__EE_System__load_controllers__start');
1125 1125
         // let's get it started
1126
-        if (! $this->maintenance_mode->level()
1126
+        if ( ! $this->maintenance_mode->level()
1127 1127
             && ($this->request->isFrontend() || $this->request->isFrontAjax())
1128 1128
         ) {
1129 1129
             do_action('AHEE__EE_System__load_controllers__load_front_controllers');
@@ -1162,10 +1162,10 @@  discard block
 block discarded – undo
1162 1162
         }
1163 1163
         do_action('AHEE__EE_System__core_loaded_and_ready');
1164 1164
         // load_espresso_template_tags
1165
-        if (is_readable(EE_PUBLIC . 'template_tags.php')
1165
+        if (is_readable(EE_PUBLIC.'template_tags.php')
1166 1166
             && ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed())
1167 1167
         ) {
1168
-            require_once EE_PUBLIC . 'template_tags.php';
1168
+            require_once EE_PUBLIC.'template_tags.php';
1169 1169
         }
1170 1170
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
1171 1171
     }
@@ -1227,13 +1227,13 @@  discard block
 block discarded – undo
1227 1227
     public static function do_not_cache()
1228 1228
     {
1229 1229
         // set no cache constants
1230
-        if (! defined('DONOTCACHEPAGE')) {
1230
+        if ( ! defined('DONOTCACHEPAGE')) {
1231 1231
             define('DONOTCACHEPAGE', true);
1232 1232
         }
1233
-        if (! defined('DONOTCACHCEOBJECT')) {
1233
+        if ( ! defined('DONOTCACHCEOBJECT')) {
1234 1234
             define('DONOTCACHCEOBJECT', true);
1235 1235
         }
1236
-        if (! defined('DONOTCACHEDB')) {
1236
+        if ( ! defined('DONOTCACHEDB')) {
1237 1237
             define('DONOTCACHEDB', true);
1238 1238
         }
1239 1239
         // add no cache headers
Please login to merge, or discard this patch.
Indentation   +1266 added lines, -1266 removed lines patch added patch discarded remove patch
@@ -27,1270 +27,1270 @@
 block discarded – undo
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()) {
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
-            } catch (Exception $exception) {
1152
-                new ExceptionStackTraceDisplay($exception);
1153
-            }
1154
-        }
1155
-        if ($this->request->isAdmin()
1156
-            || $this->request->isEeAjax()
1157
-            || $this->request->isFrontend()
1158
-        ) {
1159
-            $this->loader->getShared('EE_Session');
1160
-        }
1161
-        do_action('AHEE__EE_System__core_loaded_and_ready');
1162
-        // load_espresso_template_tags
1163
-        if (is_readable(EE_PUBLIC . 'template_tags.php')
1164
-            && ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed())
1165
-        ) {
1166
-            require_once EE_PUBLIC . 'template_tags.php';
1167
-        }
1168
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
1169
-    }
1170
-
1171
-
1172
-    /**
1173
-     * initialize
1174
-     * this is the best place to begin initializing client code
1175
-     *
1176
-     * @access public
1177
-     * @return void
1178
-     */
1179
-    public function initialize()
1180
-    {
1181
-        do_action('AHEE__EE_System__initialize');
1182
-    }
1183
-
1184
-
1185
-    /**
1186
-     * initialize_last
1187
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
1188
-     * initialize has done so
1189
-     *
1190
-     * @access public
1191
-     * @return void
1192
-     */
1193
-    public function initialize_last()
1194
-    {
1195
-        do_action('AHEE__EE_System__initialize_last');
1196
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
1197
-        $rewrite_rules = $this->loader->getShared(
1198
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
1199
-        );
1200
-        $rewrite_rules->flushRewriteRules();
1201
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
1202
-        if ($this->request->isAdmin()) {
1203
-            $this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
1204
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
1205
-        }
1206
-        if ($this->request->isAjax()) {
1207
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
1208
-        }
1209
-        if ($this->request->isAdmin() && function_exists('wp_add_privacy_policy_content')) {
1210
-            $this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
1211
-        }
1212
-    }
1213
-
1214
-
1215
-    /**
1216
-     * @return void
1217
-     * @throws EE_Error
1218
-     */
1219
-    public function addEspressoToolbar()
1220
-    {
1221
-        $this->loader->getShared(
1222
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
1223
-            array($this->registry->CAP)
1224
-        );
1225
-    }
1226
-
1227
-
1228
-    /**
1229
-     * do_not_cache
1230
-     * sets no cache headers and defines no cache constants for WP plugins
1231
-     *
1232
-     * @access public
1233
-     * @return void
1234
-     */
1235
-    public static function do_not_cache()
1236
-    {
1237
-        // set no cache constants
1238
-        if (! defined('DONOTCACHEPAGE')) {
1239
-            define('DONOTCACHEPAGE', true);
1240
-        }
1241
-        if (! defined('DONOTCACHCEOBJECT')) {
1242
-            define('DONOTCACHCEOBJECT', true);
1243
-        }
1244
-        if (! defined('DONOTCACHEDB')) {
1245
-            define('DONOTCACHEDB', true);
1246
-        }
1247
-        // add no cache headers
1248
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
1249
-        // plus a little extra for nginx and Google Chrome
1250
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
1251
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
1252
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
1253
-    }
1254
-
1255
-
1256
-    /**
1257
-     *    extra_nocache_headers
1258
-     *
1259
-     * @access    public
1260
-     * @param $headers
1261
-     * @return    array
1262
-     */
1263
-    public static function extra_nocache_headers($headers)
1264
-    {
1265
-        // for NGINX
1266
-        $headers['X-Accel-Expires'] = 0;
1267
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
1268
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
1269
-        return $headers;
1270
-    }
1271
-
1272
-
1273
-    /**
1274
-     *    nocache_headers
1275
-     *
1276
-     * @access    public
1277
-     * @return    void
1278
-     */
1279
-    public static function nocache_headers()
1280
-    {
1281
-        nocache_headers();
1282
-    }
1283
-
1284
-
1285
-    /**
1286
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1287
-     * never returned with the function.
1288
-     *
1289
-     * @param  array $exclude_array any existing pages being excluded are in this array.
1290
-     * @return array
1291
-     */
1292
-    public function remove_pages_from_wp_list_pages($exclude_array)
1293
-    {
1294
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1295
-    }
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()) {
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
+			} catch (Exception $exception) {
1152
+				new ExceptionStackTraceDisplay($exception);
1153
+			}
1154
+		}
1155
+		if ($this->request->isAdmin()
1156
+			|| $this->request->isEeAjax()
1157
+			|| $this->request->isFrontend()
1158
+		) {
1159
+			$this->loader->getShared('EE_Session');
1160
+		}
1161
+		do_action('AHEE__EE_System__core_loaded_and_ready');
1162
+		// load_espresso_template_tags
1163
+		if (is_readable(EE_PUBLIC . 'template_tags.php')
1164
+			&& ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isFeed())
1165
+		) {
1166
+			require_once EE_PUBLIC . 'template_tags.php';
1167
+		}
1168
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
1169
+	}
1170
+
1171
+
1172
+	/**
1173
+	 * initialize
1174
+	 * this is the best place to begin initializing client code
1175
+	 *
1176
+	 * @access public
1177
+	 * @return void
1178
+	 */
1179
+	public function initialize()
1180
+	{
1181
+		do_action('AHEE__EE_System__initialize');
1182
+	}
1183
+
1184
+
1185
+	/**
1186
+	 * initialize_last
1187
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
1188
+	 * initialize has done so
1189
+	 *
1190
+	 * @access public
1191
+	 * @return void
1192
+	 */
1193
+	public function initialize_last()
1194
+	{
1195
+		do_action('AHEE__EE_System__initialize_last');
1196
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
1197
+		$rewrite_rules = $this->loader->getShared(
1198
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
1199
+		);
1200
+		$rewrite_rules->flushRewriteRules();
1201
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
1202
+		if ($this->request->isAdmin()) {
1203
+			$this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
1204
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
1205
+		}
1206
+		if ($this->request->isAjax()) {
1207
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
1208
+		}
1209
+		if ($this->request->isAdmin() && function_exists('wp_add_privacy_policy_content')) {
1210
+			$this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
1211
+		}
1212
+	}
1213
+
1214
+
1215
+	/**
1216
+	 * @return void
1217
+	 * @throws EE_Error
1218
+	 */
1219
+	public function addEspressoToolbar()
1220
+	{
1221
+		$this->loader->getShared(
1222
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
1223
+			array($this->registry->CAP)
1224
+		);
1225
+	}
1226
+
1227
+
1228
+	/**
1229
+	 * do_not_cache
1230
+	 * sets no cache headers and defines no cache constants for WP plugins
1231
+	 *
1232
+	 * @access public
1233
+	 * @return void
1234
+	 */
1235
+	public static function do_not_cache()
1236
+	{
1237
+		// set no cache constants
1238
+		if (! defined('DONOTCACHEPAGE')) {
1239
+			define('DONOTCACHEPAGE', true);
1240
+		}
1241
+		if (! defined('DONOTCACHCEOBJECT')) {
1242
+			define('DONOTCACHCEOBJECT', true);
1243
+		}
1244
+		if (! defined('DONOTCACHEDB')) {
1245
+			define('DONOTCACHEDB', true);
1246
+		}
1247
+		// add no cache headers
1248
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
1249
+		// plus a little extra for nginx and Google Chrome
1250
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
1251
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
1252
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
1253
+	}
1254
+
1255
+
1256
+	/**
1257
+	 *    extra_nocache_headers
1258
+	 *
1259
+	 * @access    public
1260
+	 * @param $headers
1261
+	 * @return    array
1262
+	 */
1263
+	public static function extra_nocache_headers($headers)
1264
+	{
1265
+		// for NGINX
1266
+		$headers['X-Accel-Expires'] = 0;
1267
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
1268
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
1269
+		return $headers;
1270
+	}
1271
+
1272
+
1273
+	/**
1274
+	 *    nocache_headers
1275
+	 *
1276
+	 * @access    public
1277
+	 * @return    void
1278
+	 */
1279
+	public static function nocache_headers()
1280
+	{
1281
+		nocache_headers();
1282
+	}
1283
+
1284
+
1285
+	/**
1286
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
1287
+	 * never returned with the function.
1288
+	 *
1289
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
1290
+	 * @return array
1291
+	 */
1292
+	public function remove_pages_from_wp_list_pages($exclude_array)
1293
+	{
1294
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
1295
+	}
1296 1296
 }
Please login to merge, or discard this patch.
core/EE_Error.core.php 1 patch
Indentation   +1126 added lines, -1126 removed lines patch added patch discarded remove patch
@@ -10,8 +10,8 @@  discard block
 block discarded – undo
10 10
 // if you're a dev and want to receive all errors via email
11 11
 // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
12 12
 if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) {
13
-    set_error_handler(array('EE_Error', 'error_handler'));
14
-    register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
13
+	set_error_handler(array('EE_Error', 'error_handler'));
14
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
15 15
 }
16 16
 
17 17
 
@@ -25,251 +25,251 @@  discard block
 block discarded – undo
25 25
 class EE_Error extends Exception
26 26
 {
27 27
 
28
-    const OPTIONS_KEY_NOTICES = 'ee_notices';
29
-
30
-
31
-    /**
32
-     * name of the file to log exceptions to
33
-     *
34
-     * @var string
35
-     */
36
-    private static $_exception_log_file = 'espresso_error_log.txt';
37
-
38
-    /**
39
-     *    stores details for all exception
40
-     *
41
-     * @var array
42
-     */
43
-    private static $_all_exceptions = array();
44
-
45
-    /**
46
-     *    tracks number of errors
47
-     *
48
-     * @var int
49
-     */
50
-    private static $_error_count = 0;
51
-
52
-    /**
53
-     * @var array $_espresso_notices
54
-     */
55
-    private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
56
-
57
-
58
-    /**
59
-     * @override default exception handling
60
-     * @param string         $message
61
-     * @param int            $code
62
-     * @param Exception|null $previous
63
-     */
64
-    public function __construct($message, $code = 0, Exception $previous = null)
65
-    {
66
-        if (version_compare(PHP_VERSION, '5.3.0', '<')) {
67
-            parent::__construct($message, $code);
68
-        } else {
69
-            parent::__construct($message, $code, $previous);
70
-        }
71
-    }
72
-
73
-
74
-    /**
75
-     *    error_handler
76
-     *
77
-     * @param $code
78
-     * @param $message
79
-     * @param $file
80
-     * @param $line
81
-     * @return void
82
-     */
83
-    public static function error_handler($code, $message, $file, $line)
84
-    {
85
-        $type = EE_Error::error_type($code);
86
-        $site = site_url();
87
-        switch ($site) {
88
-            case 'http://ee4.eventespresso.com/':
89
-            case 'http://ee4decaf.eventespresso.com/':
90
-            case 'http://ee4hf.eventespresso.com/':
91
-            case 'http://ee4a.eventespresso.com/':
92
-            case 'http://ee4ad.eventespresso.com/':
93
-            case 'http://ee4b.eventespresso.com/':
94
-            case 'http://ee4bd.eventespresso.com/':
95
-            case 'http://ee4d.eventespresso.com/':
96
-            case 'http://ee4dd.eventespresso.com/':
97
-                $to = '[email protected]';
98
-                break;
99
-            default:
100
-                $to = get_option('admin_email');
101
-        }
102
-        $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
103
-        $msg = EE_Error::_format_error($type, $message, $file, $line);
104
-        if (function_exists('wp_mail')) {
105
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
106
-            wp_mail($to, $subject, $msg);
107
-        }
108
-        echo '<div id="message" class="espresso-notices error"><p>';
109
-        echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
110
-        echo '<br /></p></div>';
111
-    }
112
-
113
-
114
-    /**
115
-     * error_type
116
-     * http://www.php.net/manual/en/errorfunc.constants.php#109430
117
-     *
118
-     * @param $code
119
-     * @return string
120
-     */
121
-    public static function error_type($code)
122
-    {
123
-        switch ($code) {
124
-            case E_ERROR: // 1 //
125
-                return 'E_ERROR';
126
-            case E_WARNING: // 2 //
127
-                return 'E_WARNING';
128
-            case E_PARSE: // 4 //
129
-                return 'E_PARSE';
130
-            case E_NOTICE: // 8 //
131
-                return 'E_NOTICE';
132
-            case E_CORE_ERROR: // 16 //
133
-                return 'E_CORE_ERROR';
134
-            case E_CORE_WARNING: // 32 //
135
-                return 'E_CORE_WARNING';
136
-            case E_COMPILE_ERROR: // 64 //
137
-                return 'E_COMPILE_ERROR';
138
-            case E_COMPILE_WARNING: // 128 //
139
-                return 'E_COMPILE_WARNING';
140
-            case E_USER_ERROR: // 256 //
141
-                return 'E_USER_ERROR';
142
-            case E_USER_WARNING: // 512 //
143
-                return 'E_USER_WARNING';
144
-            case E_USER_NOTICE: // 1024 //
145
-                return 'E_USER_NOTICE';
146
-            case E_STRICT: // 2048 //
147
-                return 'E_STRICT';
148
-            case E_RECOVERABLE_ERROR: // 4096 //
149
-                return 'E_RECOVERABLE_ERROR';
150
-            case E_DEPRECATED: // 8192 //
151
-                return 'E_DEPRECATED';
152
-            case E_USER_DEPRECATED: // 16384 //
153
-                return 'E_USER_DEPRECATED';
154
-            case E_ALL: // 16384 //
155
-                return 'E_ALL';
156
-        }
157
-        return '';
158
-    }
159
-
160
-
161
-    /**
162
-     *    fatal_error_handler
163
-     *
164
-     * @return void
165
-     */
166
-    public static function fatal_error_handler()
167
-    {
168
-        $last_error = error_get_last();
169
-        if ($last_error['type'] === E_ERROR) {
170
-            EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
171
-        }
172
-    }
173
-
174
-
175
-    /**
176
-     * _format_error
177
-     *
178
-     * @param $code
179
-     * @param $message
180
-     * @param $file
181
-     * @param $line
182
-     * @return string
183
-     */
184
-    private static function _format_error($code, $message, $file, $line)
185
-    {
186
-        $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
187
-        $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
188
-        $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
189
-        $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
190
-        $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
191
-        $html .= '</tbody></table>';
192
-        return $html;
193
-    }
194
-
195
-
196
-    /**
197
-     * set_content_type
198
-     *
199
-     * @param $content_type
200
-     * @return string
201
-     */
202
-    public static function set_content_type($content_type)
203
-    {
204
-        return 'text/html';
205
-    }
206
-
207
-
208
-    /**
209
-     * @return void
210
-     * @throws EE_Error
211
-     * @throws ReflectionException
212
-     */
213
-    public function get_error()
214
-    {
215
-        if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
216
-            throw $this;
217
-        }
218
-        // get separate user and developer messages if they exist
219
-        $msg = explode('||', $this->getMessage());
220
-        $user_msg = $msg[0];
221
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
222
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
223
-        // add details to _all_exceptions array
224
-        $x_time = time();
225
-        self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
226
-        self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
227
-        self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
228
-        self::$_all_exceptions[ $x_time ]['msg'] = $msg;
229
-        self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
230
-        self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
231
-        self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
232
-        self::$_error_count++;
233
-        // add_action( 'shutdown', array( $this, 'display_errors' ));
234
-        $this->display_errors();
235
-    }
236
-
237
-
238
-    /**
239
-     * @param bool   $check_stored
240
-     * @param string $type_to_check
241
-     * @return bool
242
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
243
-     * @throws \InvalidArgumentException
244
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
245
-     * @throws InvalidInterfaceException
246
-     */
247
-    public static function has_error($check_stored = false, $type_to_check = 'errors')
248
-    {
249
-        $has_error = isset(self::$_espresso_notices[ $type_to_check ])
250
-                     && ! empty(self::$_espresso_notices[ $type_to_check ])
251
-            ? true
252
-            : false;
253
-        if ($check_stored && ! $has_error) {
254
-            $notices = EE_Error::getStoredNotices();
255
-            foreach ($notices as $type => $notice) {
256
-                if ($type === $type_to_check && $notice) {
257
-                    return true;
258
-                }
259
-            }
260
-        }
261
-        return $has_error;
262
-    }
263
-
264
-
265
-    /**
266
-     * @echo string
267
-     * @throws \ReflectionException
268
-     */
269
-    public function display_errors()
270
-    {
271
-        $trace_details = '';
272
-        $output = '
28
+	const OPTIONS_KEY_NOTICES = 'ee_notices';
29
+
30
+
31
+	/**
32
+	 * name of the file to log exceptions to
33
+	 *
34
+	 * @var string
35
+	 */
36
+	private static $_exception_log_file = 'espresso_error_log.txt';
37
+
38
+	/**
39
+	 *    stores details for all exception
40
+	 *
41
+	 * @var array
42
+	 */
43
+	private static $_all_exceptions = array();
44
+
45
+	/**
46
+	 *    tracks number of errors
47
+	 *
48
+	 * @var int
49
+	 */
50
+	private static $_error_count = 0;
51
+
52
+	/**
53
+	 * @var array $_espresso_notices
54
+	 */
55
+	private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false);
56
+
57
+
58
+	/**
59
+	 * @override default exception handling
60
+	 * @param string         $message
61
+	 * @param int            $code
62
+	 * @param Exception|null $previous
63
+	 */
64
+	public function __construct($message, $code = 0, Exception $previous = null)
65
+	{
66
+		if (version_compare(PHP_VERSION, '5.3.0', '<')) {
67
+			parent::__construct($message, $code);
68
+		} else {
69
+			parent::__construct($message, $code, $previous);
70
+		}
71
+	}
72
+
73
+
74
+	/**
75
+	 *    error_handler
76
+	 *
77
+	 * @param $code
78
+	 * @param $message
79
+	 * @param $file
80
+	 * @param $line
81
+	 * @return void
82
+	 */
83
+	public static function error_handler($code, $message, $file, $line)
84
+	{
85
+		$type = EE_Error::error_type($code);
86
+		$site = site_url();
87
+		switch ($site) {
88
+			case 'http://ee4.eventespresso.com/':
89
+			case 'http://ee4decaf.eventespresso.com/':
90
+			case 'http://ee4hf.eventespresso.com/':
91
+			case 'http://ee4a.eventespresso.com/':
92
+			case 'http://ee4ad.eventespresso.com/':
93
+			case 'http://ee4b.eventespresso.com/':
94
+			case 'http://ee4bd.eventespresso.com/':
95
+			case 'http://ee4d.eventespresso.com/':
96
+			case 'http://ee4dd.eventespresso.com/':
97
+				$to = '[email protected]';
98
+				break;
99
+			default:
100
+				$to = get_option('admin_email');
101
+		}
102
+		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
103
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
104
+		if (function_exists('wp_mail')) {
105
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
106
+			wp_mail($to, $subject, $msg);
107
+		}
108
+		echo '<div id="message" class="espresso-notices error"><p>';
109
+		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
110
+		echo '<br /></p></div>';
111
+	}
112
+
113
+
114
+	/**
115
+	 * error_type
116
+	 * http://www.php.net/manual/en/errorfunc.constants.php#109430
117
+	 *
118
+	 * @param $code
119
+	 * @return string
120
+	 */
121
+	public static function error_type($code)
122
+	{
123
+		switch ($code) {
124
+			case E_ERROR: // 1 //
125
+				return 'E_ERROR';
126
+			case E_WARNING: // 2 //
127
+				return 'E_WARNING';
128
+			case E_PARSE: // 4 //
129
+				return 'E_PARSE';
130
+			case E_NOTICE: // 8 //
131
+				return 'E_NOTICE';
132
+			case E_CORE_ERROR: // 16 //
133
+				return 'E_CORE_ERROR';
134
+			case E_CORE_WARNING: // 32 //
135
+				return 'E_CORE_WARNING';
136
+			case E_COMPILE_ERROR: // 64 //
137
+				return 'E_COMPILE_ERROR';
138
+			case E_COMPILE_WARNING: // 128 //
139
+				return 'E_COMPILE_WARNING';
140
+			case E_USER_ERROR: // 256 //
141
+				return 'E_USER_ERROR';
142
+			case E_USER_WARNING: // 512 //
143
+				return 'E_USER_WARNING';
144
+			case E_USER_NOTICE: // 1024 //
145
+				return 'E_USER_NOTICE';
146
+			case E_STRICT: // 2048 //
147
+				return 'E_STRICT';
148
+			case E_RECOVERABLE_ERROR: // 4096 //
149
+				return 'E_RECOVERABLE_ERROR';
150
+			case E_DEPRECATED: // 8192 //
151
+				return 'E_DEPRECATED';
152
+			case E_USER_DEPRECATED: // 16384 //
153
+				return 'E_USER_DEPRECATED';
154
+			case E_ALL: // 16384 //
155
+				return 'E_ALL';
156
+		}
157
+		return '';
158
+	}
159
+
160
+
161
+	/**
162
+	 *    fatal_error_handler
163
+	 *
164
+	 * @return void
165
+	 */
166
+	public static function fatal_error_handler()
167
+	{
168
+		$last_error = error_get_last();
169
+		if ($last_error['type'] === E_ERROR) {
170
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
171
+		}
172
+	}
173
+
174
+
175
+	/**
176
+	 * _format_error
177
+	 *
178
+	 * @param $code
179
+	 * @param $message
180
+	 * @param $file
181
+	 * @param $line
182
+	 * @return string
183
+	 */
184
+	private static function _format_error($code, $message, $file, $line)
185
+	{
186
+		$html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
187
+		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
188
+		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
189
+		$html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>";
190
+		$html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>";
191
+		$html .= '</tbody></table>';
192
+		return $html;
193
+	}
194
+
195
+
196
+	/**
197
+	 * set_content_type
198
+	 *
199
+	 * @param $content_type
200
+	 * @return string
201
+	 */
202
+	public static function set_content_type($content_type)
203
+	{
204
+		return 'text/html';
205
+	}
206
+
207
+
208
+	/**
209
+	 * @return void
210
+	 * @throws EE_Error
211
+	 * @throws ReflectionException
212
+	 */
213
+	public function get_error()
214
+	{
215
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) {
216
+			throw $this;
217
+		}
218
+		// get separate user and developer messages if they exist
219
+		$msg = explode('||', $this->getMessage());
220
+		$user_msg = $msg[0];
221
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
222
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
223
+		// add details to _all_exceptions array
224
+		$x_time = time();
225
+		self::$_all_exceptions[ $x_time ]['name'] = get_class($this);
226
+		self::$_all_exceptions[ $x_time ]['file'] = $this->getFile();
227
+		self::$_all_exceptions[ $x_time ]['line'] = $this->getLine();
228
+		self::$_all_exceptions[ $x_time ]['msg'] = $msg;
229
+		self::$_all_exceptions[ $x_time ]['code'] = $this->getCode();
230
+		self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace();
231
+		self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString();
232
+		self::$_error_count++;
233
+		// add_action( 'shutdown', array( $this, 'display_errors' ));
234
+		$this->display_errors();
235
+	}
236
+
237
+
238
+	/**
239
+	 * @param bool   $check_stored
240
+	 * @param string $type_to_check
241
+	 * @return bool
242
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
243
+	 * @throws \InvalidArgumentException
244
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
245
+	 * @throws InvalidInterfaceException
246
+	 */
247
+	public static function has_error($check_stored = false, $type_to_check = 'errors')
248
+	{
249
+		$has_error = isset(self::$_espresso_notices[ $type_to_check ])
250
+					 && ! empty(self::$_espresso_notices[ $type_to_check ])
251
+			? true
252
+			: false;
253
+		if ($check_stored && ! $has_error) {
254
+			$notices = EE_Error::getStoredNotices();
255
+			foreach ($notices as $type => $notice) {
256
+				if ($type === $type_to_check && $notice) {
257
+					return true;
258
+				}
259
+			}
260
+		}
261
+		return $has_error;
262
+	}
263
+
264
+
265
+	/**
266
+	 * @echo string
267
+	 * @throws \ReflectionException
268
+	 */
269
+	public function display_errors()
270
+	{
271
+		$trace_details = '';
272
+		$output = '
273 273
 <style type="text/css">
274 274
 	#ee-error-message {
275 275
 		max-width:90% !important;
@@ -325,21 +325,21 @@  discard block
 block discarded – undo
325 325
 	}
326 326
 </style>
327 327
 <div id="ee-error-message" class="error">';
328
-        if (! WP_DEBUG) {
329
-            $output .= '
328
+		if (! WP_DEBUG) {
329
+			$output .= '
330 330
 	<p>';
331
-        }
332
-        // cycle thru errors
333
-        foreach (self::$_all_exceptions as $time => $ex) {
334
-            $error_code = '';
335
-            // process trace info
336
-            if (empty($ex['trace'])) {
337
-                $trace_details .= __(
338
-                    'Sorry, but no trace information was available for this exception.',
339
-                    'event_espresso'
340
-                );
341
-            } else {
342
-                $trace_details .= '
331
+		}
332
+		// cycle thru errors
333
+		foreach (self::$_all_exceptions as $time => $ex) {
334
+			$error_code = '';
335
+			// process trace info
336
+			if (empty($ex['trace'])) {
337
+				$trace_details .= __(
338
+					'Sorry, but no trace information was available for this exception.',
339
+					'event_espresso'
340
+				);
341
+			} else {
342
+				$trace_details .= '
343 343
 			<div id="ee-trace-details">
344 344
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
345 345
 				<tr>
@@ -349,43 +349,43 @@  discard block
 block discarded – undo
349 349
 					<th scope="col" align="left">Class</th>
350 350
 					<th scope="col" align="left">Method( arguments )</th>
351 351
 				</tr>';
352
-                $last_on_stack = count($ex['trace']) - 1;
353
-                // reverse array so that stack is in proper chronological order
354
-                $sorted_trace = array_reverse($ex['trace']);
355
-                foreach ($sorted_trace as $nmbr => $trace) {
356
-                    $file = isset($trace['file']) ? $trace['file'] : '';
357
-                    $class = isset($trace['class']) ? $trace['class'] : '';
358
-                    $type = isset($trace['type']) ? $trace['type'] : '';
359
-                    $function = isset($trace['function']) ? $trace['function'] : '';
360
-                    $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
361
-                    $line = isset($trace['line']) ? $trace['line'] : '';
362
-                    $zebra = ($nmbr % 2) ? ' odd' : '';
363
-                    if (empty($file) && ! empty($class)) {
364
-                        $a = new ReflectionClass($class);
365
-                        $file = $a->getFileName();
366
-                        if (empty($line) && ! empty($function)) {
367
-                            try {
368
-                                // if $function is a closure, this throws an exception
369
-                                $b = new ReflectionMethod($class, $function);
370
-                                $line = $b->getStartLine();
371
-                            } catch (Exception $closure_exception) {
372
-                                $line = 'unknown';
373
-                            }
374
-                        }
375
-                    }
376
-                    if ($nmbr === $last_on_stack) {
377
-                        $file = $ex['file'] !== '' ? $ex['file'] : $file;
378
-                        $line = $ex['line'] !== '' ? $ex['line'] : $line;
379
-                        $error_code = self::generate_error_code($file, $trace['function'], $line);
380
-                    }
381
-                    $nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
382
-                    $line_dsply = ! empty($line) ? $line : '&nbsp;';
383
-                    $file_dsply = ! empty($file) ? $file : '&nbsp;';
384
-                    $class_dsply = ! empty($class) ? $class : '&nbsp;';
385
-                    $type_dsply = ! empty($type) ? $type : '&nbsp;';
386
-                    $function_dsply = ! empty($function) ? $function : '&nbsp;';
387
-                    $args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
388
-                    $trace_details .= '
352
+				$last_on_stack = count($ex['trace']) - 1;
353
+				// reverse array so that stack is in proper chronological order
354
+				$sorted_trace = array_reverse($ex['trace']);
355
+				foreach ($sorted_trace as $nmbr => $trace) {
356
+					$file = isset($trace['file']) ? $trace['file'] : '';
357
+					$class = isset($trace['class']) ? $trace['class'] : '';
358
+					$type = isset($trace['type']) ? $trace['type'] : '';
359
+					$function = isset($trace['function']) ? $trace['function'] : '';
360
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
361
+					$line = isset($trace['line']) ? $trace['line'] : '';
362
+					$zebra = ($nmbr % 2) ? ' odd' : '';
363
+					if (empty($file) && ! empty($class)) {
364
+						$a = new ReflectionClass($class);
365
+						$file = $a->getFileName();
366
+						if (empty($line) && ! empty($function)) {
367
+							try {
368
+								// if $function is a closure, this throws an exception
369
+								$b = new ReflectionMethod($class, $function);
370
+								$line = $b->getStartLine();
371
+							} catch (Exception $closure_exception) {
372
+								$line = 'unknown';
373
+							}
374
+						}
375
+					}
376
+					if ($nmbr === $last_on_stack) {
377
+						$file = $ex['file'] !== '' ? $ex['file'] : $file;
378
+						$line = $ex['line'] !== '' ? $ex['line'] : $line;
379
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
380
+					}
381
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
382
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
383
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
384
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
385
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
386
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
387
+					$args_dsply = ! empty($args) ? '( ' . $args . ' )' : '';
388
+					$trace_details .= '
389 389
 					<tr>
390 390
 						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
391 391
 						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
@@ -393,626 +393,626 @@  discard block
 block discarded – undo
393 393
 						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
394 394
 						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
395 395
 					</tr>';
396
-                }
397
-                $trace_details .= '
396
+				}
397
+				$trace_details .= '
398 398
 			 </table>
399 399
 			</div>';
400
-            }
401
-            $ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
402
-            // add generic non-identifying messages for non-privileged users
403
-            if (! WP_DEBUG) {
404
-                $output .= '<span class="ee-error-user-msg-spn">'
405
-                           . trim($ex['msg'])
406
-                           . '</span> &nbsp; <sup>'
407
-                           . $ex['code']
408
-                           . '</sup><br />';
409
-            } else {
410
-                // or helpful developer messages if debugging is on
411
-                $output .= '
400
+			}
401
+			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
402
+			// add generic non-identifying messages for non-privileged users
403
+			if (! WP_DEBUG) {
404
+				$output .= '<span class="ee-error-user-msg-spn">'
405
+						   . trim($ex['msg'])
406
+						   . '</span> &nbsp; <sup>'
407
+						   . $ex['code']
408
+						   . '</sup><br />';
409
+			} else {
410
+				// or helpful developer messages if debugging is on
411
+				$output .= '
412 412
 		<div class="ee-error-dev-msg-dv">
413 413
 			<p class="ee-error-dev-msg-pg">
414 414
 				<strong class="ee-error-dev-msg-str">An '
415
-                           . $ex['name']
416
-                           . ' exception was thrown!</strong>  &nbsp; <span>code: '
417
-                           . $ex['code']
418
-                           . '</span><br />
415
+						   . $ex['name']
416
+						   . ' exception was thrown!</strong>  &nbsp; <span>code: '
417
+						   . $ex['code']
418
+						   . '</span><br />
419 419
 				<span class="big-text">"'
420
-                           . trim($ex['msg'])
421
-                           . '"</span><br/>
420
+						   . trim($ex['msg'])
421
+						   . '"</span><br/>
422 422
 				<a id="display-ee-error-trace-'
423
-                           . self::$_error_count
424
-                           . $time
425
-                           . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
426
-                           . self::$_error_count
427
-                           . $time
428
-                           . '">
423
+						   . self::$_error_count
424
+						   . $time
425
+						   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'
426
+						   . self::$_error_count
427
+						   . $time
428
+						   . '">
429 429
 					'
430
-                           . __('click to view backtrace and class/method details', 'event_espresso')
431
-                           . '
430
+						   . __('click to view backtrace and class/method details', 'event_espresso')
431
+						   . '
432 432
 				</a><br />
433 433
 				<span class="small-text lt-grey-text">'
434
-                           . $ex['file']
435
-                           . ' &nbsp; ( line no: '
436
-                           . $ex['line']
437
-                           . ' )</span>
434
+						   . $ex['file']
435
+						   . ' &nbsp; ( line no: '
436
+						   . $ex['line']
437
+						   . ' )</span>
438 438
 			</p>
439 439
 			<div id="ee-error-trace-'
440
-                           . self::$_error_count
441
-                           . $time
442
-                           . '-dv" class="ee-error-trace-dv" style="display: none;">
440
+						   . self::$_error_count
441
+						   . $time
442
+						   . '-dv" class="ee-error-trace-dv" style="display: none;">
443 443
 				'
444
-                           . $trace_details;
445
-                if (! empty($class)) {
446
-                    $output .= '
444
+						   . $trace_details;
445
+				if (! empty($class)) {
446
+					$output .= '
447 447
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
448 448
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
449 449
 						<h3>Class Details</h3>';
450
-                    $a = new ReflectionClass($class);
451
-                    $output .= '
450
+					$a = new ReflectionClass($class);
451
+					$output .= '
452 452
 						<pre>' . $a . '</pre>
453 453
 					</div>
454 454
 				</div>';
455
-                }
456
-                $output .= '
455
+				}
456
+				$output .= '
457 457
 			</div>
458 458
 		</div>
459 459
 		<br />';
460
-            }
461
-            $this->write_to_error_log($time, $ex);
462
-        }
463
-        // remove last linebreak
464
-        $output = substr($output, 0, -6);
465
-        if (! WP_DEBUG) {
466
-            $output .= '
460
+			}
461
+			$this->write_to_error_log($time, $ex);
462
+		}
463
+		// remove last linebreak
464
+		$output = substr($output, 0, -6);
465
+		if (! WP_DEBUG) {
466
+			$output .= '
467 467
 	</p>';
468
-        }
469
-        $output .= '
468
+		}
469
+		$output .= '
470 470
 </div>';
471
-        $output .= self::_print_scripts(true);
472
-        if (defined('DOING_AJAX')) {
473
-            echo wp_json_encode(array('error' => $output));
474
-            exit();
475
-        }
476
-        echo $output;
477
-        die();
478
-    }
479
-
480
-
481
-    /**
482
-     *    generate string from exception trace args
483
-     *
484
-     * @param array $arguments
485
-     * @param bool  $array
486
-     * @return string
487
-     */
488
-    private function _convert_args_to_string($arguments = array(), $array = false)
489
-    {
490
-        $arg_string = '';
491
-        if (! empty($arguments)) {
492
-            $args = array();
493
-            foreach ($arguments as $arg) {
494
-                if (! empty($arg)) {
495
-                    if (is_string($arg)) {
496
-                        $args[] = " '" . $arg . "'";
497
-                    } elseif (is_array($arg)) {
498
-                        $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
499
-                    } elseif ($arg === null) {
500
-                        $args[] = ' NULL';
501
-                    } elseif (is_bool($arg)) {
502
-                        $args[] = ($arg) ? ' TRUE' : ' FALSE';
503
-                    } elseif (is_object($arg)) {
504
-                        $args[] = ' OBJECT ' . get_class($arg);
505
-                    } elseif (is_resource($arg)) {
506
-                        $args[] = get_resource_type($arg);
507
-                    } else {
508
-                        $args[] = $arg;
509
-                    }
510
-                }
511
-            }
512
-            $arg_string = implode(', ', $args);
513
-        }
514
-        if ($array) {
515
-            $arg_string .= ' )';
516
-        }
517
-        return $arg_string;
518
-    }
519
-
520
-
521
-    /**
522
-     *    add error message
523
-     *
524
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
525
-     *                            separate messages for user || dev
526
-     * @param        string $file the file that the error occurred in - just use __FILE__
527
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
528
-     * @param        string $line the line number where the error occurred - just use __LINE__
529
-     * @return        void
530
-     */
531
-    public static function add_error($msg = null, $file = null, $func = null, $line = null)
532
-    {
533
-        self::_add_notice('errors', $msg, $file, $func, $line);
534
-        self::$_error_count++;
535
-    }
536
-
537
-
538
-    /**
539
-     * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
540
-     * adds an error
541
-     *
542
-     * @param string $msg
543
-     * @param string $file
544
-     * @param string $func
545
-     * @param string $line
546
-     * @throws EE_Error
547
-     */
548
-    public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
549
-    {
550
-        if (WP_DEBUG) {
551
-            throw new EE_Error($msg);
552
-        }
553
-        EE_Error::add_error($msg, $file, $func, $line);
554
-    }
555
-
556
-
557
-    /**
558
-     *    add success message
559
-     *
560
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
561
-     *                            separate messages for user || dev
562
-     * @param        string $file the file that the error occurred in - just use __FILE__
563
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
564
-     * @param        string $line the line number where the error occurred - just use __LINE__
565
-     * @return        void
566
-     */
567
-    public static function add_success($msg = null, $file = null, $func = null, $line = null)
568
-    {
569
-        self::_add_notice('success', $msg, $file, $func, $line);
570
-    }
571
-
572
-
573
-    /**
574
-     *    add attention message
575
-     *
576
-     * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
577
-     *                            separate messages for user || dev
578
-     * @param        string $file the file that the error occurred in - just use __FILE__
579
-     * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
580
-     * @param        string $line the line number where the error occurred - just use __LINE__
581
-     * @return        void
582
-     */
583
-    public static function add_attention($msg = null, $file = null, $func = null, $line = null)
584
-    {
585
-        self::_add_notice('attention', $msg, $file, $func, $line);
586
-    }
587
-
588
-
589
-    /**
590
-     * @param string $type whether the message is for a success or error notification
591
-     * @param string $msg  the message to display to users or developers
592
-     *                     - adding a double pipe || (OR) creates separate messages for user || dev
593
-     * @param string $file the file that the error occurred in - just use __FILE__
594
-     * @param string $func the function/method that the error occurred in - just use __FUNCTION__
595
-     * @param string $line the line number where the error occurred - just use __LINE__
596
-     * @return void
597
-     */
598
-    private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
599
-    {
600
-        if (empty($msg)) {
601
-            EE_Error::doing_it_wrong(
602
-                'EE_Error::add_' . $type . '()',
603
-                sprintf(
604
-                    __(
605
-                        'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
606
-                        'event_espresso'
607
-                    ),
608
-                    $type,
609
-                    $file,
610
-                    $line
611
-                ),
612
-                EVENT_ESPRESSO_VERSION
613
-            );
614
-        }
615
-        if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
616
-            EE_Error::doing_it_wrong(
617
-                'EE_Error::add_error()',
618
-                __(
619
-                    'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
620
-                    'event_espresso'
621
-                ),
622
-                EVENT_ESPRESSO_VERSION
623
-            );
624
-        }
625
-        // get separate user and developer messages if they exist
626
-        $msg = explode('||', $msg);
627
-        $user_msg = $msg[0];
628
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
629
-        /**
630
-         * Do an action so other code can be triggered when a notice is created
631
-         *
632
-         * @param string $type     can be 'errors', 'attention', or 'success'
633
-         * @param string $user_msg message displayed to user when WP_DEBUG is off
634
-         * @param string $user_msg message displayed to user when WP_DEBUG is on
635
-         * @param string $file     file where error was generated
636
-         * @param string $func     function where error was generated
637
-         * @param string $line     line where error was generated
638
-         */
639
-        do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
640
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
641
-        // add notice if message exists
642
-        if (! empty($msg)) {
643
-            // get error code
644
-            $notice_code = EE_Error::generate_error_code($file, $func, $line);
645
-            if (WP_DEBUG && $type === 'errors') {
646
-                $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
647
-            }
648
-            // add notice. Index by code if it's not blank
649
-            if ($notice_code) {
650
-                self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
651
-            } else {
652
-                self::$_espresso_notices[ $type ][] = $msg;
653
-            }
654
-            add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
655
-        }
656
-    }
657
-
658
-
659
-    /**
660
-     * in some case it may be necessary to overwrite the existing success messages
661
-     *
662
-     * @return        void
663
-     */
664
-    public static function overwrite_success()
665
-    {
666
-        self::$_espresso_notices['success'] = false;
667
-    }
668
-
669
-
670
-    /**
671
-     * in some case it may be necessary to overwrite the existing attention messages
672
-     *
673
-     * @return void
674
-     */
675
-    public static function overwrite_attention()
676
-    {
677
-        self::$_espresso_notices['attention'] = false;
678
-    }
679
-
680
-
681
-    /**
682
-     * in some case it may be necessary to overwrite the existing error messages
683
-     *
684
-     * @return void
685
-     */
686
-    public static function overwrite_errors()
687
-    {
688
-        self::$_espresso_notices['errors'] = false;
689
-    }
690
-
691
-
692
-    /**
693
-     * @return void
694
-     */
695
-    public static function reset_notices()
696
-    {
697
-        self::$_espresso_notices['success'] = false;
698
-        self::$_espresso_notices['attention'] = false;
699
-        self::$_espresso_notices['errors'] = false;
700
-    }
701
-
702
-
703
-    /**
704
-     * @return int
705
-     */
706
-    public static function has_notices()
707
-    {
708
-        $has_notices = 0;
709
-        // check for success messages
710
-        $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
711
-            ? 3
712
-            : $has_notices;
713
-        // check for attention messages
714
-        $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
715
-            ? 2
716
-            : $has_notices;
717
-        // check for error messages
718
-        $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
719
-            ? 1
720
-            : $has_notices;
721
-        return $has_notices;
722
-    }
723
-
724
-
725
-    /**
726
-     * This simply returns non formatted error notices as they were sent into the EE_Error object.
727
-     *
728
-     * @since 4.9.0
729
-     * @return array
730
-     */
731
-    public static function get_vanilla_notices()
732
-    {
733
-        return array(
734
-            'success'   => isset(self::$_espresso_notices['success'])
735
-                ? self::$_espresso_notices['success']
736
-                : array(),
737
-            'attention' => isset(self::$_espresso_notices['attention'])
738
-                ? self::$_espresso_notices['attention']
739
-                : array(),
740
-            'errors'    => isset(self::$_espresso_notices['errors'])
741
-                ? self::$_espresso_notices['errors']
742
-                : array(),
743
-        );
744
-    }
745
-
746
-
747
-    /**
748
-     * @return array
749
-     * @throws InvalidArgumentException
750
-     * @throws InvalidDataTypeException
751
-     * @throws InvalidInterfaceException
752
-     */
753
-    public static function getStoredNotices()
754
-    {
755
-        if ($user_id = get_current_user_id()) {
756
-            // get notices for logged in user
757
-            $notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
758
-            return is_array($notices) ? $notices : array();
759
-        }
760
-        if (EE_Session::isLoadedAndActive()) {
761
-            // get notices for user currently engaged in a session
762
-            $session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
763
-            return is_array($session_data) ? $session_data : array();
764
-        }
765
-        // get global notices and hope they apply to the current site visitor
766
-        $notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
767
-        return is_array($notices) ? $notices : array();
768
-    }
769
-
770
-
771
-    /**
772
-     * @param array $notices
773
-     * @return bool
774
-     * @throws InvalidArgumentException
775
-     * @throws InvalidDataTypeException
776
-     * @throws InvalidInterfaceException
777
-     */
778
-    public static function storeNotices(array $notices)
779
-    {
780
-        if ($user_id = get_current_user_id()) {
781
-            // store notices for logged in user
782
-            return (bool) update_user_option(
783
-                $user_id,
784
-                EE_Error::OPTIONS_KEY_NOTICES,
785
-                $notices
786
-            );
787
-        }
788
-        if (EE_Session::isLoadedAndActive()) {
789
-            // store notices for user currently engaged in a session
790
-            return EE_Session::instance()->set_session_data(
791
-                array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
792
-            );
793
-        }
794
-        // store global notices and hope they apply to the same site visitor on the next request
795
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
796
-    }
797
-
798
-
799
-    /**
800
-     * @return bool|TRUE
801
-     * @throws InvalidArgumentException
802
-     * @throws InvalidDataTypeException
803
-     * @throws InvalidInterfaceException
804
-     */
805
-    public static function clearNotices()
806
-    {
807
-        if ($user_id = get_current_user_id()) {
808
-            // clear notices for logged in user
809
-            return (bool) update_user_option(
810
-                $user_id,
811
-                EE_Error::OPTIONS_KEY_NOTICES,
812
-                array()
813
-            );
814
-        }
815
-        if (EE_Session::isLoadedAndActive()) {
816
-            // clear notices for user currently engaged in a session
817
-            return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
818
-        }
819
-        // clear global notices and hope none belonged to some for some other site visitor
820
-        return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
821
-    }
822
-
823
-
824
-    /**
825
-     * saves notices to the db for retrieval on next request
826
-     *
827
-     * @return void
828
-     * @throws InvalidArgumentException
829
-     * @throws InvalidDataTypeException
830
-     * @throws InvalidInterfaceException
831
-     */
832
-    public static function stashNoticesBeforeRedirect()
833
-    {
834
-        EE_Error::get_notices(false, true);
835
-    }
836
-
837
-
838
-    /**
839
-     * compile all error or success messages into one string
840
-     *
841
-     * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
842
-     * @param boolean $format_output            whether or not to format the messages for display in the WP admin
843
-     * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
844
-     *                                          - ONLY do this just before redirecting
845
-     * @param boolean $remove_empty             whether or not to unset empty messages
846
-     * @return array
847
-     * @throws InvalidArgumentException
848
-     * @throws InvalidDataTypeException
849
-     * @throws InvalidInterfaceException
850
-     */
851
-    public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
852
-    {
853
-        $success_messages = '';
854
-        $attention_messages = '';
855
-        $error_messages = '';
856
-        // either save notices to the db
857
-        if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
858
-            self::$_espresso_notices = array_merge(
859
-                EE_Error::getStoredNotices(),
860
-                self::$_espresso_notices
861
-            );
862
-            EE_Error::storeNotices(self::$_espresso_notices);
863
-            return array();
864
-        }
865
-        $print_scripts = EE_Error::combineExistingAndNewNotices();
866
-        // check for success messages
867
-        if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
868
-            // combine messages
869
-            $success_messages .= implode(self::$_espresso_notices['success'], '<br />');
870
-            $print_scripts = true;
871
-        }
872
-        // check for attention messages
873
-        if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
874
-            // combine messages
875
-            $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
876
-            $print_scripts = true;
877
-        }
878
-        // check for error messages
879
-        if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
880
-            $error_messages .= count(self::$_espresso_notices['errors']) > 1
881
-                ? __('The following errors have occurred:<br />', 'event_espresso')
882
-                : __('An error has occurred:<br />', 'event_espresso');
883
-            // combine messages
884
-            $error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
885
-            $print_scripts = true;
886
-        }
887
-        if ($format_output) {
888
-            $notices = EE_Error::formatNoticesOutput(
889
-                $success_messages,
890
-                $attention_messages,
891
-                $error_messages
892
-            );
893
-        } else {
894
-            $notices = array(
895
-                'success'   => $success_messages,
896
-                'attention' => $attention_messages,
897
-                'errors'    => $error_messages,
898
-            );
899
-            if ($remove_empty) {
900
-                // remove empty notices
901
-                foreach ($notices as $type => $notice) {
902
-                    if (empty($notice)) {
903
-                        unset($notices[ $type ]);
904
-                    }
905
-                }
906
-            }
907
-        }
908
-        if ($print_scripts) {
909
-            self::_print_scripts();
910
-        }
911
-        return $notices;
912
-    }
913
-
914
-
915
-    /**
916
-     * @return bool
917
-     * @throws InvalidArgumentException
918
-     * @throws InvalidDataTypeException
919
-     * @throws InvalidInterfaceException
920
-     */
921
-    private static function combineExistingAndNewNotices()
922
-    {
923
-        $print_scripts = false;
924
-        // grab any notices that have been previously saved
925
-        $notices = EE_Error::getStoredNotices();
926
-        if (! empty($notices)) {
927
-            foreach ($notices as $type => $notice) {
928
-                if (is_array($notice) && ! empty($notice)) {
929
-                    // make sure that existing notice type is an array
930
-                    self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
931
-                                                        && ! empty(self::$_espresso_notices[ $type ])
932
-                        ? self::$_espresso_notices[ $type ]
933
-                        : array();
934
-                    // add newly created notices to existing ones
935
-                    self::$_espresso_notices[ $type ] += $notice;
936
-                    $print_scripts = true;
937
-                }
938
-            }
939
-            // now clear any stored notices
940
-            EE_Error::clearNotices();
941
-        }
942
-        return $print_scripts;
943
-    }
944
-
945
-
946
-    /**
947
-     * @param string $success_messages
948
-     * @param string $attention_messages
949
-     * @param string $error_messages
950
-     * @return string
951
-     */
952
-    private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
953
-    {
954
-        $notices = '<div id="espresso-notices">';
955
-        $close = is_admin()
956
-            ? ''
957
-            : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
958
-        if ($success_messages !== '') {
959
-            $css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
960
-            $css_class = is_admin() ? 'updated fade' : 'success fade-away';
961
-            // showMessage( $success_messages );
962
-            $notices .= '<div id="' . $css_id . '" '
963
-                        . 'class="espresso-notices ' . $css_class . '" '
964
-                        . 'style="display:none;">'
965
-                        . '<p>' . $success_messages . '</p>'
966
-                        . $close
967
-                        . '</div>';
968
-        }
969
-        if ($attention_messages !== '') {
970
-            $css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
971
-            $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
972
-            // showMessage( $error_messages, TRUE );
973
-            $notices .= '<div id="' . $css_id . '" '
974
-                        . 'class="espresso-notices ' . $css_class . '" '
975
-                        . 'style="display:none;">'
976
-                        . '<p>' . $attention_messages . '</p>'
977
-                        . $close
978
-                        . '</div>';
979
-        }
980
-        if ($error_messages !== '') {
981
-            $css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
982
-            $css_class = is_admin() ? 'error' : 'error fade-away';
983
-            // showMessage( $error_messages, TRUE );
984
-            $notices .= '<div id="' . $css_id . '" '
985
-                        . 'class="espresso-notices ' . $css_class . '" '
986
-                        . 'style="display:none;">'
987
-                        . '<p>' . $error_messages . '</p>'
988
-                        . $close
989
-                        . '</div>';
990
-        }
991
-        $notices .= '</div>';
992
-        return $notices;
993
-    }
994
-
995
-
996
-    /**
997
-     * _print_scripts
998
-     *
999
-     * @param    bool $force_print
1000
-     * @return    string
1001
-     */
1002
-    private static function _print_scripts($force_print = false)
1003
-    {
1004
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
1005
-            if (wp_script_is('ee_error_js', 'enqueued')) {
1006
-                return '';
1007
-            }
1008
-            if (wp_script_is('ee_error_js', 'registered')) {
1009
-                wp_enqueue_style('espresso_default');
1010
-                wp_enqueue_style('espresso_custom_css');
1011
-                wp_enqueue_script('ee_error_js');
1012
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
1013
-            }
1014
-        } else {
1015
-            return '
471
+		$output .= self::_print_scripts(true);
472
+		if (defined('DOING_AJAX')) {
473
+			echo wp_json_encode(array('error' => $output));
474
+			exit();
475
+		}
476
+		echo $output;
477
+		die();
478
+	}
479
+
480
+
481
+	/**
482
+	 *    generate string from exception trace args
483
+	 *
484
+	 * @param array $arguments
485
+	 * @param bool  $array
486
+	 * @return string
487
+	 */
488
+	private function _convert_args_to_string($arguments = array(), $array = false)
489
+	{
490
+		$arg_string = '';
491
+		if (! empty($arguments)) {
492
+			$args = array();
493
+			foreach ($arguments as $arg) {
494
+				if (! empty($arg)) {
495
+					if (is_string($arg)) {
496
+						$args[] = " '" . $arg . "'";
497
+					} elseif (is_array($arg)) {
498
+						$args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true);
499
+					} elseif ($arg === null) {
500
+						$args[] = ' NULL';
501
+					} elseif (is_bool($arg)) {
502
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
503
+					} elseif (is_object($arg)) {
504
+						$args[] = ' OBJECT ' . get_class($arg);
505
+					} elseif (is_resource($arg)) {
506
+						$args[] = get_resource_type($arg);
507
+					} else {
508
+						$args[] = $arg;
509
+					}
510
+				}
511
+			}
512
+			$arg_string = implode(', ', $args);
513
+		}
514
+		if ($array) {
515
+			$arg_string .= ' )';
516
+		}
517
+		return $arg_string;
518
+	}
519
+
520
+
521
+	/**
522
+	 *    add error message
523
+	 *
524
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
525
+	 *                            separate messages for user || dev
526
+	 * @param        string $file the file that the error occurred in - just use __FILE__
527
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
528
+	 * @param        string $line the line number where the error occurred - just use __LINE__
529
+	 * @return        void
530
+	 */
531
+	public static function add_error($msg = null, $file = null, $func = null, $line = null)
532
+	{
533
+		self::_add_notice('errors', $msg, $file, $func, $line);
534
+		self::$_error_count++;
535
+	}
536
+
537
+
538
+	/**
539
+	 * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just
540
+	 * adds an error
541
+	 *
542
+	 * @param string $msg
543
+	 * @param string $file
544
+	 * @param string $func
545
+	 * @param string $line
546
+	 * @throws EE_Error
547
+	 */
548
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null)
549
+	{
550
+		if (WP_DEBUG) {
551
+			throw new EE_Error($msg);
552
+		}
553
+		EE_Error::add_error($msg, $file, $func, $line);
554
+	}
555
+
556
+
557
+	/**
558
+	 *    add success message
559
+	 *
560
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
561
+	 *                            separate messages for user || dev
562
+	 * @param        string $file the file that the error occurred in - just use __FILE__
563
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
564
+	 * @param        string $line the line number where the error occurred - just use __LINE__
565
+	 * @return        void
566
+	 */
567
+	public static function add_success($msg = null, $file = null, $func = null, $line = null)
568
+	{
569
+		self::_add_notice('success', $msg, $file, $func, $line);
570
+	}
571
+
572
+
573
+	/**
574
+	 *    add attention message
575
+	 *
576
+	 * @param        string $msg  the message to display to users or developers - adding a double pipe || (OR) creates
577
+	 *                            separate messages for user || dev
578
+	 * @param        string $file the file that the error occurred in - just use __FILE__
579
+	 * @param        string $func the function/method that the error occurred in - just use __FUNCTION__
580
+	 * @param        string $line the line number where the error occurred - just use __LINE__
581
+	 * @return        void
582
+	 */
583
+	public static function add_attention($msg = null, $file = null, $func = null, $line = null)
584
+	{
585
+		self::_add_notice('attention', $msg, $file, $func, $line);
586
+	}
587
+
588
+
589
+	/**
590
+	 * @param string $type whether the message is for a success or error notification
591
+	 * @param string $msg  the message to display to users or developers
592
+	 *                     - adding a double pipe || (OR) creates separate messages for user || dev
593
+	 * @param string $file the file that the error occurred in - just use __FILE__
594
+	 * @param string $func the function/method that the error occurred in - just use __FUNCTION__
595
+	 * @param string $line the line number where the error occurred - just use __LINE__
596
+	 * @return void
597
+	 */
598
+	private static function _add_notice($type = 'success', $msg = '', $file = '', $func = '', $line = '')
599
+	{
600
+		if (empty($msg)) {
601
+			EE_Error::doing_it_wrong(
602
+				'EE_Error::add_' . $type . '()',
603
+				sprintf(
604
+					__(
605
+						'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d',
606
+						'event_espresso'
607
+					),
608
+					$type,
609
+					$file,
610
+					$line
611
+				),
612
+				EVENT_ESPRESSO_VERSION
613
+			);
614
+		}
615
+		if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) {
616
+			EE_Error::doing_it_wrong(
617
+				'EE_Error::add_error()',
618
+				__(
619
+					'You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.',
620
+					'event_espresso'
621
+				),
622
+				EVENT_ESPRESSO_VERSION
623
+			);
624
+		}
625
+		// get separate user and developer messages if they exist
626
+		$msg = explode('||', $msg);
627
+		$user_msg = $msg[0];
628
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
629
+		/**
630
+		 * Do an action so other code can be triggered when a notice is created
631
+		 *
632
+		 * @param string $type     can be 'errors', 'attention', or 'success'
633
+		 * @param string $user_msg message displayed to user when WP_DEBUG is off
634
+		 * @param string $user_msg message displayed to user when WP_DEBUG is on
635
+		 * @param string $file     file where error was generated
636
+		 * @param string $func     function where error was generated
637
+		 * @param string $line     line where error was generated
638
+		 */
639
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
640
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
641
+		// add notice if message exists
642
+		if (! empty($msg)) {
643
+			// get error code
644
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
645
+			if (WP_DEBUG && $type === 'errors') {
646
+				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
647
+			}
648
+			// add notice. Index by code if it's not blank
649
+			if ($notice_code) {
650
+				self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
651
+			} else {
652
+				self::$_espresso_notices[ $type ][] = $msg;
653
+			}
654
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
655
+		}
656
+	}
657
+
658
+
659
+	/**
660
+	 * in some case it may be necessary to overwrite the existing success messages
661
+	 *
662
+	 * @return        void
663
+	 */
664
+	public static function overwrite_success()
665
+	{
666
+		self::$_espresso_notices['success'] = false;
667
+	}
668
+
669
+
670
+	/**
671
+	 * in some case it may be necessary to overwrite the existing attention messages
672
+	 *
673
+	 * @return void
674
+	 */
675
+	public static function overwrite_attention()
676
+	{
677
+		self::$_espresso_notices['attention'] = false;
678
+	}
679
+
680
+
681
+	/**
682
+	 * in some case it may be necessary to overwrite the existing error messages
683
+	 *
684
+	 * @return void
685
+	 */
686
+	public static function overwrite_errors()
687
+	{
688
+		self::$_espresso_notices['errors'] = false;
689
+	}
690
+
691
+
692
+	/**
693
+	 * @return void
694
+	 */
695
+	public static function reset_notices()
696
+	{
697
+		self::$_espresso_notices['success'] = false;
698
+		self::$_espresso_notices['attention'] = false;
699
+		self::$_espresso_notices['errors'] = false;
700
+	}
701
+
702
+
703
+	/**
704
+	 * @return int
705
+	 */
706
+	public static function has_notices()
707
+	{
708
+		$has_notices = 0;
709
+		// check for success messages
710
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])
711
+			? 3
712
+			: $has_notices;
713
+		// check for attention messages
714
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])
715
+			? 2
716
+			: $has_notices;
717
+		// check for error messages
718
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])
719
+			? 1
720
+			: $has_notices;
721
+		return $has_notices;
722
+	}
723
+
724
+
725
+	/**
726
+	 * This simply returns non formatted error notices as they were sent into the EE_Error object.
727
+	 *
728
+	 * @since 4.9.0
729
+	 * @return array
730
+	 */
731
+	public static function get_vanilla_notices()
732
+	{
733
+		return array(
734
+			'success'   => isset(self::$_espresso_notices['success'])
735
+				? self::$_espresso_notices['success']
736
+				: array(),
737
+			'attention' => isset(self::$_espresso_notices['attention'])
738
+				? self::$_espresso_notices['attention']
739
+				: array(),
740
+			'errors'    => isset(self::$_espresso_notices['errors'])
741
+				? self::$_espresso_notices['errors']
742
+				: array(),
743
+		);
744
+	}
745
+
746
+
747
+	/**
748
+	 * @return array
749
+	 * @throws InvalidArgumentException
750
+	 * @throws InvalidDataTypeException
751
+	 * @throws InvalidInterfaceException
752
+	 */
753
+	public static function getStoredNotices()
754
+	{
755
+		if ($user_id = get_current_user_id()) {
756
+			// get notices for logged in user
757
+			$notices = get_user_option(EE_Error::OPTIONS_KEY_NOTICES, $user_id);
758
+			return is_array($notices) ? $notices : array();
759
+		}
760
+		if (EE_Session::isLoadedAndActive()) {
761
+			// get notices for user currently engaged in a session
762
+			$session_data = EE_Session::instance()->get_session_data(EE_Error::OPTIONS_KEY_NOTICES);
763
+			return is_array($session_data) ? $session_data : array();
764
+		}
765
+		// get global notices and hope they apply to the current site visitor
766
+		$notices = get_option(EE_Error::OPTIONS_KEY_NOTICES, array());
767
+		return is_array($notices) ? $notices : array();
768
+	}
769
+
770
+
771
+	/**
772
+	 * @param array $notices
773
+	 * @return bool
774
+	 * @throws InvalidArgumentException
775
+	 * @throws InvalidDataTypeException
776
+	 * @throws InvalidInterfaceException
777
+	 */
778
+	public static function storeNotices(array $notices)
779
+	{
780
+		if ($user_id = get_current_user_id()) {
781
+			// store notices for logged in user
782
+			return (bool) update_user_option(
783
+				$user_id,
784
+				EE_Error::OPTIONS_KEY_NOTICES,
785
+				$notices
786
+			);
787
+		}
788
+		if (EE_Session::isLoadedAndActive()) {
789
+			// store notices for user currently engaged in a session
790
+			return EE_Session::instance()->set_session_data(
791
+				array(EE_Error::OPTIONS_KEY_NOTICES => $notices)
792
+			);
793
+		}
794
+		// store global notices and hope they apply to the same site visitor on the next request
795
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, $notices);
796
+	}
797
+
798
+
799
+	/**
800
+	 * @return bool|TRUE
801
+	 * @throws InvalidArgumentException
802
+	 * @throws InvalidDataTypeException
803
+	 * @throws InvalidInterfaceException
804
+	 */
805
+	public static function clearNotices()
806
+	{
807
+		if ($user_id = get_current_user_id()) {
808
+			// clear notices for logged in user
809
+			return (bool) update_user_option(
810
+				$user_id,
811
+				EE_Error::OPTIONS_KEY_NOTICES,
812
+				array()
813
+			);
814
+		}
815
+		if (EE_Session::isLoadedAndActive()) {
816
+			// clear notices for user currently engaged in a session
817
+			return EE_Session::instance()->reset_data(EE_Error::OPTIONS_KEY_NOTICES);
818
+		}
819
+		// clear global notices and hope none belonged to some for some other site visitor
820
+		return update_option(EE_Error::OPTIONS_KEY_NOTICES, array());
821
+	}
822
+
823
+
824
+	/**
825
+	 * saves notices to the db for retrieval on next request
826
+	 *
827
+	 * @return void
828
+	 * @throws InvalidArgumentException
829
+	 * @throws InvalidDataTypeException
830
+	 * @throws InvalidInterfaceException
831
+	 */
832
+	public static function stashNoticesBeforeRedirect()
833
+	{
834
+		EE_Error::get_notices(false, true);
835
+	}
836
+
837
+
838
+	/**
839
+	 * compile all error or success messages into one string
840
+	 *
841
+	 * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them
842
+	 * @param boolean $format_output            whether or not to format the messages for display in the WP admin
843
+	 * @param boolean $save_to_transient        whether or not to save notices to the db for retrieval on next request
844
+	 *                                          - ONLY do this just before redirecting
845
+	 * @param boolean $remove_empty             whether or not to unset empty messages
846
+	 * @return array
847
+	 * @throws InvalidArgumentException
848
+	 * @throws InvalidDataTypeException
849
+	 * @throws InvalidInterfaceException
850
+	 */
851
+	public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true)
852
+	{
853
+		$success_messages = '';
854
+		$attention_messages = '';
855
+		$error_messages = '';
856
+		// either save notices to the db
857
+		if ($save_to_transient || isset($_REQUEST['activate-selected'])) {
858
+			self::$_espresso_notices = array_merge(
859
+				EE_Error::getStoredNotices(),
860
+				self::$_espresso_notices
861
+			);
862
+			EE_Error::storeNotices(self::$_espresso_notices);
863
+			return array();
864
+		}
865
+		$print_scripts = EE_Error::combineExistingAndNewNotices();
866
+		// check for success messages
867
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
868
+			// combine messages
869
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br />');
870
+			$print_scripts = true;
871
+		}
872
+		// check for attention messages
873
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
874
+			// combine messages
875
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
876
+			$print_scripts = true;
877
+		}
878
+		// check for error messages
879
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
880
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1
881
+				? __('The following errors have occurred:<br />', 'event_espresso')
882
+				: __('An error has occurred:<br />', 'event_espresso');
883
+			// combine messages
884
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
885
+			$print_scripts = true;
886
+		}
887
+		if ($format_output) {
888
+			$notices = EE_Error::formatNoticesOutput(
889
+				$success_messages,
890
+				$attention_messages,
891
+				$error_messages
892
+			);
893
+		} else {
894
+			$notices = array(
895
+				'success'   => $success_messages,
896
+				'attention' => $attention_messages,
897
+				'errors'    => $error_messages,
898
+			);
899
+			if ($remove_empty) {
900
+				// remove empty notices
901
+				foreach ($notices as $type => $notice) {
902
+					if (empty($notice)) {
903
+						unset($notices[ $type ]);
904
+					}
905
+				}
906
+			}
907
+		}
908
+		if ($print_scripts) {
909
+			self::_print_scripts();
910
+		}
911
+		return $notices;
912
+	}
913
+
914
+
915
+	/**
916
+	 * @return bool
917
+	 * @throws InvalidArgumentException
918
+	 * @throws InvalidDataTypeException
919
+	 * @throws InvalidInterfaceException
920
+	 */
921
+	private static function combineExistingAndNewNotices()
922
+	{
923
+		$print_scripts = false;
924
+		// grab any notices that have been previously saved
925
+		$notices = EE_Error::getStoredNotices();
926
+		if (! empty($notices)) {
927
+			foreach ($notices as $type => $notice) {
928
+				if (is_array($notice) && ! empty($notice)) {
929
+					// make sure that existing notice type is an array
930
+					self::$_espresso_notices[ $type ] = is_array(self::$_espresso_notices[ $type ])
931
+														&& ! empty(self::$_espresso_notices[ $type ])
932
+						? self::$_espresso_notices[ $type ]
933
+						: array();
934
+					// add newly created notices to existing ones
935
+					self::$_espresso_notices[ $type ] += $notice;
936
+					$print_scripts = true;
937
+				}
938
+			}
939
+			// now clear any stored notices
940
+			EE_Error::clearNotices();
941
+		}
942
+		return $print_scripts;
943
+	}
944
+
945
+
946
+	/**
947
+	 * @param string $success_messages
948
+	 * @param string $attention_messages
949
+	 * @param string $error_messages
950
+	 * @return string
951
+	 */
952
+	private static function formatNoticesOutput($success_messages, $attention_messages, $error_messages)
953
+	{
954
+		$notices = '<div id="espresso-notices">';
955
+		$close = is_admin()
956
+			? ''
957
+			: '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"/></a>';
958
+		if ($success_messages !== '') {
959
+			$css_id = is_admin() ? 'ee-success-message' : 'espresso-notices-success';
960
+			$css_class = is_admin() ? 'updated fade' : 'success fade-away';
961
+			// showMessage( $success_messages );
962
+			$notices .= '<div id="' . $css_id . '" '
963
+						. 'class="espresso-notices ' . $css_class . '" '
964
+						. 'style="display:none;">'
965
+						. '<p>' . $success_messages . '</p>'
966
+						. $close
967
+						. '</div>';
968
+		}
969
+		if ($attention_messages !== '') {
970
+			$css_id = is_admin() ? 'ee-attention-message' : 'espresso-notices-attention';
971
+			$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
972
+			// showMessage( $error_messages, TRUE );
973
+			$notices .= '<div id="' . $css_id . '" '
974
+						. 'class="espresso-notices ' . $css_class . '" '
975
+						. 'style="display:none;">'
976
+						. '<p>' . $attention_messages . '</p>'
977
+						. $close
978
+						. '</div>';
979
+		}
980
+		if ($error_messages !== '') {
981
+			$css_id = is_admin() ? 'ee-error-message' : 'espresso-notices-error';
982
+			$css_class = is_admin() ? 'error' : 'error fade-away';
983
+			// showMessage( $error_messages, TRUE );
984
+			$notices .= '<div id="' . $css_id . '" '
985
+						. 'class="espresso-notices ' . $css_class . '" '
986
+						. 'style="display:none;">'
987
+						. '<p>' . $error_messages . '</p>'
988
+						. $close
989
+						. '</div>';
990
+		}
991
+		$notices .= '</div>';
992
+		return $notices;
993
+	}
994
+
995
+
996
+	/**
997
+	 * _print_scripts
998
+	 *
999
+	 * @param    bool $force_print
1000
+	 * @return    string
1001
+	 */
1002
+	private static function _print_scripts($force_print = false)
1003
+	{
1004
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
1005
+			if (wp_script_is('ee_error_js', 'enqueued')) {
1006
+				return '';
1007
+			}
1008
+			if (wp_script_is('ee_error_js', 'registered')) {
1009
+				wp_enqueue_style('espresso_default');
1010
+				wp_enqueue_style('espresso_custom_css');
1011
+				wp_enqueue_script('ee_error_js');
1012
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
1013
+			}
1014
+		} else {
1015
+			return '
1016 1016
 <script>
1017 1017
 /* <![CDATA[ */
1018 1018
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -1022,221 +1022,221 @@  discard block
 block discarded – undo
1022 1022
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
1023 1023
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
1024 1024
 ';
1025
-        }
1026
-        return '';
1027
-    }
1028
-
1029
-
1030
-    /**
1031
-     * @return void
1032
-     */
1033
-    public static function enqueue_error_scripts()
1034
-    {
1035
-        self::_print_scripts();
1036
-    }
1037
-
1038
-
1039
-    /**
1040
-     * create error code from filepath, function name,
1041
-     * and line number where exception or error was thrown
1042
-     *
1043
-     * @param string $file
1044
-     * @param string $func
1045
-     * @param string $line
1046
-     * @return string
1047
-     */
1048
-    public static function generate_error_code($file = '', $func = '', $line = '')
1049
-    {
1050
-        $file = explode('.', basename($file));
1051
-        $error_code = ! empty($file[0]) ? $file[0] : '';
1052
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
1053
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
1054
-        return $error_code;
1055
-    }
1056
-
1057
-
1058
-    /**
1059
-     * write exception details to log file
1060
-     * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
1061
-     *
1062
-     * @param int   $time
1063
-     * @param array $ex
1064
-     * @param bool  $clear
1065
-     * @return void
1066
-     */
1067
-    public function write_to_error_log($time = 0, $ex = array(), $clear = false)
1068
-    {
1069
-        if (empty($ex)) {
1070
-            return;
1071
-        }
1072
-        if (! $time) {
1073
-            $time = time();
1074
-        }
1075
-        $exception_log = '----------------------------------------------------------------------------------------'
1076
-                         . PHP_EOL;
1077
-        $exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
1078
-        $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
1079
-        $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
1080
-        $exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
1081
-        $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
1082
-        $exception_log .= 'Stack trace: ' . PHP_EOL;
1083
-        $exception_log .= $ex['string'] . PHP_EOL;
1084
-        $exception_log .= '----------------------------------------------------------------------------------------'
1085
-                          . PHP_EOL;
1086
-        try {
1087
-            error_log($exception_log);
1088
-        } catch (EE_Error $e) {
1089
-            EE_Error::add_error(
1090
-                sprintf(
1091
-                    __(
1092
-                        'Event Espresso error logging could not be setup because: %s',
1093
-                        'event_espresso'
1094
-                    ),
1095
-                    $e->getMessage()
1096
-                )
1097
-            );
1098
-        }
1099
-    }
1100
-
1101
-
1102
-    /**
1103
-     * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
1104
-     * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
1105
-     * but the code execution is done in a manner that could lead to unexpected results
1106
-     * (i.e. running to early, or too late in WP or EE loading process).
1107
-     * A good test for knowing whether to use this method is:
1108
-     * 1. Is there going to be a PHP error if something isn't setup/used correctly?
1109
-     * Yes -> use EE_Error::add_error() or throw new EE_Error()
1110
-     * 2. If this is loaded before something else, it won't break anything,
1111
-     * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
1112
-     *
1113
-     * @uses   constant WP_DEBUG test if wp_debug is on or not
1114
-     * @param string $function      The function that was called
1115
-     * @param string $message       A message explaining what has been done incorrectly
1116
-     * @param string $version       The version of Event Espresso where the error was added
1117
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
1118
-     *                              for a deprecated function. This allows deprecation to occur during one version,
1119
-     *                              but not have any notices appear until a later version. This allows developers
1120
-     *                              extra time to update their code before notices appear.
1121
-     * @param int    $error_type
1122
-     */
1123
-    public static function doing_it_wrong(
1124
-        $function,
1125
-        $message,
1126
-        $version,
1127
-        $applies_when = '',
1128
-        $error_type = null
1129
-    ) {
1130
-        if (defined('WP_DEBUG') && WP_DEBUG) {
1131
-            EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
1132
-        }
1133
-    }
1134
-
1135
-
1136
-    /**
1137
-     * Like get_notices, but returns an array of all the notices of the given type.
1138
-     *
1139
-     * @return array {
1140
-     * @type array $success   all the success messages
1141
-     * @type array $errors    all the error messages
1142
-     * @type array $attention all the attention messages
1143
-     * }
1144
-     */
1145
-    public static function get_raw_notices()
1146
-    {
1147
-        return self::$_espresso_notices;
1148
-    }
1149
-
1150
-
1151
-    /**
1152
-     * @deprecated 4.9.27
1153
-     * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
1154
-     * @param string $pan_message  the message to be stored persistently until dismissed
1155
-     * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
1156
-     * @return void
1157
-     * @throws InvalidDataTypeException
1158
-     */
1159
-    public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
1160
-    {
1161
-        new PersistentAdminNotice(
1162
-            $pan_name,
1163
-            $pan_message,
1164
-            $force_update
1165
-        );
1166
-        EE_Error::doing_it_wrong(
1167
-            __METHOD__,
1168
-            sprintf(
1169
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1170
-                '\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
1171
-            ),
1172
-            '4.9.27'
1173
-        );
1174
-    }
1175
-
1176
-
1177
-    /**
1178
-     * @deprecated 4.9.27
1179
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
1180
-     * @param bool   $purge
1181
-     * @param bool   $return
1182
-     * @throws DomainException
1183
-     * @throws InvalidInterfaceException
1184
-     * @throws InvalidDataTypeException
1185
-     * @throws ServiceNotFoundException
1186
-     * @throws InvalidArgumentException
1187
-     */
1188
-    public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
1189
-    {
1190
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
1191
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
1192
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1193
-        );
1194
-        $persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
1195
-        EE_Error::doing_it_wrong(
1196
-            __METHOD__,
1197
-            sprintf(
1198
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1199
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1200
-            ),
1201
-            '4.9.27'
1202
-        );
1203
-    }
1204
-
1205
-
1206
-    /**
1207
-     * @deprecated 4.9.27
1208
-     * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
1209
-     * @param  string $pan_message the message to be stored persistently until dismissed
1210
-     * @param  string $return_url  URL to go back to after nag notice is dismissed
1211
-     */
1212
-    public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
1213
-    {
1214
-        EE_Error::doing_it_wrong(
1215
-            __METHOD__,
1216
-            sprintf(
1217
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1218
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1219
-            ),
1220
-            '4.9.27'
1221
-        );
1222
-    }
1223
-
1224
-
1225
-    /**
1226
-     * @deprecated 4.9.27
1227
-     * @param string $return_url
1228
-     */
1229
-    public static function get_persistent_admin_notices($return_url = '')
1230
-    {
1231
-        EE_Error::doing_it_wrong(
1232
-            __METHOD__,
1233
-            sprintf(
1234
-                __('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1235
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1236
-            ),
1237
-            '4.9.27'
1238
-        );
1239
-    }
1025
+		}
1026
+		return '';
1027
+	}
1028
+
1029
+
1030
+	/**
1031
+	 * @return void
1032
+	 */
1033
+	public static function enqueue_error_scripts()
1034
+	{
1035
+		self::_print_scripts();
1036
+	}
1037
+
1038
+
1039
+	/**
1040
+	 * create error code from filepath, function name,
1041
+	 * and line number where exception or error was thrown
1042
+	 *
1043
+	 * @param string $file
1044
+	 * @param string $func
1045
+	 * @param string $line
1046
+	 * @return string
1047
+	 */
1048
+	public static function generate_error_code($file = '', $func = '', $line = '')
1049
+	{
1050
+		$file = explode('.', basename($file));
1051
+		$error_code = ! empty($file[0]) ? $file[0] : '';
1052
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
1053
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
1054
+		return $error_code;
1055
+	}
1056
+
1057
+
1058
+	/**
1059
+	 * write exception details to log file
1060
+	 * Since 4.9.53.rc.006 this writes to the standard PHP log file, not EE's custom log file
1061
+	 *
1062
+	 * @param int   $time
1063
+	 * @param array $ex
1064
+	 * @param bool  $clear
1065
+	 * @return void
1066
+	 */
1067
+	public function write_to_error_log($time = 0, $ex = array(), $clear = false)
1068
+	{
1069
+		if (empty($ex)) {
1070
+			return;
1071
+		}
1072
+		if (! $time) {
1073
+			$time = time();
1074
+		}
1075
+		$exception_log = '----------------------------------------------------------------------------------------'
1076
+						 . PHP_EOL;
1077
+		$exception_log .= '[' . date('Y-m-d H:i:s', $time) . ']  Exception Details' . PHP_EOL;
1078
+		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
1079
+		$exception_log .= 'Code: ' . $ex['code'] . PHP_EOL;
1080
+		$exception_log .= 'File: ' . $ex['file'] . PHP_EOL;
1081
+		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
1082
+		$exception_log .= 'Stack trace: ' . PHP_EOL;
1083
+		$exception_log .= $ex['string'] . PHP_EOL;
1084
+		$exception_log .= '----------------------------------------------------------------------------------------'
1085
+						  . PHP_EOL;
1086
+		try {
1087
+			error_log($exception_log);
1088
+		} catch (EE_Error $e) {
1089
+			EE_Error::add_error(
1090
+				sprintf(
1091
+					__(
1092
+						'Event Espresso error logging could not be setup because: %s',
1093
+						'event_espresso'
1094
+					),
1095
+					$e->getMessage()
1096
+				)
1097
+			);
1098
+		}
1099
+	}
1100
+
1101
+
1102
+	/**
1103
+	 * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method.
1104
+	 * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown,
1105
+	 * but the code execution is done in a manner that could lead to unexpected results
1106
+	 * (i.e. running to early, or too late in WP or EE loading process).
1107
+	 * A good test for knowing whether to use this method is:
1108
+	 * 1. Is there going to be a PHP error if something isn't setup/used correctly?
1109
+	 * Yes -> use EE_Error::add_error() or throw new EE_Error()
1110
+	 * 2. If this is loaded before something else, it won't break anything,
1111
+	 * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong()
1112
+	 *
1113
+	 * @uses   constant WP_DEBUG test if wp_debug is on or not
1114
+	 * @param string $function      The function that was called
1115
+	 * @param string $message       A message explaining what has been done incorrectly
1116
+	 * @param string $version       The version of Event Espresso where the error was added
1117
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
1118
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
1119
+	 *                              but not have any notices appear until a later version. This allows developers
1120
+	 *                              extra time to update their code before notices appear.
1121
+	 * @param int    $error_type
1122
+	 */
1123
+	public static function doing_it_wrong(
1124
+		$function,
1125
+		$message,
1126
+		$version,
1127
+		$applies_when = '',
1128
+		$error_type = null
1129
+	) {
1130
+		if (defined('WP_DEBUG') && WP_DEBUG) {
1131
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
1132
+		}
1133
+	}
1134
+
1135
+
1136
+	/**
1137
+	 * Like get_notices, but returns an array of all the notices of the given type.
1138
+	 *
1139
+	 * @return array {
1140
+	 * @type array $success   all the success messages
1141
+	 * @type array $errors    all the error messages
1142
+	 * @type array $attention all the attention messages
1143
+	 * }
1144
+	 */
1145
+	public static function get_raw_notices()
1146
+	{
1147
+		return self::$_espresso_notices;
1148
+	}
1149
+
1150
+
1151
+	/**
1152
+	 * @deprecated 4.9.27
1153
+	 * @param string $pan_name     the name, or key of the Persistent Admin Notice to be stored
1154
+	 * @param string $pan_message  the message to be stored persistently until dismissed
1155
+	 * @param bool   $force_update allows one to enforce the reappearance of a persistent message.
1156
+	 * @return void
1157
+	 * @throws InvalidDataTypeException
1158
+	 */
1159
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false)
1160
+	{
1161
+		new PersistentAdminNotice(
1162
+			$pan_name,
1163
+			$pan_message,
1164
+			$force_update
1165
+		);
1166
+		EE_Error::doing_it_wrong(
1167
+			__METHOD__,
1168
+			sprintf(
1169
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1170
+				'\EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
1171
+			),
1172
+			'4.9.27'
1173
+		);
1174
+	}
1175
+
1176
+
1177
+	/**
1178
+	 * @deprecated 4.9.27
1179
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
1180
+	 * @param bool   $purge
1181
+	 * @param bool   $return
1182
+	 * @throws DomainException
1183
+	 * @throws InvalidInterfaceException
1184
+	 * @throws InvalidDataTypeException
1185
+	 * @throws ServiceNotFoundException
1186
+	 * @throws InvalidArgumentException
1187
+	 */
1188
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return = false)
1189
+	{
1190
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
1191
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
1192
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1193
+		);
1194
+		$persistent_admin_notice_manager->dismissNotice($pan_name, $purge, $return);
1195
+		EE_Error::doing_it_wrong(
1196
+			__METHOD__,
1197
+			sprintf(
1198
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1199
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1200
+			),
1201
+			'4.9.27'
1202
+		);
1203
+	}
1204
+
1205
+
1206
+	/**
1207
+	 * @deprecated 4.9.27
1208
+	 * @param  string $pan_name    the name, or key of the Persistent Admin Notice to be stored
1209
+	 * @param  string $pan_message the message to be stored persistently until dismissed
1210
+	 * @param  string $return_url  URL to go back to after nag notice is dismissed
1211
+	 */
1212
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '')
1213
+	{
1214
+		EE_Error::doing_it_wrong(
1215
+			__METHOD__,
1216
+			sprintf(
1217
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1218
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1219
+			),
1220
+			'4.9.27'
1221
+		);
1222
+	}
1223
+
1224
+
1225
+	/**
1226
+	 * @deprecated 4.9.27
1227
+	 * @param string $return_url
1228
+	 */
1229
+	public static function get_persistent_admin_notices($return_url = '')
1230
+	{
1231
+		EE_Error::doing_it_wrong(
1232
+			__METHOD__,
1233
+			sprintf(
1234
+				__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
1235
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
1236
+			),
1237
+			'4.9.27'
1238
+		);
1239
+	}
1240 1240
 }
1241 1241
 
1242 1242
 // end of Class EE_Exceptions
@@ -1249,27 +1249,27 @@  discard block
 block discarded – undo
1249 1249
  */
1250 1250
 function espresso_error_enqueue_scripts()
1251 1251
 {
1252
-    // js for error handling
1253
-    wp_register_script(
1254
-        'espresso_core',
1255
-        EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
1256
-        array('jquery'),
1257
-        EVENT_ESPRESSO_VERSION,
1258
-        false
1259
-    );
1260
-    wp_register_script(
1261
-        'ee_error_js',
1262
-        EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
1263
-        array('espresso_core'),
1264
-        EVENT_ESPRESSO_VERSION,
1265
-        false
1266
-    );
1252
+	// js for error handling
1253
+	wp_register_script(
1254
+		'espresso_core',
1255
+		EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
1256
+		array('jquery'),
1257
+		EVENT_ESPRESSO_VERSION,
1258
+		false
1259
+	);
1260
+	wp_register_script(
1261
+		'ee_error_js',
1262
+		EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
1263
+		array('espresso_core'),
1264
+		EVENT_ESPRESSO_VERSION,
1265
+		false
1266
+	);
1267 1267
 }
1268 1268
 
1269 1269
 if (is_admin()) {
1270
-    add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
1270
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
1271 1271
 } else {
1272
-    add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
1272
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 5);
1273 1273
 }
1274 1274
 
1275 1275
 
Please login to merge, or discard this patch.
caffeinated/modules/events_archive_caff/EED_Events_Archive_Caff.module.php 2 patches
Indentation   +234 added lines, -234 removed lines patch added patch discarded remove patch
@@ -13,249 +13,249 @@
 block discarded – undo
13 13
 class EED_Events_Archive_Caff extends EED_Events_Archive
14 14
 {
15 15
 
16
-    /**
17
-     * @return EED_Events_Archive_Caff|EED_Module
18
-     */
19
-    public static function instance()
20
-    {
21
-        return parent::get_instance(__CLASS__);
22
-    }
16
+	/**
17
+	 * @return EED_Events_Archive_Caff|EED_Module
18
+	 */
19
+	public static function instance()
20
+	{
21
+		return parent::get_instance(__CLASS__);
22
+	}
23 23
 
24 24
 
25
-    /**
26
-     * set_hooks - for hooking into EE Core, other modules, etc
27
-     *
28
-     * @return    void
29
-     */
30
-    public static function set_hooks()
31
-    {
32
-    }
25
+	/**
26
+	 * set_hooks - for hooking into EE Core, other modules, etc
27
+	 *
28
+	 * @return    void
29
+	 */
30
+	public static function set_hooks()
31
+	{
32
+	}
33 33
 
34
-    /**
35
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
36
-     *
37
-     * @access    public
38
-     * @return    void
39
-     */
40
-    public static function set_hooks_admin()
41
-    {
42
-        define(
43
-            'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
44
-            str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS
45
-        );
46
-        define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
47
-        add_action(
48
-            'AHEE__template_settings__template__before_settings_form',
49
-            array('EED_Events_Archive_Caff', 'template_settings_form'),
50
-            10
51
-        );
52
-        add_filter(
53
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
54
-            array('EED_Events_Archive_Caff', 'update_template_settings'),
55
-            10,
56
-            2
57
-        );
58
-        // AJAX
59
-        add_action(
60
-            'wp_ajax_espresso_update_event_archive_order',
61
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
62
-        );
63
-        add_action(
64
-            'wp_ajax_nopriv_espresso_update_event_archive_order',
65
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
66
-        );
67
-    }
34
+	/**
35
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
36
+	 *
37
+	 * @access    public
38
+	 * @return    void
39
+	 */
40
+	public static function set_hooks_admin()
41
+	{
42
+		define(
43
+			'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
44
+			str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS
45
+		);
46
+		define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
47
+		add_action(
48
+			'AHEE__template_settings__template__before_settings_form',
49
+			array('EED_Events_Archive_Caff', 'template_settings_form'),
50
+			10
51
+		);
52
+		add_filter(
53
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
54
+			array('EED_Events_Archive_Caff', 'update_template_settings'),
55
+			10,
56
+			2
57
+		);
58
+		// AJAX
59
+		add_action(
60
+			'wp_ajax_espresso_update_event_archive_order',
61
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
62
+		);
63
+		add_action(
64
+			'wp_ajax_nopriv_espresso_update_event_archive_order',
65
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
66
+		);
67
+	}
68 68
 
69 69
 
70
-    /**
71
-     * run - initial module setup
72
-     *
73
-     * @param    WP $WP
74
-     * @return    void
75
-     */
76
-    public function run($WP)
77
-    {
78
-    }
70
+	/**
71
+	 * run - initial module setup
72
+	 *
73
+	 * @param    WP $WP
74
+	 * @return    void
75
+	 */
76
+	public function run($WP)
77
+	{
78
+	}
79 79
 
80 80
 
81
-    /**
82
-     * @return void
83
-     * @throws DomainException
84
-     * @throws InvalidArgumentException
85
-     * @throws InvalidDataTypeException
86
-     * @throws InvalidInterfaceException
87
-     */
88
-    public static function template_settings_form()
89
-    {
90
-        // grab general settings admin page and remove the existing hook callback
91
-        $gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object('general_settings');
92
-        if ($gen_set_admin instanceof General_Settings_Admin_Page) {
93
-            remove_action(
94
-                'AHEE__template_settings__template__before_settings_form',
95
-                array($gen_set_admin, 'template_settings_caff_features'),
96
-                100
97
-            );
98
-        }
99
-        // first just grab the template settings
100
-        $config = EE_Registry::instance()->CFG->template_settings;
101
-        // then if the Event Archive config is valid, use that, else create a new one
102
-        $config = $config instanceof EE_Template_Config
103
-                  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
104
-            ? $config->EED_Events_Archive
105
-            : new EE_Events_Archive_Config();
106
-        $config = apply_filters(
107
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
108
-            $config
109
-        );
110
-        $config->display_status_banner = isset($config->display_status_banner)
111
-            ? $config->display_status_banner
112
-            : 0;
113
-        $config->display_description = isset($config->display_description)
114
-            ? $config->display_description
115
-            : 1;
116
-        $config->display_ticket_selector = isset($config->display_ticket_selector)
117
-            ? $config->display_ticket_selector
118
-            : 0;
119
-        $config->display_datetimes = isset($config->display_datetimes)
120
-            ? $config->display_datetimes
121
-            : 1;
122
-        $config->display_venue = isset($config->display_venue)
123
-            ? $config->display_venue
124
-            : 0;
125
-        $config->display_expired_events = isset($config->display_expired_events)
126
-            ? $config->display_expired_events
127
-            : 0;
128
-        // display order options
129
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
130
-            ? $config->use_sortable_display_order
131
-            : false;
132
-        $config->display_order_tickets = isset($config->display_order_tickets)
133
-            ? $config->display_order_tickets
134
-            : 120;
135
-        $config->display_order_datetimes = isset($config->display_order_datetimes)
136
-            ? $config->display_order_datetimes
137
-            : 110;
138
-        $config->display_order_event = isset($config->display_order_event)
139
-            ? $config->display_order_event
140
-            : 100;
141
-        $config->display_order_venue = isset($config->display_order_venue)
142
-            ? $config->display_order_venue
143
-            : 130;
144
-        // get template parts
145
-        $template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
146
-        // convert to array so that we can add more properties
147
-        $config = get_object_vars($config);
148
-        $config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
149
-            'event-archive-sortable-js',
150
-            '',
151
-            'archive-sortable-li archive-sortable-js'
152
-        );
153
-        EEH_Template::display_template(
154
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
155
-            $config
156
-        );
157
-    }
81
+	/**
82
+	 * @return void
83
+	 * @throws DomainException
84
+	 * @throws InvalidArgumentException
85
+	 * @throws InvalidDataTypeException
86
+	 * @throws InvalidInterfaceException
87
+	 */
88
+	public static function template_settings_form()
89
+	{
90
+		// grab general settings admin page and remove the existing hook callback
91
+		$gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object('general_settings');
92
+		if ($gen_set_admin instanceof General_Settings_Admin_Page) {
93
+			remove_action(
94
+				'AHEE__template_settings__template__before_settings_form',
95
+				array($gen_set_admin, 'template_settings_caff_features'),
96
+				100
97
+			);
98
+		}
99
+		// first just grab the template settings
100
+		$config = EE_Registry::instance()->CFG->template_settings;
101
+		// then if the Event Archive config is valid, use that, else create a new one
102
+		$config = $config instanceof EE_Template_Config
103
+				  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
104
+			? $config->EED_Events_Archive
105
+			: new EE_Events_Archive_Config();
106
+		$config = apply_filters(
107
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
108
+			$config
109
+		);
110
+		$config->display_status_banner = isset($config->display_status_banner)
111
+			? $config->display_status_banner
112
+			: 0;
113
+		$config->display_description = isset($config->display_description)
114
+			? $config->display_description
115
+			: 1;
116
+		$config->display_ticket_selector = isset($config->display_ticket_selector)
117
+			? $config->display_ticket_selector
118
+			: 0;
119
+		$config->display_datetimes = isset($config->display_datetimes)
120
+			? $config->display_datetimes
121
+			: 1;
122
+		$config->display_venue = isset($config->display_venue)
123
+			? $config->display_venue
124
+			: 0;
125
+		$config->display_expired_events = isset($config->display_expired_events)
126
+			? $config->display_expired_events
127
+			: 0;
128
+		// display order options
129
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
130
+			? $config->use_sortable_display_order
131
+			: false;
132
+		$config->display_order_tickets = isset($config->display_order_tickets)
133
+			? $config->display_order_tickets
134
+			: 120;
135
+		$config->display_order_datetimes = isset($config->display_order_datetimes)
136
+			? $config->display_order_datetimes
137
+			: 110;
138
+		$config->display_order_event = isset($config->display_order_event)
139
+			? $config->display_order_event
140
+			: 100;
141
+		$config->display_order_venue = isset($config->display_order_venue)
142
+			? $config->display_order_venue
143
+			: 130;
144
+		// get template parts
145
+		$template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
146
+		// convert to array so that we can add more properties
147
+		$config = get_object_vars($config);
148
+		$config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
149
+			'event-archive-sortable-js',
150
+			'',
151
+			'archive-sortable-li archive-sortable-js'
152
+		);
153
+		EEH_Template::display_template(
154
+			EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
155
+			$config
156
+		);
157
+	}
158 158
 
159 159
 
160
-    /**
161
-     * @param EE_Template_Config $CFG
162
-     * @param array              $REQ
163
-     * @return EE_Template_Config
164
-     */
165
-    public static function update_template_settings($CFG, $REQ)
166
-    {
167
-        /** @var EE_Events_Archive_Config $config */
168
-        $config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
169
-            ? $CFG->EED_Events_Archive
170
-            : new EE_Events_Archive_Config();
171
-        // unless we are resetting the config...
172
-        if (! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
173
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
174
-        ) {
175
-            $config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
176
-                ? absint($REQ['EED_Events_Archive_display_status_banner'])
177
-                : 0;
178
-            $config->display_description = isset($REQ['EED_Events_Archive_display_description'])
179
-                ? absint($REQ['EED_Events_Archive_display_description'])
180
-                : 1;
181
-            $config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
182
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector'])
183
-                : 0;
184
-            $config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
185
-                ? absint($REQ['EED_Events_Archive_display_datetimes'])
186
-                : 1;
187
-            $config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
188
-                ? absint($REQ['EED_Events_Archive_display_venue'])
189
-                : 0;
190
-            $config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
191
-                ? absint($REQ['EED_Events_Archive_display_expired_events'])
192
-                : 0;
193
-            $config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
194
-                ? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
195
-                : 0;
196
-            $config->display_order_event = $config->display_order_event !== null
197
-                                           && $config->use_sortable_display_order
198
-                ? $config->display_order_event
199
-                : EED_Events_Archive::EVENT_DETAILS_PRIORITY;
200
-            $config->display_order_datetimes = $config->display_order_datetimes !== null
201
-                                               && $config->use_sortable_display_order
202
-                ? $config->display_order_datetimes
203
-                : EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
204
-            $config->display_order_tickets = $config->display_order_tickets !== null
205
-                                             && $config->use_sortable_display_order
206
-                ? $config->display_order_tickets
207
-                : EED_Events_Archive::EVENT_TICKETS_PRIORITY;
208
-            $config->display_order_venue = $config->display_order_venue !== null
209
-                                           && $config->use_sortable_display_order
210
-                ? $config->display_order_venue
211
-                : EED_Events_Archive::EVENT_VENUES_PRIORITY;
212
-        }
213
-        $CFG->EED_Events_Archive = $config;
214
-        do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
215
-        return $CFG;
216
-    }
160
+	/**
161
+	 * @param EE_Template_Config $CFG
162
+	 * @param array              $REQ
163
+	 * @return EE_Template_Config
164
+	 */
165
+	public static function update_template_settings($CFG, $REQ)
166
+	{
167
+		/** @var EE_Events_Archive_Config $config */
168
+		$config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
169
+			? $CFG->EED_Events_Archive
170
+			: new EE_Events_Archive_Config();
171
+		// unless we are resetting the config...
172
+		if (! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
173
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
174
+		) {
175
+			$config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
176
+				? absint($REQ['EED_Events_Archive_display_status_banner'])
177
+				: 0;
178
+			$config->display_description = isset($REQ['EED_Events_Archive_display_description'])
179
+				? absint($REQ['EED_Events_Archive_display_description'])
180
+				: 1;
181
+			$config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
182
+				? absint($REQ['EED_Events_Archive_display_ticket_selector'])
183
+				: 0;
184
+			$config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
185
+				? absint($REQ['EED_Events_Archive_display_datetimes'])
186
+				: 1;
187
+			$config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
188
+				? absint($REQ['EED_Events_Archive_display_venue'])
189
+				: 0;
190
+			$config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
191
+				? absint($REQ['EED_Events_Archive_display_expired_events'])
192
+				: 0;
193
+			$config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
194
+				? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
195
+				: 0;
196
+			$config->display_order_event = $config->display_order_event !== null
197
+										   && $config->use_sortable_display_order
198
+				? $config->display_order_event
199
+				: EED_Events_Archive::EVENT_DETAILS_PRIORITY;
200
+			$config->display_order_datetimes = $config->display_order_datetimes !== null
201
+											   && $config->use_sortable_display_order
202
+				? $config->display_order_datetimes
203
+				: EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
204
+			$config->display_order_tickets = $config->display_order_tickets !== null
205
+											 && $config->use_sortable_display_order
206
+				? $config->display_order_tickets
207
+				: EED_Events_Archive::EVENT_TICKETS_PRIORITY;
208
+			$config->display_order_venue = $config->display_order_venue !== null
209
+										   && $config->use_sortable_display_order
210
+				? $config->display_order_venue
211
+				: EED_Events_Archive::EVENT_VENUES_PRIORITY;
212
+		}
213
+		$CFG->EED_Events_Archive = $config;
214
+		do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
215
+		return $CFG;
216
+	}
217 217
 
218 218
 
219
-    /**
220
-     * @return void
221
-     * @throws InvalidArgumentException
222
-     * @throws InvalidDataTypeException
223
-     * @throws InvalidInterfaceException
224
-     */
225
-    public static function update_event_archive_order()
226
-    {
227
-        /** @var EE_Config $config */
228
-        $config = EE_Registry::instance()->CFG;
229
-        $config_saved = false;
230
-        $template_parts = sanitize_text_field($_POST['elements']);
231
-        if (! empty($template_parts)) {
232
-            $template_parts = explode(',', trim($template_parts, ','));
233
-            foreach ($template_parts as $key => $template_part) {
234
-                $template_part = "display_order_$template_part";
235
-                $priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
236
-                if ($config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
237
-                    && property_exists(
238
-                        $config->template_settings->EED_Events_Archive,
239
-                        $template_part
240
-                    )
241
-                ) {
242
-                    $config->template_settings->EED_Events_Archive->{$template_part} = $priority;
243
-                }
244
-                do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
245
-            }
246
-            $config_saved = $config->update_espresso_config(false, false);
247
-        }
248
-        if ($config_saved) {
249
-            EE_Error::add_success(__('Display Order has been successfully updated.', 'event_espresso'));
250
-        } else {
251
-            EE_Error::add_error(
252
-                __('Display Order was not updated.', 'event_espresso'),
253
-                __FILE__,
254
-                __FUNCTION__,
255
-                __LINE__
256
-            );
257
-        }
258
-        echo wp_json_encode(EE_Error::get_notices(false));
259
-        exit();
260
-    }
219
+	/**
220
+	 * @return void
221
+	 * @throws InvalidArgumentException
222
+	 * @throws InvalidDataTypeException
223
+	 * @throws InvalidInterfaceException
224
+	 */
225
+	public static function update_event_archive_order()
226
+	{
227
+		/** @var EE_Config $config */
228
+		$config = EE_Registry::instance()->CFG;
229
+		$config_saved = false;
230
+		$template_parts = sanitize_text_field($_POST['elements']);
231
+		if (! empty($template_parts)) {
232
+			$template_parts = explode(',', trim($template_parts, ','));
233
+			foreach ($template_parts as $key => $template_part) {
234
+				$template_part = "display_order_$template_part";
235
+				$priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
236
+				if ($config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
237
+					&& property_exists(
238
+						$config->template_settings->EED_Events_Archive,
239
+						$template_part
240
+					)
241
+				) {
242
+					$config->template_settings->EED_Events_Archive->{$template_part} = $priority;
243
+				}
244
+				do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
245
+			}
246
+			$config_saved = $config->update_espresso_config(false, false);
247
+		}
248
+		if ($config_saved) {
249
+			EE_Error::add_success(__('Display Order has been successfully updated.', 'event_espresso'));
250
+		} else {
251
+			EE_Error::add_error(
252
+				__('Display Order was not updated.', 'event_espresso'),
253
+				__FILE__,
254
+				__FUNCTION__,
255
+				__LINE__
256
+			);
257
+		}
258
+		echo wp_json_encode(EE_Error::get_notices(false));
259
+		exit();
260
+	}
261 261
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -41,9 +41,9 @@  discard block
 block discarded – undo
41 41
     {
42 42
         define(
43 43
             'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
44
-            str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates' . DS
44
+            str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS
45 45
         );
46
-        define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
46
+        define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
47 47
         add_action(
48 48
             'AHEE__template_settings__template__before_settings_form',
49 49
             array('EED_Events_Archive_Caff', 'template_settings_form'),
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
             'archive-sortable-li archive-sortable-js'
152 152
         );
153 153
         EEH_Template::display_template(
154
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
154
+            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH.'admin-event-list-settings.template.php',
155 155
             $config
156 156
         );
157 157
     }
@@ -169,7 +169,7 @@  discard block
 block discarded – undo
169 169
             ? $CFG->EED_Events_Archive
170 170
             : new EE_Events_Archive_Config();
171 171
         // unless we are resetting the config...
172
-        if (! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
172
+        if ( ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
173 173
             || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
174 174
         ) {
175 175
             $config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
         $config = EE_Registry::instance()->CFG;
229 229
         $config_saved = false;
230 230
         $template_parts = sanitize_text_field($_POST['elements']);
231
-        if (! empty($template_parts)) {
231
+        if ( ! empty($template_parts)) {
232 232
             $template_parts = explode(',', trim($template_parts, ','));
233 233
             foreach ($template_parts as $key => $template_part) {
234 234
                 $template_part = "display_order_$template_part";
Please login to merge, or discard this patch.
core/domain/services/admin/privacy/policy/PrivacyPolicy.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -73,7 +73,7 @@
 block discarded – undo
73 73
         }
74 74
         $session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS);
75 75
         return (string) EEH_Template::display_template(
76
-            __DIR__ . '/privacy_policy.template.php',
76
+            __DIR__.'/privacy_policy.template.php',
77 77
             array(
78 78
                 'active_onsite_payment_methods' => $active_onsite_pms,
79 79
                 'active_offsite_payment_methods' => $active_offsite_pms,
Please login to merge, or discard this patch.
Indentation   +68 added lines, -68 removed lines patch added patch discarded remove patch
@@ -20,80 +20,80 @@
 block discarded – undo
20 20
 class PrivacyPolicy implements PrivacyPolicyInterface
21 21
 {
22 22
 
23
-    /**
24
-     * @var EEM_Payment_Method
25
-     */
26
-    protected $payment_method_model;
23
+	/**
24
+	 * @var EEM_Payment_Method
25
+	 */
26
+	protected $payment_method_model;
27 27
 
28
-    /**
29
-     * @var SessionLifespan
30
-     */
31
-    protected $session_lifespan;
28
+	/**
29
+	 * @var SessionLifespan
30
+	 */
31
+	protected $session_lifespan;
32 32
 
33
-    /**
34
-     * PrivacyPolicy constructor.
35
-     *
36
-     * @param EEM_Payment_Method $payment_method_model
37
-     * @param SessionLifespan    $session_lifespan
38
-     */
39
-    public function __construct(EEM_Payment_Method $payment_method_model, SessionLifespan $session_lifespan)
40
-    {
41
-        $this->payment_method_model = $payment_method_model;
42
-        $this->session_lifespan = $session_lifespan;
43
-    }
33
+	/**
34
+	 * PrivacyPolicy constructor.
35
+	 *
36
+	 * @param EEM_Payment_Method $payment_method_model
37
+	 * @param SessionLifespan    $session_lifespan
38
+	 */
39
+	public function __construct(EEM_Payment_Method $payment_method_model, SessionLifespan $session_lifespan)
40
+	{
41
+		$this->payment_method_model = $payment_method_model;
42
+		$this->session_lifespan = $session_lifespan;
43
+	}
44 44
 
45 45
 
46
-    /**
47
-     * Returns the name of the plugin and will be shown in the privacy policy's postbox header
48
-     *
49
-     * @return string
50
-     */
51
-    public function getName()
52
-    {
53
-        return esc_html__('Event Espresso', 'event_espresso');
54
-    }
46
+	/**
47
+	 * Returns the name of the plugin and will be shown in the privacy policy's postbox header
48
+	 *
49
+	 * @return string
50
+	 */
51
+	public function getName()
52
+	{
53
+		return esc_html__('Event Espresso', 'event_espresso');
54
+	}
55 55
 
56 56
 
57
-    /**
58
-     * Gets the HTML for the privacy policy. May be dynamic
59
-     *
60
-     * @return string
61
-     */
62
-    public function getContent()
63
-    {
64
-        // do they have any offsite payment methods? or onsite payment methods?
65
-        $active_payment_methods = $this->payment_method_model->get_all_active(EEM_Payment_Method::scope_cart);
66
-        $active_onsite_pms = array();
67
-        $active_offsite_pms = array();
68
-        foreach ($active_payment_methods as $payment_method) {
69
-            if ($payment_method->type_obj() instanceof \EE_PMT_Base) {
70
-                if ($payment_method->type_obj()->get_gateway() instanceof EE_Onsite_Gateway) {
71
-                    $active_onsite_pms[] = $payment_method->name();
72
-                } elseif ($payment_method->type_obj()->get_gateway() instanceof EE_Offsite_Gateway) {
73
-                    $active_offsite_pms[] = $payment_method->name();
74
-                }
75
-            }
76
-        }
77
-        $session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS);
78
-        return (string) EEH_Template::display_template(
79
-            __DIR__ . '/privacy_policy.template.php',
80
-            array(
81
-                'active_onsite_payment_methods' => $active_onsite_pms,
82
-                'active_offsite_payment_methods' => $active_offsite_pms,
83
-                'session_lifespan' => sprintf(
84
-                    _nx(
85
-                        '%1$s hour',
86
-                        '%1$s hours',
87
-                        $session_lifespan_in_hours,
88
-                        '2 hours',
89
-                        'event_espresso'
90
-                    ),
91
-                    $session_lifespan_in_hours
92
-                )
93
-            ),
94
-            true
95
-        );
96
-    }
57
+	/**
58
+	 * Gets the HTML for the privacy policy. May be dynamic
59
+	 *
60
+	 * @return string
61
+	 */
62
+	public function getContent()
63
+	{
64
+		// do they have any offsite payment methods? or onsite payment methods?
65
+		$active_payment_methods = $this->payment_method_model->get_all_active(EEM_Payment_Method::scope_cart);
66
+		$active_onsite_pms = array();
67
+		$active_offsite_pms = array();
68
+		foreach ($active_payment_methods as $payment_method) {
69
+			if ($payment_method->type_obj() instanceof \EE_PMT_Base) {
70
+				if ($payment_method->type_obj()->get_gateway() instanceof EE_Onsite_Gateway) {
71
+					$active_onsite_pms[] = $payment_method->name();
72
+				} elseif ($payment_method->type_obj()->get_gateway() instanceof EE_Offsite_Gateway) {
73
+					$active_offsite_pms[] = $payment_method->name();
74
+				}
75
+			}
76
+		}
77
+		$session_lifespan_in_hours = round($this->session_lifespan->inSeconds() / HOUR_IN_SECONDS);
78
+		return (string) EEH_Template::display_template(
79
+			__DIR__ . '/privacy_policy.template.php',
80
+			array(
81
+				'active_onsite_payment_methods' => $active_onsite_pms,
82
+				'active_offsite_payment_methods' => $active_offsite_pms,
83
+				'session_lifespan' => sprintf(
84
+					_nx(
85
+						'%1$s hour',
86
+						'%1$s hours',
87
+						$session_lifespan_in_hours,
88
+						'2 hours',
89
+						'event_espresso'
90
+					),
91
+					$session_lifespan_in_hours
92
+				)
93
+			),
94
+			true
95
+		);
96
+	}
97 97
 }
98 98
 // End of file PrivacyPolicy.php
99 99
 // Location: EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy.php
Please login to merge, or discard this patch.
core/domain/values/assets/JavascriptAsset.php 1 patch
Indentation   +138 added lines, -138 removed lines patch added patch discarded remove patch
@@ -17,142 +17,142 @@
 block discarded – undo
17 17
 class JavascriptAsset extends BrowserAsset
18 18
 {
19 19
 
20
-    /**
21
-     * @var boolean $load_in_footer
22
-     */
23
-    private $load_in_footer = false;
24
-
25
-    /**
26
-     * @var boolean $requires_translation
27
-     */
28
-    private $requires_translation = false;
29
-
30
-    /**
31
-     * @var boolean $has_localized_data
32
-     */
33
-    private $has_localized_data = false;
34
-
35
-    /**
36
-     * @var Closure $localization_callback
37
-     */
38
-    private $localization_callback;
39
-
40
-
41
-    /**
42
-     * Asset constructor.
43
-     *
44
-     * @param string          $handle
45
-     * @param string          $source
46
-     * @param array           $dependencies
47
-     * @param bool            $load_in_footer
48
-     * @param DomainInterface $domain
49
-     * @throws InvalidDataTypeException
50
-     */
51
-    public function __construct(
52
-        $handle,
53
-        $source,
54
-        array $dependencies,
55
-        $load_in_footer,
56
-        DomainInterface $domain
57
-    ) {
58
-        parent::__construct(Asset::TYPE_JS, $handle, $source, $dependencies, $domain);
59
-        $this->setLoadInFooter($load_in_footer);
60
-    }
61
-
62
-
63
-    /**
64
-     * @return bool
65
-     */
66
-    public function loadInFooter()
67
-    {
68
-        return $this->load_in_footer;
69
-    }
70
-
71
-
72
-    /**
73
-     * @param bool $load_in_footer
74
-     */
75
-    private function setLoadInFooter($load_in_footer = true)
76
-    {
77
-        $this->load_in_footer = filter_var($load_in_footer, FILTER_VALIDATE_BOOLEAN);
78
-    }
79
-
80
-
81
-    /**
82
-     * @return bool
83
-     */
84
-    public function requiresTranslation()
85
-    {
86
-        return $this->requires_translation;
87
-    }
88
-
89
-
90
-    /**
91
-     * @param bool $requires_translation
92
-     * @return JavascriptAsset
93
-     */
94
-    public function setRequiresTranslation($requires_translation = true)
95
-    {
96
-        $this->requires_translation = filter_var($requires_translation, FILTER_VALIDATE_BOOLEAN);
97
-        return $this;
98
-    }
99
-
100
-
101
-    /**
102
-     * @return bool
103
-     */
104
-    public function hasLocalizedData()
105
-    {
106
-        return $this->has_localized_data;
107
-    }
108
-
109
-
110
-    /**
111
-     * @param bool $has_localized_data
112
-     * @return JavascriptAsset
113
-     */
114
-    public function setHasLocalizedData($has_localized_data = true)
115
-    {
116
-        $this->has_localized_data = filter_var($has_localized_data, FILTER_VALIDATE_BOOLEAN);
117
-        return $this;
118
-    }
119
-
120
-
121
-    /**
122
-     * @return Closure
123
-     */
124
-    public function localizationCallback()
125
-    {
126
-        return $this->localization_callback;
127
-    }
128
-
129
-
130
-    /**
131
-     * @return bool
132
-     */
133
-    public function hasLocalizationCallback()
134
-    {
135
-        return $this->localization_callback instanceof Closure;
136
-    }
137
-
138
-
139
-    /**
140
-     * @param Closure $localization_callback
141
-     * @return JavascriptAsset
142
-     */
143
-    public function setLocalizationCallback(Closure $localization_callback)
144
-    {
145
-        $this->localization_callback = $localization_callback;
146
-        $this->setHasLocalizedData();
147
-        return $this;
148
-    }
149
-
150
-
151
-    /**
152
-     * @since $VID:$
153
-     */
154
-    public function enqueueAsset()
155
-    {
156
-        wp_enqueue_script($this->handle());
157
-    }
20
+	/**
21
+	 * @var boolean $load_in_footer
22
+	 */
23
+	private $load_in_footer = false;
24
+
25
+	/**
26
+	 * @var boolean $requires_translation
27
+	 */
28
+	private $requires_translation = false;
29
+
30
+	/**
31
+	 * @var boolean $has_localized_data
32
+	 */
33
+	private $has_localized_data = false;
34
+
35
+	/**
36
+	 * @var Closure $localization_callback
37
+	 */
38
+	private $localization_callback;
39
+
40
+
41
+	/**
42
+	 * Asset constructor.
43
+	 *
44
+	 * @param string          $handle
45
+	 * @param string          $source
46
+	 * @param array           $dependencies
47
+	 * @param bool            $load_in_footer
48
+	 * @param DomainInterface $domain
49
+	 * @throws InvalidDataTypeException
50
+	 */
51
+	public function __construct(
52
+		$handle,
53
+		$source,
54
+		array $dependencies,
55
+		$load_in_footer,
56
+		DomainInterface $domain
57
+	) {
58
+		parent::__construct(Asset::TYPE_JS, $handle, $source, $dependencies, $domain);
59
+		$this->setLoadInFooter($load_in_footer);
60
+	}
61
+
62
+
63
+	/**
64
+	 * @return bool
65
+	 */
66
+	public function loadInFooter()
67
+	{
68
+		return $this->load_in_footer;
69
+	}
70
+
71
+
72
+	/**
73
+	 * @param bool $load_in_footer
74
+	 */
75
+	private function setLoadInFooter($load_in_footer = true)
76
+	{
77
+		$this->load_in_footer = filter_var($load_in_footer, FILTER_VALIDATE_BOOLEAN);
78
+	}
79
+
80
+
81
+	/**
82
+	 * @return bool
83
+	 */
84
+	public function requiresTranslation()
85
+	{
86
+		return $this->requires_translation;
87
+	}
88
+
89
+
90
+	/**
91
+	 * @param bool $requires_translation
92
+	 * @return JavascriptAsset
93
+	 */
94
+	public function setRequiresTranslation($requires_translation = true)
95
+	{
96
+		$this->requires_translation = filter_var($requires_translation, FILTER_VALIDATE_BOOLEAN);
97
+		return $this;
98
+	}
99
+
100
+
101
+	/**
102
+	 * @return bool
103
+	 */
104
+	public function hasLocalizedData()
105
+	{
106
+		return $this->has_localized_data;
107
+	}
108
+
109
+
110
+	/**
111
+	 * @param bool $has_localized_data
112
+	 * @return JavascriptAsset
113
+	 */
114
+	public function setHasLocalizedData($has_localized_data = true)
115
+	{
116
+		$this->has_localized_data = filter_var($has_localized_data, FILTER_VALIDATE_BOOLEAN);
117
+		return $this;
118
+	}
119
+
120
+
121
+	/**
122
+	 * @return Closure
123
+	 */
124
+	public function localizationCallback()
125
+	{
126
+		return $this->localization_callback;
127
+	}
128
+
129
+
130
+	/**
131
+	 * @return bool
132
+	 */
133
+	public function hasLocalizationCallback()
134
+	{
135
+		return $this->localization_callback instanceof Closure;
136
+	}
137
+
138
+
139
+	/**
140
+	 * @param Closure $localization_callback
141
+	 * @return JavascriptAsset
142
+	 */
143
+	public function setLocalizationCallback(Closure $localization_callback)
144
+	{
145
+		$this->localization_callback = $localization_callback;
146
+		$this->setHasLocalizedData();
147
+		return $this;
148
+	}
149
+
150
+
151
+	/**
152
+	 * @since $VID:$
153
+	 */
154
+	public function enqueueAsset()
155
+	{
156
+		wp_enqueue_script($this->handle());
157
+	}
158 158
 }
Please login to merge, or discard this patch.