View GitHub Repository event-espresso-core

Schedule Inspection
Subscribe
Completed
Branch — BUG/remove-fatal-url-checkins (5cd2f8)
by
unknown
26:28 queued 17:33
created
Status
Category
Toggle Patches
core/domain/services/contexts/RequestTypeContextCheckerInterface.php 1 patch
Indentation   +102 added lines, -102 removed lines patch added patch discarded remove patch 
@@ -13,140 +13,140 @@
 
 block discarded – undo
13 13 
 interface RequestTypeContextCheckerInterface
14 14 
 {
15 15
16 
-    /**
17 
-     * true if the current request involves some form of activation
18 
-     *
19 
-     * @return bool
20 
-     */
21 
-    public function isActivation();
16 
+	/**
17 
+	 * true if the current request involves some form of activation
18 
+	 *
19 
+	 * @return bool
20 
+	 */
21 
+	public function isActivation();
22 22
23 23
24 
-    /**
25 
-     * @param $is_activation
26 
-     * @return bool
27 
-     */
28 
-    public function setIsActivation($is_activation);
24 
+	/**
25 
+	 * @param $is_activation
26 
+	 * @return bool
27 
+	 */
28 
+	public function setIsActivation($is_activation);
29 29
30 30
31 
-    /**
32 
-     * true if the current request is for the admin and is not being made via AJAX
33 
-     *
34 
-     * @return bool
35 
-     */
36 
-    public function isAdmin();
31 
+	/**
32 
+	 * true if the current request is for the admin and is not being made via AJAX
33 
+	 *
34 
+	 * @return bool
35 
+	 */
36 
+	public function isAdmin();
37 37
38 38
39 
-    /**
40 
-     * true if the current request is for the admin AND is being made via AJAX
41 
-     * and the ajax request contains the request parameter "ee_admin_ajax"
42 
-     *
43 
-     * @return bool
44 
-     */
45 
-    public function isAdminAjax();
39 
+	/**
40 
+	 * true if the current request is for the admin AND is being made via AJAX
41 
+	 * and the ajax request contains the request parameter "ee_admin_ajax"
42 
+	 *
43 
+	 * @return bool
44 
+	 */
45 
+	public function isAdminAjax();
46 46
47 47
48 
-    /**
49 
-     * true if the current request is being made via AJAX... any AJAX
50 
-     *
51 
-     * @return bool
52 
-     */
53 
-    public function isAjax();
48 
+	/**
49 
+	 * true if the current request is being made via AJAX... any AJAX
50 
+	 *
51 
+	 * @return bool
52 
+	 */
53 
+	public function isAjax();
54 54
55 55
56 
-    /**
57 
-     * true if the current request is for the EE REST API
58 
-     *
59 
-     * @return bool
60 
-     */
61 
-    public function isApi();
56 
+	/**
57 
+	 * true if the current request is for the EE REST API
58 
+	 *
59 
+	 * @return bool
60 
+	 */
61 
+	public function isApi();
62 62
63 63
64 
-    /**
65 
-     * true if the current request is from the command line
66 
-     *
67 
-     * @return bool
68 
-     */
69 
-    public function isCli();
64 
+	/**
65 
+	 * true if the current request is from the command line
66 
+	 *
67 
+	 * @return bool
68 
+	 */
69 
+	public function isCli();
70 70
71 71
72 
-    /**
73 
-     * true if the current request is for a WP_Cron
74 
-     *
75 
-     * @return bool
76 
-     */
77 
-    public function isCron();
72 
+	/**
73 
+	 * true if the current request is for a WP_Cron
74 
+	 *
75 
+	 * @return bool
76 
+	 */
77 
+	public function isCron();
78 78
79 79
80 
-    /**
81 
-     * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
82 
-     *
83 
-     * @return bool
84 
-     */
85 
-    public function isEeAjax();
80 
+	/**
81 
+	 * true if the current request is for either the EE admin or EE frontend AND is being made via AJAX
82 
+	 *
83 
+	 * @return bool
84 
+	 */
85 
+	public function isEeAjax();
86 86
87 87
88 
-    /**
89 
-     * true if the current request is for a feed (ie: RSS)
90 
-     *
91 
-     * @return bool
92 
-     */
93 
-    public function isFeed();
88 
+	/**
89 
+	 * true if the current request is for a feed (ie: RSS)
90 
+	 *
91 
+	 * @return bool
92 
+	 */
93 
+	public function isFeed();
94 94
95 95
96 
-    /**
97 
-     * true if the current request is for the frontend and is not being made via AJAX
98 
-     *
99 
-     * @return bool
100 
-     */
101 
-    public function isFrontend();
96 
+	/**
97 
+	 * true if the current request is for the frontend and is not being made via AJAX
98 
+	 *
99 
+	 * @return bool
100 
+	 */
101 
+	public function isFrontend();
102 102
103 103
104 
-    /**
105 
-     * @return bool
106 
-     */
107 
-    public function isFrontAjax();
104 
+	/**
105 
+	 * @return bool
106 
+	 */
107 
+	public function isFrontAjax();
108 108
109 109
110 
-    /**
111 
-     * @return bool
112 
-     */
113 
-    public function isIframe();
110 
+	/**
111 
+	 * @return bool
112 
+	 */
113 
+	public function isIframe();
114 114
115 115
116 
-    /**
117 
-     * true if the current request is being made via AJAX but is NOT for EE related logic
118 
-     *
119 
-     * @return bool
120 
-     */
121 
-    public function isOtherAjax();
116 
+	/**
117 
+	 * true if the current request is being made via AJAX but is NOT for EE related logic
118 
+	 *
119 
+	 * @return bool
120 
+	 */
121 
+	public function isOtherAjax();
122 122
123 123
124 
-    /**
125 
-     * true if the current request is for the WP REST API
126 
-     *
127 
-     * @return bool
128 
-     */
129 
-    public function isWordPressApi();
124 
+	/**
125 
+	 * true if the current request is for the WP REST API
126 
+	 *
127 
+	 * @return bool
128 
+	 */
129 
+	public function isWordPressApi();
130 130
131 131
132 
-    /**
133 
-     * true if the current request is being made via AJAX for the WP Heartbeat
134 
-     *
135 
-     * @return bool
136 
-     */
137 
-    public function isWordPressHeartbeat();
132 
+	/**
133 
+	 * true if the current request is being made via AJAX for the WP Heartbeat
134 
+	 *
135 
+	 * @return bool
136 
+	 */
137 
+	public function isWordPressHeartbeat();
138 138
139 139
140 
-    /**
141 
-     * true if the current request is a loopback sent from WP core to test for errors
142 
-     *
143 
-     * @return bool
144 
-     */
145 
-    public function isWordPressScrape();
140 
+	/**
141 
+	 * true if the current request is a loopback sent from WP core to test for errors
142 
+	 *
143 
+	 * @return bool
144 
+	 */
145 
+	public function isWordPressScrape();
146 146
147 147
148 
-    /**
149 
-     * @return string
150 
-     */
151 
-    public function slug();
148 
+	/**
149 
+	 * @return string
150 
+	 */
151 
+	public function slug();
152 152 
 }
Please login to merge, or discard this patch.
core/domain/services/contexts/RequestTypeContextFactory.php 1 patch
Indentation   +114 added lines, -114 removed lines patch added patch discarded remove patch 
@@ -17,122 +17,122 @@
 
 block discarded – undo
17 17 
 class RequestTypeContextFactory implements RequestTypeContextFactoryInterface
18 18 
 {
19 19
20 
-    /**
21 
-     * @var LoaderInterface $loader
22 
-     */
23 
-    private $loader;
20 
+	/**
21 
+	 * @var LoaderInterface $loader
22 
+	 */
23 
+	private $loader;
24 24
25 25
26 
-    /**
27 
-     * RequestTypeContextFactory constructor.
28 
-     *
29 
-     * @param LoaderInterface $loader
30 
-     */
31 
-    public function __construct(LoaderInterface $loader)
32 
-    {
33 
-        $this->loader = $loader;
34 
-    }
26 
+	/**
27 
+	 * RequestTypeContextFactory constructor.
28 
+	 *
29 
+	 * @param LoaderInterface $loader
30 
+	 */
31 
+	public function __construct(LoaderInterface $loader)
32 
+	{
33 
+		$this->loader = $loader;
34 
+	}
35 35
36 36
37 
-    /**
38 
-     * @param string $slug
39 
-     * @return RequestTypeContext
40 
-     */
41 
-    public function create($slug)
42 
-    {
43 
-        switch ($slug) {
44 
-            case RequestTypeContext::ACTIVATION:
45 
-                $description = esc_html__(
46 
-                    'The current request is for some form of activation',
47 
-                    'event_espresso'
48 
-                );
49 
-                break;
50 
-            case RequestTypeContext::API:
51 
-                $description = esc_html__(
52 
-                    'The current request is for the EE REST API',
53 
-                    'event_espresso'
54 
-                );
55 
-                break;
56 
-            case RequestTypeContext::AJAX_FRONT:
57 
-                $description = esc_html__(
58 
-                    'The current request is for the frontend via AJAX',
59 
-                    'event_espresso'
60 
-                );
61 
-                break;
62 
-            case RequestTypeContext::AJAX_ADMIN:
63 
-                $description = esc_html__(
64 
-                    'The current request is for the admin via AJAX',
65 
-                    'event_espresso'
66 
-                );
67 
-                break;
68 
-            case RequestTypeContext::AJAX_HEARTBEAT:
69 
-                $description = esc_html__(
70 
-                    'The current request is for the WP Heartbeat',
71 
-                    'event_espresso'
72 
-                );
73 
-                break;
74 
-            case RequestTypeContext::AJAX_OTHER:
75 
-                $description = esc_html__(
76 
-                    'The current request is for non-EE related code via AJAX',
77 
-                    'event_espresso'
78 
-                );
79 
-                break;
80 
-            case RequestTypeContext::CRON:
81 
-                $description = esc_html__(
82 
-                    'The current request is for a WP_Cron',
83 
-                    'event_espresso'
84 
-                );
85 
-                break;
86 
-            case RequestTypeContext::CLI:
87 
-                $description = esc_html__(
88 
-                    'The current request is from the command line',
89 
-                    'event_espresso'
90 
-                );
91 
-                break;
92 
-            case RequestTypeContext::ADMIN:
93 
-                $description = esc_html__(
94 
-                    'The current request is for the admin',
95 
-                    'event_espresso'
96 
-                );
97 
-                break;
98 
-            case RequestTypeContext::IFRAME:
99 
-                $description = esc_html__(
100 
-                    'The current request is for an iframe',
101 
-                    'event_espresso'
102 
-                );
103 
-                break;
104 
-            case RequestTypeContext::FEED:
105 
-                $description = esc_html__(
106 
-                    'The current request is for a feed (ie: RSS)',
107 
-                    'event_espresso'
108 
-                );
109 
-                break;
110 
-            case RequestTypeContext::WP_API:
111 
-                $description = esc_html__(
112 
-                    'The current request is for the WordPress REST API',
113 
-                    'event_espresso'
114 
-                );
115 
-                break;
116 
-            case RequestTypeContext::WP_SCRAPE:
117 
-                $description = esc_html__(
118 
-                    'The current request is for a WordPress loopback scrape',
119 
-                    'event_espresso'
120 
-                );
121 
-                break;
122 
-            case RequestTypeContext::FRONTEND:
123 
-            default:
124 
-                $description = esc_html__(
125 
-                    'The current request is for the frontend',
126 
-                    'event_espresso'
127 
-                );
128 
-                break;
129 
-        }
130 
-        // we're using the Loader with sharing turned on,
131 
-        // so that the generated RequestTypeContext object is accessible anywhere
132 
-        // by simply requesting it again from the loader
133 
-        return $this->loader->getShared(
134 
-            'EventEspresso\core\domain\entities\contexts\RequestTypeContext',
135 
-            array($slug, $description)
136 
-        );
137 
-    }
37 
+	/**
38 
+	 * @param string $slug
39 
+	 * @return RequestTypeContext
40 
+	 */
41 
+	public function create($slug)
42 
+	{
43 
+		switch ($slug) {
44 
+			case RequestTypeContext::ACTIVATION:
45 
+				$description = esc_html__(
46 
+					'The current request is for some form of activation',
47 
+					'event_espresso'
48 
+				);
49 
+				break;
50 
+			case RequestTypeContext::API:
51 
+				$description = esc_html__(
52 
+					'The current request is for the EE REST API',
53 
+					'event_espresso'
54 
+				);
55 
+				break;
56 
+			case RequestTypeContext::AJAX_FRONT:
57 
+				$description = esc_html__(
58 
+					'The current request is for the frontend via AJAX',
59 
+					'event_espresso'
60 
+				);
61 
+				break;
62 
+			case RequestTypeContext::AJAX_ADMIN:
63 
+				$description = esc_html__(
64 
+					'The current request is for the admin via AJAX',
65 
+					'event_espresso'
66 
+				);
67 
+				break;
68 
+			case RequestTypeContext::AJAX_HEARTBEAT:
69 
+				$description = esc_html__(
70 
+					'The current request is for the WP Heartbeat',
71 
+					'event_espresso'
72 
+				);
73 
+				break;
74 
+			case RequestTypeContext::AJAX_OTHER:
75 
+				$description = esc_html__(
76 
+					'The current request is for non-EE related code via AJAX',
77 
+					'event_espresso'
78 
+				);
79 
+				break;
80 
+			case RequestTypeContext::CRON:
81 
+				$description = esc_html__(
82 
+					'The current request is for a WP_Cron',
83 
+					'event_espresso'
84 
+				);
85 
+				break;
86 
+			case RequestTypeContext::CLI:
87 
+				$description = esc_html__(
88 
+					'The current request is from the command line',
89 
+					'event_espresso'
90 
+				);
91 
+				break;
92 
+			case RequestTypeContext::ADMIN:
93 
+				$description = esc_html__(
94 
+					'The current request is for the admin',
95 
+					'event_espresso'
96 
+				);
97 
+				break;
98 
+			case RequestTypeContext::IFRAME:
99 
+				$description = esc_html__(
100 
+					'The current request is for an iframe',
101 
+					'event_espresso'
102 
+				);
103 
+				break;
104 
+			case RequestTypeContext::FEED:
105 
+				$description = esc_html__(
106 
+					'The current request is for a feed (ie: RSS)',
107 
+					'event_espresso'
108 
+				);
109 
+				break;
110 
+			case RequestTypeContext::WP_API:
111 
+				$description = esc_html__(
112 
+					'The current request is for the WordPress REST API',
113 
+					'event_espresso'
114 
+				);
115 
+				break;
116 
+			case RequestTypeContext::WP_SCRAPE:
117 
+				$description = esc_html__(
118 
+					'The current request is for a WordPress loopback scrape',
119 
+					'event_espresso'
120 
+				);
121 
+				break;
122 
+			case RequestTypeContext::FRONTEND:
123 
+			default:
124 
+				$description = esc_html__(
125 
+					'The current request is for the frontend',
126 
+					'event_espresso'
127 
+				);
128 
+				break;
129 
+		}
130 
+		// we're using the Loader with sharing turned on,
131 
+		// so that the generated RequestTypeContext object is accessible anywhere
132 
+		// by simply requesting it again from the loader
133 
+		return $this->loader->getShared(
134 
+			'EventEspresso\core\domain\entities\contexts\RequestTypeContext',
135 
+			array($slug, $description)
136 
+		);
137 
+	}
138 138 
 }
Please login to merge, or discard this patch.
core/EE_Dependency_Map.core.php 2 patches
Indentation   +1080 added lines, -1080 removed lines patch added patch discarded remove patch 
@@ -20,1084 +20,1084 @@
 
 block discarded – undo
20 20 
 class EE_Dependency_Map
21 21 
 {
22 22
23 
-    /**
24 
-     * This means that the requested class dependency is not present in the dependency map
25 
-     */
26 
-    const not_registered = 0;
27 
-
28 
-    /**
29 
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
30 
-     */
31 
-    const load_new_object = 1;
32 
-
33 
-    /**
34 
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
35 
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
36 
-     */
37 
-    const load_from_cache = 2;
38 
-
39 
-    /**
40 
-     * When registering a dependency,
41 
-     * this indicates to keep any existing dependencies that already exist,
42 
-     * and simply discard any new dependencies declared in the incoming data
43 
-     */
44 
-    const KEEP_EXISTING_DEPENDENCIES = 0;
45 
-
46 
-    /**
47 
-     * When registering a dependency,
48 
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
49 
-     */
50 
-    const OVERWRITE_DEPENDENCIES = 1;
51 
-
52 
-
53 
-    /**
54 
-     * @type EE_Dependency_Map $_instance
55 
-     */
56 
-    protected static $_instance;
57 
-
58 
-    /**
59 
-     * @var ClassInterfaceCache $class_cache
60 
-     */
61 
-    private $class_cache;
62 
-
63 
-    /**
64 
-     * @type RequestInterface $request
65 
-     */
66 
-    protected $request;
67 
-
68 
-    /**
69 
-     * @type LegacyRequestInterface $legacy_request
70 
-     */
71 
-    protected $legacy_request;
72 
-
73 
-    /**
74 
-     * @type ResponseInterface $response
75 
-     */
76 
-    protected $response;
77 
-
78 
-    /**
79 
-     * @type LoaderInterface $loader
80 
-     */
81 
-    protected $loader;
82 
-
83 
-    /**
84 
-     * @type array $_dependency_map
85 
-     */
86 
-    protected $_dependency_map = array();
87 
-
88 
-    /**
89 
-     * @type array $_class_loaders
90 
-     */
91 
-    protected $_class_loaders = array();
92 
-
93 
-
94 
-    /**
95 
-     * EE_Dependency_Map constructor.
96 
-     *
97 
-     * @param ClassInterfaceCache $class_cache
98 
-     */
99 
-    protected function __construct(ClassInterfaceCache $class_cache)
100 
-    {
101 
-        $this->class_cache = $class_cache;
102 
-        do_action('EE_Dependency_Map____construct', $this);
103 
-    }
104 
-
105 
-
106 
-    /**
107 
-     * @return void
108 
-     */
109 
-    public function initialize()
110 
-    {
111 
-        $this->_register_core_dependencies();
112 
-        $this->_register_core_class_loaders();
113 
-        $this->_register_core_aliases();
114 
-    }
115 
-
116 
-
117 
-    /**
118 
-     * @singleton method used to instantiate class object
119 
-     * @param ClassInterfaceCache|null $class_cache
120 
-     * @return EE_Dependency_Map
121 
-     */
122 
-    public static function instance(ClassInterfaceCache $class_cache = null)
123 
-    {
124 
-        // check if class object is instantiated, and instantiated properly
125 
-        if (! self::$_instance instanceof EE_Dependency_Map
126 
-            && $class_cache instanceof ClassInterfaceCache
127 
-        ) {
128 
-            self::$_instance = new EE_Dependency_Map($class_cache);
129 
-        }
130 
-        return self::$_instance;
131 
-    }
132 
-
133 
-
134 
-    /**
135 
-     * @param RequestInterface $request
136 
-     */
137 
-    public function setRequest(RequestInterface $request)
138 
-    {
139 
-        $this->request = $request;
140 
-    }
141 
-
142 
-
143 
-    /**
144 
-     * @param LegacyRequestInterface $legacy_request
145 
-     */
146 
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
147 
-    {
148 
-        $this->legacy_request = $legacy_request;
149 
-    }
150 
-
151 
-
152 
-    /**
153 
-     * @param ResponseInterface $response
154 
-     */
155 
-    public function setResponse(ResponseInterface $response)
156 
-    {
157 
-        $this->response = $response;
158 
-    }
159 
-
160 
-
161 
-    /**
162 
-     * @param LoaderInterface $loader
163 
-     */
164 
-    public function setLoader(LoaderInterface $loader)
165 
-    {
166 
-        $this->loader = $loader;
167 
-    }
168 
-
169 
-
170 
-    /**
171 
-     * @param string $class
172 
-     * @param array  $dependencies
173 
-     * @param int    $overwrite
174 
-     * @return bool
175 
-     */
176 
-    public static function register_dependencies(
177 
-        $class,
178 
-        array $dependencies,
179 
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
180 
-    ) {
181 
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
182 
-    }
183 
-
184 
-
185 
-    /**
186 
-     * Assigns an array of class names and corresponding load sources (new or cached)
187 
-     * to the class specified by the first parameter.
188 
-     * IMPORTANT !!!
189 
-     * The order of elements in the incoming $dependencies array MUST match
190 
-     * the order of the constructor parameters for the class in question.
191 
-     * This is especially important when overriding any existing dependencies that are registered.
192 
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
193 
-     *
194 
-     * @param string $class
195 
-     * @param array  $dependencies
196 
-     * @param int    $overwrite
197 
-     * @return bool
198 
-     */
199 
-    public function registerDependencies(
200 
-        $class,
201 
-        array $dependencies,
202 
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
203 
-    ) {
204 
-        $class = trim($class, '\\');
205 
-        $registered = false;
206 
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
207 
-            self::$_instance->_dependency_map[ $class ] = array();
208 
-        }
209 
-        // we need to make sure that any aliases used when registering a dependency
210 
-        // get resolved to the correct class name
211 
-        foreach ($dependencies as $dependency => $load_source) {
212 
-            $alias = self::$_instance->getFqnForAlias($dependency);
213 
-            if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
214 
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
215 
-            ) {
216 
-                unset($dependencies[ $dependency ]);
217 
-                $dependencies[ $alias ] = $load_source;
218 
-                $registered = true;
219 
-            }
220 
-        }
221 
-        // now add our two lists of dependencies together.
222 
-        // using Union (+=) favours the arrays in precedence from left to right,
223 
-        // so $dependencies is NOT overwritten because it is listed first
224 
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
225 
-        // Union is way faster than array_merge() but should be used with caution...
226 
-        // especially with numerically indexed arrays
227 
-        $dependencies += self::$_instance->_dependency_map[ $class ];
228 
-        // now we need to ensure that the resulting dependencies
229 
-        // array only has the entries that are required for the class
230 
-        // so first count how many dependencies were originally registered for the class
231 
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
232 
-        // if that count is non-zero (meaning dependencies were already registered)
233 
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
234 
-            // then truncate the  final array to match that count
235 
-            ? array_slice($dependencies, 0, $dependency_count)
236 
-            // otherwise just take the incoming array because nothing previously existed
237 
-            : $dependencies;
238 
-        return $registered;
239 
-    }
240 
-
241 
-
242 
-    /**
243 
-     * @param string $class_name
244 
-     * @param string $loader
245 
-     * @return bool
246 
-     * @throws DomainException
247 
-     */
248 
-    public static function register_class_loader($class_name, $loader = 'load_core')
249 
-    {
250 
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
251 
-            throw new DomainException(
252 
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
253 
-            );
254 
-        }
255 
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
256 
-        if (! is_callable($loader)
257 
-            && (
258 
-                strpos($loader, 'load_') !== 0
259 
-                || ! method_exists('EE_Registry', $loader)
260 
-            )
261 
-        ) {
262 
-            throw new DomainException(
263 
-                sprintf(
264 
-                    esc_html__(
265 
-                        '"%1$s" is not a valid loader method on EE_Registry.',
266 
-                        'event_espresso'
267 
-                    ),
268 
-                    $loader
269 
-                )
270 
-            );
271 
-        }
272 
-        $class_name = self::$_instance->getFqnForAlias($class_name);
273 
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
274 
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
275 
-            return true;
276 
-        }
277 
-        return false;
278 
-    }
279 
-
280 
-
281 
-    /**
282 
-     * @return array
283 
-     */
284 
-    public function dependency_map()
285 
-    {
286 
-        return $this->_dependency_map;
287 
-    }
288 
-
289 
-
290 
-    /**
291 
-     * returns TRUE if dependency map contains a listing for the provided class name
292 
-     *
293 
-     * @param string $class_name
294 
-     * @return boolean
295 
-     */
296 
-    public function has($class_name = '')
297 
-    {
298 
-        // all legacy models have the same dependencies
299 
-        if (strpos($class_name, 'EEM_') === 0) {
300 
-            $class_name = 'LEGACY_MODELS';
301 
-        }
302 
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
303 
-    }
304 
-
305 
-
306 
-    /**
307 
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
308 
-     *
309 
-     * @param string $class_name
310 
-     * @param string $dependency
311 
-     * @return bool
312 
-     */
313 
-    public function has_dependency_for_class($class_name = '', $dependency = '')
314 
-    {
315 
-        // all legacy models have the same dependencies
316 
-        if (strpos($class_name, 'EEM_') === 0) {
317 
-            $class_name = 'LEGACY_MODELS';
318 
-        }
319 
-        $dependency = $this->getFqnForAlias($dependency, $class_name);
320 
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
321 
-            ? true
322 
-            : false;
323 
-    }
324 
-
325 
-
326 
-    /**
327 
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
328 
-     *
329 
-     * @param string $class_name
330 
-     * @param string $dependency
331 
-     * @return int
332 
-     */
333 
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
334 
-    {
335 
-        // all legacy models have the same dependencies
336 
-        if (strpos($class_name, 'EEM_') === 0) {
337 
-            $class_name = 'LEGACY_MODELS';
338 
-        }
339 
-        $dependency = $this->getFqnForAlias($dependency);
340 
-        return $this->has_dependency_for_class($class_name, $dependency)
341 
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
342 
-            : EE_Dependency_Map::not_registered;
343 
-    }
344 
-
345 
-
346 
-    /**
347 
-     * @param string $class_name
348 
-     * @return string | Closure
349 
-     */
350 
-    public function class_loader($class_name)
351 
-    {
352 
-        // all legacy models use load_model()
353 
-        if (strpos($class_name, 'EEM_') === 0) {
354 
-            return 'load_model';
355 
-        }
356 
-        // EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
357 
-        // perform strpos() first to avoid loading regex every time we load a class
358 
-        if (strpos($class_name, 'EE_CPT_') === 0
359 
-            && preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
360 
-        ) {
361 
-            return 'load_core';
362 
-        }
363 
-        $class_name = $this->getFqnForAlias($class_name);
364 
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
365 
-    }
366 
-
367 
-
368 
-    /**
369 
-     * @return array
370 
-     */
371 
-    public function class_loaders()
372 
-    {
373 
-        return $this->_class_loaders;
374 
-    }
375 
-
376 
-
377 
-    /**
378 
-     * adds an alias for a classname
379 
-     *
380 
-     * @param string $fqcn      the class name that should be used (concrete class to replace interface)
381 
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
382 
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
383 
-     */
384 
-    public function add_alias($fqcn, $alias, $for_class = '')
385 
-    {
386 
-        $this->class_cache->addAlias($fqcn, $alias, $for_class);
387 
-    }
388 
-
389 
-
390 
-    /**
391 
-     * Returns TRUE if the provided fully qualified name IS an alias
392 
-     * WHY?
393 
-     * Because if a class is type hinting for a concretion,
394 
-     * then why would we need to find another class to supply it?
395 
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
396 
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
397 
-     * Don't go looking for some substitute.
398 
-     * Whereas if a class is type hinting for an interface...
399 
-     * then we need to find an actual class to use.
400 
-     * So the interface IS the alias for some other FQN,
401 
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
402 
-     * represents some other class.
403 
-     *
404 
-     * @param string $fqn
405 
-     * @param string $for_class
406 
-     * @return bool
407 
-     */
408 
-    public function isAlias($fqn = '', $for_class = '')
409 
-    {
410 
-        return $this->class_cache->isAlias($fqn, $for_class);
411 
-    }
412 
-
413 
-
414 
-    /**
415 
-     * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
416 
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
417 
-     *  for example:
418 
-     *      if the following two entries were added to the _aliases array:
419 
-     *          array(
420 
-     *              'interface_alias'           => 'some\namespace\interface'
421 
-     *              'some\namespace\interface'  => 'some\namespace\classname'
422 
-     *          )
423 
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
424 
-     *      to load an instance of 'some\namespace\classname'
425 
-     *
426 
-     * @param string $alias
427 
-     * @param string $for_class
428 
-     * @return string
429 
-     */
430 
-    public function getFqnForAlias($alias = '', $for_class = '')
431 
-    {
432 
-        return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
433 
-    }
434 
-
435 
-
436 
-    /**
437 
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
438 
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
439 
-     * This is done by using the following class constants:
440 
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
441 
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
442 
-     */
443 
-    protected function _register_core_dependencies()
444 
-    {
445 
-        $this->_dependency_map = array(
446 
-            'EE_Request_Handler'                                                                                          => array(
447 
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
448 
-            ),
449 
-            'EE_System'                                                                                                   => array(
450 
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
451 
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
452 
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
453 
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
454 
-            ),
455 
-            'EE_Session'                                                                                                  => array(
456 
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
457 
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
458 
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
459 
-                'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
460 
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
461 
-            ),
462 
-            'EE_Cart'                                                                                                     => array(
463 
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
464 
-            ),
465 
-            'EE_Front_Controller'                                                                                         => array(
466 
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
467 
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
468 
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
469 
-            ),
470 
-            'EE_Messenger_Collection_Loader'                                                                              => array(
471 
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
472 
-            ),
473 
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
474 
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
475 
-            ),
476 
-            'EE_Message_Resource_Manager'                                                                                 => array(
477 
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
478 
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
479 
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
480 
-            ),
481 
-            'EE_Message_Factory'                                                                                          => array(
482 
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
483 
-            ),
484 
-            'EE_messages'                                                                                                 => array(
485 
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
486 
-            ),
487 
-            'EE_Messages_Generator'                                                                                       => array(
488 
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
489 
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
490 
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
491 
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
492 
-            ),
493 
-            'EE_Messages_Processor'                                                                                       => array(
494 
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
495 
-            ),
496 
-            'EE_Messages_Queue'                                                                                           => array(
497 
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
498 
-            ),
499 
-            'EE_Messages_Template_Defaults'                                                                               => array(
500 
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
501 
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
502 
-            ),
503 
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
504 
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
505 
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
506 
-            ),
507 
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
508 
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
509 
-            ),
510 
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
511 
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
512 
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
513 
-            ),
514 
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
515 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
516 
-            ),
517 
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
518 
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
519 
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
520 
-            ),
521 
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
522 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
523 
-            ),
524 
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
525 
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
526 
-            ),
527 
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
528 
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
529 
-            ),
530 
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
531 
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
532 
-            ),
533 
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
534 
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
535 
-            ),
536 
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
537 
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
538 
-            ),
539 
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
540 
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
541 
-            ),
542 
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
543 
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
544 
-            ),
545 
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
546 
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
547 
-            ),
548 
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
549 
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
550 
-            ),
551 
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
552 
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
553 
-            ),
554 
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
555 
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
556 
-            ),
557 
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
558 
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
559 
-            ),
560 
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
561 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
562 
-            ),
563 
-            'EE_Data_Migration_Class_Base'                                                                                => array(
564 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
565 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
566 
-            ),
567 
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
568 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
569 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
570 
-            ),
571 
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
572 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
573 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
574 
-            ),
575 
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
576 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
577 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
578 
-            ),
579 
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
580 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
581 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
582 
-            ),
583 
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
584 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
585 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
586 
-            ),
587 
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
588 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
589 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
590 
-            ),
591 
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
592 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
593 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
594 
-            ),
595 
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
596 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
597 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
598 
-            ),
599 
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
600 
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
601 
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
602 
-            ),
603 
-            'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
604 
-                array(),
605 
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
606 
-            ),
607 
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
608 
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
609 
-                'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
610 
-            ),
611 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
612 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
613 
-            ),
614 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
615 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
616 
-            ),
617 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
618 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
619 
-            ),
620 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
621 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
622 
-            ),
623 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
624 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
625 
-            ),
626 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
627 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
628 
-            ),
629 
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
630 
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
631 
-            ),
632 
-            'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
633 
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
634 
-            ),
635 
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
636 
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
637 
-            ),
638 
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
639 
-                'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
640 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
641 
-            ),
642 
-            'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
643 
-                null,
644 
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
645 
-            ),
646 
-            'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
647 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
648 
-            ),
649 
-            'LEGACY_MODELS'                                                                                               => array(
650 
-                null,
651 
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
652 
-            ),
653 
-            'EE_Module_Request_Router'                                                                                    => array(
654 
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
655 
-            ),
656 
-            'EE_Registration_Processor'                                                                                   => array(
657 
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
658 
-            ),
659 
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
660 
-                null,
661 
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
662 
-                'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
663 
-            ),
664 
-            'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
665 
-                'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
666 
-                'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
667 
-            ),
668 
-            'EE_Admin_Transactions_List_Table'                                                                            => array(
669 
-                null,
670 
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
671 
-            ),
672 
-            'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
673 
-                'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
674 
-                'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
675 
-                'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
676 
-            ),
677 
-            'EventEspresso\core\domain\services\pue\Config'                                                               => array(
678 
-                'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
679 
-                'EE_Config'         => EE_Dependency_Map::load_from_cache,
680 
-            ),
681 
-            'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
682 
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
683 
-                'EEM_Event'          => EE_Dependency_Map::load_from_cache,
684 
-                'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
685 
-                'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
686 
-                'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
687 
-                'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
688 
-                'EE_Config'          => EE_Dependency_Map::load_from_cache,
689 
-            ),
690 
-            'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
691 
-                'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
692 
-            ),
693 
-            'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
694 
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
695 
-            ),
696 
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
697 
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
698 
-                'EE_Session'             => EE_Dependency_Map::load_from_cache,
699 
-            ),
700 
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
701 
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
702 
-            ),
703 
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
704 
-                'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
705 
-                'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
706 
-                'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
707 
-                'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
708 
-                'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
709 
-            ),
710 
-            'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
711 
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
712 
-            ),
713 
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
714 
-                'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
715 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
716 
-            ),
717 
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
718 
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
719 
-            ),
720 
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
721 
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
722 
-            ),
723 
-            'EE_CPT_Strategy'                                                                                             => array(
724 
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
725 
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
726 
-            ),
727 
-            'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
728 
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
729 
-            ),
730 
-            'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
731 
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
732 
-                'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
733 
-                'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
734 
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
735 
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
736 
-            ),
737 
-            'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
738 
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
739 
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
740 
-            ),
741 
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
742 
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
743 
-            ),
744 
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
745 
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
746 
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
747 
-            ),
748 
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
749 
-                'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
750 
-            ),
751 
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
752 
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache,
753 
-            ),
754 
-            'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
755 
-                'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
756 
-            ),
757 
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
758 
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
759 
-            ),
760 
-            'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
761 
-                'EEM_Answer' => EE_Dependency_Map::load_from_cache,
762 
-                'EEM_Question' => EE_Dependency_Map::load_from_cache,
763 
-            ),
764 
-            'EventEspresso\core\CPTs\CptQueryModifier' => array(
765 
-                null,
766 
-                null,
767 
-                null,
768 
-                'EE_Request_Handler'                          => EE_Dependency_Map::load_from_cache,
769 
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
770 
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
771 
-            ),
772 
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array(
773 
-                'EE_Registry' => EE_Dependency_Map::load_from_cache,
774 
-                'EE_Config' => EE_Dependency_Map::load_from_cache
775 
-            ),
776 
-            'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
777 
-                'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
778 
-                'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
779 
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
780 
-                'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
781 
-            ),
782 
-            'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => array(
783 
-                'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
784 
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
785 
-                'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
786 
-            ),
787 
-            'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => array(
788 
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
789 
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
790 
-            ),
791 
-            'EventEspresso\core\domain\entities\editor\blocks\EventAttendees' => array(
792 
-                'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => self::load_from_cache,
793 
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
794 
-                'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => self::load_from_cache,
795 
-            ),
796 
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array(
797 
-                'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache,
798 
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
799 
-                'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
800 
-            ),
801 
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array(
802 
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
803 
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
804 
-            ),
805 
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array(
806 
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
807 
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache,
808 
-            ),
809 
-            'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => array(
810 
-                'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache
811 
-            ),
812 
-            'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => array(
813 
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
814 
-            ),
815 
-            'EventEspresso\core\libraries\rest_api\controllers\model\Read' => array(
816 
-                'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache
817 
-            ),
818 
-            'EventEspresso\core\libraries\rest_api\calculations\Datetime' => array(
819 
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
820 
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
821 
-            ),
822 
-            'EventEspresso\core\libraries\rest_api\calculations\Event' => array(
823 
-                'EEM_Event' => EE_Dependency_Map::load_from_cache,
824 
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
825 
-            ),
826 
-            'EventEspresso\core\libraries\rest_api\calculations\Registration' => array(
827 
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
828 
-            ),
829 
-            'EventEspresso\core\services\session\SessionStartHandler' => array(
830 
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
831 
-            ),
832 
-            'EE_URL_Validation_Strategy' => array(
833 
-                null,
834 
-                null,
835 
-                'EventEspresso\core\services\validators\URLValidator' => EE_Dependency_Map::load_from_cache
836 
-            ),
837 
-            'EventEspresso\admin_pages\general_settings\OrganizationSettings' => array(
838 
-                'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
839 
-                'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
840 
-                'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
841 
-                'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
842 
-                'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
843 
-            ),
844 
-            'EventEspresso\core\services\address\CountrySubRegionDao' => array(
845 
-                'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
846 
-                'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
847 
-            ),
848 
-            'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat' => array(
849 
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
850 
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
851 
-            ),
852 
-            'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat' => array(
853 
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
854 
-                'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
855 
-            ),
856 
-        );
857 
-    }
858 
-
859 
-
860 
-    /**
861 
-     * Registers how core classes are loaded.
862 
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
863 
-     *        'EE_Request_Handler' => 'load_core'
864 
-     *        'EE_Messages_Queue'  => 'load_lib'
865 
-     *        'EEH_Debug_Tools'    => 'load_helper'
866 
-     * or, if greater control is required, by providing a custom closure. For example:
867 
-     *        'Some_Class' => function () {
868 
-     *            return new Some_Class();
869 
-     *        },
870 
-     * This is required for instantiating dependencies
871 
-     * where an interface has been type hinted in a class constructor. For example:
872 
-     *        'Required_Interface' => function () {
873 
-     *            return new A_Class_That_Implements_Required_Interface();
874 
-     *        },
875 
-     */
876 
-    protected function _register_core_class_loaders()
877 
-    {
878 
-        $this->_class_loaders = array(
879 
-            // load_core
880 
-            'EE_Dependency_Map'                            => function () {
881 
-                return $this;
882 
-            },
883 
-            'EE_Capabilities'                              => 'load_core',
884 
-            'EE_Encryption'                                => 'load_core',
885 
-            'EE_Front_Controller'                          => 'load_core',
886 
-            'EE_Module_Request_Router'                     => 'load_core',
887 
-            'EE_Registry'                                  => 'load_core',
888 
-            'EE_Request'                                   => function () {
889 
-                return $this->legacy_request;
890 
-            },
891 
-            'EventEspresso\core\services\request\Request'  => function () {
892 
-                return $this->request;
893 
-            },
894 
-            'EventEspresso\core\services\request\Response' => function () {
895 
-                return $this->response;
896 
-            },
897 
-            'EE_Base'                                      => 'load_core',
898 
-            'EE_Request_Handler'                           => 'load_core',
899 
-            'EE_Session'                                   => 'load_core',
900 
-            'EE_Cron_Tasks'                                => 'load_core',
901 
-            'EE_System'                                    => 'load_core',
902 
-            'EE_Maintenance_Mode'                          => 'load_core',
903 
-            'EE_Register_CPTs'                             => 'load_core',
904 
-            'EE_Admin'                                     => 'load_core',
905 
-            'EE_CPT_Strategy'                              => 'load_core',
906 
-            // load_lib
907 
-            'EE_Message_Resource_Manager'                  => 'load_lib',
908 
-            'EE_Message_Type_Collection'                   => 'load_lib',
909 
-            'EE_Message_Type_Collection_Loader'            => 'load_lib',
910 
-            'EE_Messenger_Collection'                      => 'load_lib',
911 
-            'EE_Messenger_Collection_Loader'               => 'load_lib',
912 
-            'EE_Messages_Processor'                        => 'load_lib',
913 
-            'EE_Message_Repository'                        => 'load_lib',
914 
-            'EE_Messages_Queue'                            => 'load_lib',
915 
-            'EE_Messages_Data_Handler_Collection'          => 'load_lib',
916 
-            'EE_Message_Template_Group_Collection'         => 'load_lib',
917 
-            'EE_Payment_Method_Manager'                    => 'load_lib',
918 
-            'EE_Messages_Generator'                        => function () {
919 
-                return EE_Registry::instance()->load_lib(
920 
-                    'Messages_Generator',
921 
-                    array(),
922 
-                    false,
923 
-                    false
924 
-                );
925 
-            },
926 
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
927 
-                return EE_Registry::instance()->load_lib(
928 
-                    'Messages_Template_Defaults',
929 
-                    $arguments,
930 
-                    false,
931 
-                    false
932 
-                );
933 
-            },
934 
-            // load_helper
935 
-            'EEH_Parse_Shortcodes'                         => function () {
936 
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
937 
-                    return new EEH_Parse_Shortcodes();
938 
-                }
939 
-                return null;
940 
-            },
941 
-            'EE_Template_Config'                           => function () {
942 
-                return EE_Config::instance()->template_settings;
943 
-            },
944 
-            'EE_Currency_Config'                           => function () {
945 
-                return EE_Config::instance()->currency;
946 
-            },
947 
-            'EE_Registration_Config'                       => function () {
948 
-                return EE_Config::instance()->registration;
949 
-            },
950 
-            'EE_Core_Config'                               => function () {
951 
-                return EE_Config::instance()->core;
952 
-            },
953 
-            'EventEspresso\core\services\loaders\Loader'   => function () {
954 
-                return LoaderFactory::getLoader();
955 
-            },
956 
-            'EE_Network_Config'                            => function () {
957 
-                return EE_Network_Config::instance();
958 
-            },
959 
-            'EE_Config'                                    => function () {
960 
-                return EE_Config::instance();
961 
-            },
962 
-            'EventEspresso\core\domain\Domain'             => function () {
963 
-                return DomainFactory::getEventEspressoCoreDomain();
964 
-            },
965 
-            'EE_Admin_Config'                              => function () {
966 
-                return EE_Config::instance()->admin;
967 
-            },
968 
-            'EE_Organization_Config'                       => function () {
969 
-                return EE_Config::instance()->organization;
970 
-            },
971 
-            'EE_Network_Core_Config'                       => function () {
972 
-                return EE_Network_Config::instance()->core;
973 
-            },
974 
-            'EE_Environment_Config'                        => function () {
975 
-                return EE_Config::instance()->environment;
976 
-            },
977 
-        );
978 
-    }
979 
-
980 
-
981 
-    /**
982 
-     * can be used for supplying alternate names for classes,
983 
-     * or for connecting interface names to instantiable classes
984 
-     */
985 
-    protected function _register_core_aliases()
986 
-    {
987 
-        $aliases = array(
988 
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
989 
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
990 
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
991 
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
992 
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
993 
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
994 
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
995 
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
996 
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
997 
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
998 
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
999 
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
1000 
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
1001 
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
1002 
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
1003 
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
1004 
-            'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
1005 
-            'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
1006 
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
1007 
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
1008 
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
1009 
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
1010 
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
1011 
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
1012 
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
1013 
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
1014 
-            'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
1015 
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
1016 
-            'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
1017 
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
1018 
-            'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
1019 
-            'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
1020 
-            'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
1021 
-            'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
1022 
-            'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
1023 
-            'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
1024 
-            'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
1025 
-        );
1026 
-        foreach ($aliases as $alias => $fqn) {
1027 
-            if (is_array($fqn)) {
1028 
-                foreach ($fqn as $class => $for_class) {
1029 
-                    $this->class_cache->addAlias($class, $alias, $for_class);
1030 
-                }
1031 
-                continue;
1032 
-            }
1033 
-            $this->class_cache->addAlias($fqn, $alias);
1034 
-        }
1035 
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
1036 
-            $this->class_cache->addAlias(
1037 
-                'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
1038 
-                'EventEspresso\core\services\notices\NoticeConverterInterface'
1039 
-            );
1040 
-        }
1041 
-    }
1042 
-
1043 
-
1044 
-    /**
1045 
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
1046 
-     * request Primarily used by unit tests.
1047 
-     */
1048 
-    public function reset()
1049 
-    {
1050 
-        $this->_register_core_class_loaders();
1051 
-        $this->_register_core_dependencies();
1052 
-    }
1053 
-
1054 
-
1055 
-    /**
1056 
-     * PLZ NOTE: a better name for this method would be is_alias()
1057 
-     * because it returns TRUE if the provided fully qualified name IS an alias
1058 
-     * WHY?
1059 
-     * Because if a class is type hinting for a concretion,
1060 
-     * then why would we need to find another class to supply it?
1061 
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
1062 
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
1063 
-     * Don't go looking for some substitute.
1064 
-     * Whereas if a class is type hinting for an interface...
1065 
-     * then we need to find an actual class to use.
1066 
-     * So the interface IS the alias for some other FQN,
1067 
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
1068 
-     * represents some other class.
1069 
-     *
1070 
-     * @deprecated 4.9.62.p
1071 
-     * @param string $fqn
1072 
-     * @param string $for_class
1073 
-     * @return bool
1074 
-     */
1075 
-    public function has_alias($fqn = '', $for_class = '')
1076 
-    {
1077 
-        return $this->isAlias($fqn, $for_class);
1078 
-    }
1079 
-
1080 
-
1081 
-    /**
1082 
-     * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
1083 
-     * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
1084 
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
1085 
-     *  for example:
1086 
-     *      if the following two entries were added to the _aliases array:
1087 
-     *          array(
1088 
-     *              'interface_alias'           => 'some\namespace\interface'
1089 
-     *              'some\namespace\interface'  => 'some\namespace\classname'
1090 
-     *          )
1091 
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
1092 
-     *      to load an instance of 'some\namespace\classname'
1093 
-     *
1094 
-     * @deprecated 4.9.62.p
1095 
-     * @param string $alias
1096 
-     * @param string $for_class
1097 
-     * @return string
1098 
-     */
1099 
-    public function get_alias($alias = '', $for_class = '')
1100 
-    {
1101 
-        return $this->getFqnForAlias($alias, $for_class);
1102 
-    }
23 
+	/**
24 
+	 * This means that the requested class dependency is not present in the dependency map
25 
+	 */
26 
+	const not_registered = 0;
27 
+
28 
+	/**
29 
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
30 
+	 */
31 
+	const load_new_object = 1;
32 
+
33 
+	/**
34 
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
35 
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
36 
+	 */
37 
+	const load_from_cache = 2;
38 
+
39 
+	/**
40 
+	 * When registering a dependency,
41 
+	 * this indicates to keep any existing dependencies that already exist,
42 
+	 * and simply discard any new dependencies declared in the incoming data
43 
+	 */
44 
+	const KEEP_EXISTING_DEPENDENCIES = 0;
45 
+
46 
+	/**
47 
+	 * When registering a dependency,
48 
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
49 
+	 */
50 
+	const OVERWRITE_DEPENDENCIES = 1;
51 
+
52 
+
53 
+	/**
54 
+	 * @type EE_Dependency_Map $_instance
55 
+	 */
56 
+	protected static $_instance;
57 
+
58 
+	/**
59 
+	 * @var ClassInterfaceCache $class_cache
60 
+	 */
61 
+	private $class_cache;
62 
+
63 
+	/**
64 
+	 * @type RequestInterface $request
65 
+	 */
66 
+	protected $request;
67 
+
68 
+	/**
69 
+	 * @type LegacyRequestInterface $legacy_request
70 
+	 */
71 
+	protected $legacy_request;
72 
+
73 
+	/**
74 
+	 * @type ResponseInterface $response
75 
+	 */
76 
+	protected $response;
77 
+
78 
+	/**
79 
+	 * @type LoaderInterface $loader
80 
+	 */
81 
+	protected $loader;
82 
+
83 
+	/**
84 
+	 * @type array $_dependency_map
85 
+	 */
86 
+	protected $_dependency_map = array();
87 
+
88 
+	/**
89 
+	 * @type array $_class_loaders
90 
+	 */
91 
+	protected $_class_loaders = array();
92 
+
93 
+
94 
+	/**
95 
+	 * EE_Dependency_Map constructor.
96 
+	 *
97 
+	 * @param ClassInterfaceCache $class_cache
98 
+	 */
99 
+	protected function __construct(ClassInterfaceCache $class_cache)
100 
+	{
101 
+		$this->class_cache = $class_cache;
102 
+		do_action('EE_Dependency_Map____construct', $this);
103 
+	}
104 
+
105 
+
106 
+	/**
107 
+	 * @return void
108 
+	 */
109 
+	public function initialize()
110 
+	{
111 
+		$this->_register_core_dependencies();
112 
+		$this->_register_core_class_loaders();
113 
+		$this->_register_core_aliases();
114 
+	}
115 
+
116 
+
117 
+	/**
118 
+	 * @singleton method used to instantiate class object
119 
+	 * @param ClassInterfaceCache|null $class_cache
120 
+	 * @return EE_Dependency_Map
121 
+	 */
122 
+	public static function instance(ClassInterfaceCache $class_cache = null)
123 
+	{
124 
+		// check if class object is instantiated, and instantiated properly
125 
+		if (! self::$_instance instanceof EE_Dependency_Map
126 
+			&& $class_cache instanceof ClassInterfaceCache
127 
+		) {
128 
+			self::$_instance = new EE_Dependency_Map($class_cache);
129 
+		}
130 
+		return self::$_instance;
131 
+	}
132 
+
133 
+
134 
+	/**
135 
+	 * @param RequestInterface $request
136 
+	 */
137 
+	public function setRequest(RequestInterface $request)
138 
+	{
139 
+		$this->request = $request;
140 
+	}
141 
+
142 
+
143 
+	/**
144 
+	 * @param LegacyRequestInterface $legacy_request
145 
+	 */
146 
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
147 
+	{
148 
+		$this->legacy_request = $legacy_request;
149 
+	}
150 
+
151 
+
152 
+	/**
153 
+	 * @param ResponseInterface $response
154 
+	 */
155 
+	public function setResponse(ResponseInterface $response)
156 
+	{
157 
+		$this->response = $response;
158 
+	}
159 
+
160 
+
161 
+	/**
162 
+	 * @param LoaderInterface $loader
163 
+	 */
164 
+	public function setLoader(LoaderInterface $loader)
165 
+	{
166 
+		$this->loader = $loader;
167 
+	}
168 
+
169 
+
170 
+	/**
171 
+	 * @param string $class
172 
+	 * @param array  $dependencies
173 
+	 * @param int    $overwrite
174 
+	 * @return bool
175 
+	 */
176 
+	public static function register_dependencies(
177 
+		$class,
178 
+		array $dependencies,
179 
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
180 
+	) {
181 
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
182 
+	}
183 
+
184 
+
185 
+	/**
186 
+	 * Assigns an array of class names and corresponding load sources (new or cached)
187 
+	 * to the class specified by the first parameter.
188 
+	 * IMPORTANT !!!
189 
+	 * The order of elements in the incoming $dependencies array MUST match
190 
+	 * the order of the constructor parameters for the class in question.
191 
+	 * This is especially important when overriding any existing dependencies that are registered.
192 
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
193 
+	 *
194 
+	 * @param string $class
195 
+	 * @param array  $dependencies
196 
+	 * @param int    $overwrite
197 
+	 * @return bool
198 
+	 */
199 
+	public function registerDependencies(
200 
+		$class,
201 
+		array $dependencies,
202 
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
203 
+	) {
204 
+		$class = trim($class, '\\');
205 
+		$registered = false;
206 
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
207 
+			self::$_instance->_dependency_map[ $class ] = array();
208 
+		}
209 
+		// we need to make sure that any aliases used when registering a dependency
210 
+		// get resolved to the correct class name
211 
+		foreach ($dependencies as $dependency => $load_source) {
212 
+			$alias = self::$_instance->getFqnForAlias($dependency);
213 
+			if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
214 
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
215 
+			) {
216 
+				unset($dependencies[ $dependency ]);
217 
+				$dependencies[ $alias ] = $load_source;
218 
+				$registered = true;
219 
+			}
220 
+		}
221 
+		// now add our two lists of dependencies together.
222 
+		// using Union (+=) favours the arrays in precedence from left to right,
223 
+		// so $dependencies is NOT overwritten because it is listed first
224 
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
225 
+		// Union is way faster than array_merge() but should be used with caution...
226 
+		// especially with numerically indexed arrays
227 
+		$dependencies += self::$_instance->_dependency_map[ $class ];
228 
+		// now we need to ensure that the resulting dependencies
229 
+		// array only has the entries that are required for the class
230 
+		// so first count how many dependencies were originally registered for the class
231 
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
232 
+		// if that count is non-zero (meaning dependencies were already registered)
233 
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
234 
+			// then truncate the  final array to match that count
235 
+			? array_slice($dependencies, 0, $dependency_count)
236 
+			// otherwise just take the incoming array because nothing previously existed
237 
+			: $dependencies;
238 
+		return $registered;
239 
+	}
240 
+
241 
+
242 
+	/**
243 
+	 * @param string $class_name
244 
+	 * @param string $loader
245 
+	 * @return bool
246 
+	 * @throws DomainException
247 
+	 */
248 
+	public static function register_class_loader($class_name, $loader = 'load_core')
249 
+	{
250 
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
251 
+			throw new DomainException(
252 
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
253 
+			);
254 
+		}
255 
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
256 
+		if (! is_callable($loader)
257 
+			&& (
258 
+				strpos($loader, 'load_') !== 0
259 
+				|| ! method_exists('EE_Registry', $loader)
260 
+			)
261 
+		) {
262 
+			throw new DomainException(
263 
+				sprintf(
264 
+					esc_html__(
265 
+						'"%1$s" is not a valid loader method on EE_Registry.',
266 
+						'event_espresso'
267 
+					),
268 
+					$loader
269 
+				)
270 
+			);
271 
+		}
272 
+		$class_name = self::$_instance->getFqnForAlias($class_name);
273 
+		if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
274 
+			self::$_instance->_class_loaders[ $class_name ] = $loader;
275 
+			return true;
276 
+		}
277 
+		return false;
278 
+	}
279 
+
280 
+
281 
+	/**
282 
+	 * @return array
283 
+	 */
284 
+	public function dependency_map()
285 
+	{
286 
+		return $this->_dependency_map;
287 
+	}
288 
+
289 
+
290 
+	/**
291 
+	 * returns TRUE if dependency map contains a listing for the provided class name
292 
+	 *
293 
+	 * @param string $class_name
294 
+	 * @return boolean
295 
+	 */
296 
+	public function has($class_name = '')
297 
+	{
298 
+		// all legacy models have the same dependencies
299 
+		if (strpos($class_name, 'EEM_') === 0) {
300 
+			$class_name = 'LEGACY_MODELS';
301 
+		}
302 
+		return isset($this->_dependency_map[ $class_name ]) ? true : false;
303 
+	}
304 
+
305 
+
306 
+	/**
307 
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
308 
+	 *
309 
+	 * @param string $class_name
310 
+	 * @param string $dependency
311 
+	 * @return bool
312 
+	 */
313 
+	public function has_dependency_for_class($class_name = '', $dependency = '')
314 
+	{
315 
+		// all legacy models have the same dependencies
316 
+		if (strpos($class_name, 'EEM_') === 0) {
317 
+			$class_name = 'LEGACY_MODELS';
318 
+		}
319 
+		$dependency = $this->getFqnForAlias($dependency, $class_name);
320 
+		return isset($this->_dependency_map[ $class_name ][ $dependency ])
321 
+			? true
322 
+			: false;
323 
+	}
324 
+
325 
+
326 
+	/**
327 
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
328 
+	 *
329 
+	 * @param string $class_name
330 
+	 * @param string $dependency
331 
+	 * @return int
332 
+	 */
333 
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
334 
+	{
335 
+		// all legacy models have the same dependencies
336 
+		if (strpos($class_name, 'EEM_') === 0) {
337 
+			$class_name = 'LEGACY_MODELS';
338 
+		}
339 
+		$dependency = $this->getFqnForAlias($dependency);
340 
+		return $this->has_dependency_for_class($class_name, $dependency)
341 
+			? $this->_dependency_map[ $class_name ][ $dependency ]
342 
+			: EE_Dependency_Map::not_registered;
343 
+	}
344 
+
345 
+
346 
+	/**
347 
+	 * @param string $class_name
348 
+	 * @return string | Closure
349 
+	 */
350 
+	public function class_loader($class_name)
351 
+	{
352 
+		// all legacy models use load_model()
353 
+		if (strpos($class_name, 'EEM_') === 0) {
354 
+			return 'load_model';
355 
+		}
356 
+		// EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
357 
+		// perform strpos() first to avoid loading regex every time we load a class
358 
+		if (strpos($class_name, 'EE_CPT_') === 0
359 
+			&& preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
360 
+		) {
361 
+			return 'load_core';
362 
+		}
363 
+		$class_name = $this->getFqnForAlias($class_name);
364 
+		return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
365 
+	}
366 
+
367 
+
368 
+	/**
369 
+	 * @return array
370 
+	 */
371 
+	public function class_loaders()
372 
+	{
373 
+		return $this->_class_loaders;
374 
+	}
375 
+
376 
+
377 
+	/**
378 
+	 * adds an alias for a classname
379 
+	 *
380 
+	 * @param string $fqcn      the class name that should be used (concrete class to replace interface)
381 
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
382 
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
383 
+	 */
384 
+	public function add_alias($fqcn, $alias, $for_class = '')
385 
+	{
386 
+		$this->class_cache->addAlias($fqcn, $alias, $for_class);
387 
+	}
388 
+
389 
+
390 
+	/**
391 
+	 * Returns TRUE if the provided fully qualified name IS an alias
392 
+	 * WHY?
393 
+	 * Because if a class is type hinting for a concretion,
394 
+	 * then why would we need to find another class to supply it?
395 
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
396 
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
397 
+	 * Don't go looking for some substitute.
398 
+	 * Whereas if a class is type hinting for an interface...
399 
+	 * then we need to find an actual class to use.
400 
+	 * So the interface IS the alias for some other FQN,
401 
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
402 
+	 * represents some other class.
403 
+	 *
404 
+	 * @param string $fqn
405 
+	 * @param string $for_class
406 
+	 * @return bool
407 
+	 */
408 
+	public function isAlias($fqn = '', $for_class = '')
409 
+	{
410 
+		return $this->class_cache->isAlias($fqn, $for_class);
411 
+	}
412 
+
413 
+
414 
+	/**
415 
+	 * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
416 
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
417 
+	 *  for example:
418 
+	 *      if the following two entries were added to the _aliases array:
419 
+	 *          array(
420 
+	 *              'interface_alias'           => 'some\namespace\interface'
421 
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
422 
+	 *          )
423 
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
424 
+	 *      to load an instance of 'some\namespace\classname'
425 
+	 *
426 
+	 * @param string $alias
427 
+	 * @param string $for_class
428 
+	 * @return string
429 
+	 */
430 
+	public function getFqnForAlias($alias = '', $for_class = '')
431 
+	{
432 
+		return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
433 
+	}
434 
+
435 
+
436 
+	/**
437 
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
438 
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
439 
+	 * This is done by using the following class constants:
440 
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
441 
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
442 
+	 */
443 
+	protected function _register_core_dependencies()
444 
+	{
445 
+		$this->_dependency_map = array(
446 
+			'EE_Request_Handler'                                                                                          => array(
447 
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
448 
+			),
449 
+			'EE_System'                                                                                                   => array(
450 
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
451 
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
452 
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
453 
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
454 
+			),
455 
+			'EE_Session'                                                                                                  => array(
456 
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
457 
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
458 
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
459 
+				'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
460 
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
461 
+			),
462 
+			'EE_Cart'                                                                                                     => array(
463 
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
464 
+			),
465 
+			'EE_Front_Controller'                                                                                         => array(
466 
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
467 
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
468 
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
469 
+			),
470 
+			'EE_Messenger_Collection_Loader'                                                                              => array(
471 
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
472 
+			),
473 
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
474 
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
475 
+			),
476 
+			'EE_Message_Resource_Manager'                                                                                 => array(
477 
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
478 
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
479 
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
480 
+			),
481 
+			'EE_Message_Factory'                                                                                          => array(
482 
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
483 
+			),
484 
+			'EE_messages'                                                                                                 => array(
485 
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
486 
+			),
487 
+			'EE_Messages_Generator'                                                                                       => array(
488 
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
489 
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
490 
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
491 
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
492 
+			),
493 
+			'EE_Messages_Processor'                                                                                       => array(
494 
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
495 
+			),
496 
+			'EE_Messages_Queue'                                                                                           => array(
497 
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
498 
+			),
499 
+			'EE_Messages_Template_Defaults'                                                                               => array(
500 
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
501 
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
502 
+			),
503 
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
504 
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
505 
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
506 
+			),
507 
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
508 
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
509 
+			),
510 
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
511 
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
512 
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
513 
+			),
514 
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
515 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
516 
+			),
517 
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
518 
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
519 
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
520 
+			),
521 
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
522 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
523 
+			),
524 
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
525 
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
526 
+			),
527 
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
528 
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
529 
+			),
530 
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
531 
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
532 
+			),
533 
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
534 
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
535 
+			),
536 
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
537 
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
538 
+			),
539 
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
540 
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
541 
+			),
542 
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
543 
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
544 
+			),
545 
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
546 
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
547 
+			),
548 
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
549 
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
550 
+			),
551 
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
552 
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
553 
+			),
554 
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
555 
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
556 
+			),
557 
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
558 
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
559 
+			),
560 
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
561 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
562 
+			),
563 
+			'EE_Data_Migration_Class_Base'                                                                                => array(
564 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
565 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
566 
+			),
567 
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
568 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
569 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
570 
+			),
571 
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
572 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
573 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
574 
+			),
575 
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
576 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
577 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
578 
+			),
579 
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
580 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
581 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
582 
+			),
583 
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
584 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
585 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
586 
+			),
587 
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
588 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
589 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
590 
+			),
591 
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
592 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
593 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
594 
+			),
595 
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
596 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
597 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
598 
+			),
599 
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
600 
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
601 
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
602 
+			),
603 
+			'EventEspresso\core\services\assets\I18nRegistry'                                                             => array(
604 
+				array(),
605 
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
606 
+			),
607 
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
608 
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
609 
+				'EventEspresso\core\services\assets\I18nRegistry'    => EE_Dependency_Map::load_from_cache,
610 
+			),
611 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
612 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
613 
+			),
614 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
615 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
616 
+			),
617 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
618 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
619 
+			),
620 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
621 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
622 
+			),
623 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
624 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
625 
+			),
626 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
627 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
628 
+			),
629 
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
630 
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
631 
+			),
632 
+			'EventEspresso\core\services\cache\BasicCacheManager'                                                         => array(
633 
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
634 
+			),
635 
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                   => array(
636 
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
637 
+			),
638 
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                  => array(
639 
+				'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
640 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
641 
+			),
642 
+			'EventEspresso\core\domain\values\EmailAddress'                                                               => array(
643 
+				null,
644 
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
645 
+			),
646 
+			'EventEspresso\core\services\orm\ModelFieldFactory'                                                           => array(
647 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
648 
+			),
649 
+			'LEGACY_MODELS'                                                                                               => array(
650 
+				null,
651 
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
652 
+			),
653 
+			'EE_Module_Request_Router'                                                                                    => array(
654 
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
655 
+			),
656 
+			'EE_Registration_Processor'                                                                                   => array(
657 
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
658 
+			),
659 
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                      => array(
660 
+				null,
661 
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
662 
+				'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
663 
+			),
664 
+			'EventEspresso\core\services\licensing\LicenseService'                                                        => array(
665 
+				'EventEspresso\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
666 
+				'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
667 
+			),
668 
+			'EE_Admin_Transactions_List_Table'                                                                            => array(
669 
+				null,
670 
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
671 
+			),
672 
+			'EventEspresso\core\domain\services\pue\Stats'                                                                => array(
673 
+				'EventEspresso\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
674 
+				'EE_Maintenance_Mode'                                  => EE_Dependency_Map::load_from_cache,
675 
+				'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
676 
+			),
677 
+			'EventEspresso\core\domain\services\pue\Config'                                                               => array(
678 
+				'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
679 
+				'EE_Config'         => EE_Dependency_Map::load_from_cache,
680 
+			),
681 
+			'EventEspresso\core\domain\services\pue\StatsGatherer'                                                        => array(
682 
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
683 
+				'EEM_Event'          => EE_Dependency_Map::load_from_cache,
684 
+				'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
685 
+				'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
686 
+				'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
687 
+				'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
688 
+				'EE_Config'          => EE_Dependency_Map::load_from_cache,
689 
+			),
690 
+			'EventEspresso\core\domain\services\admin\ExitModal'                                                          => array(
691 
+				'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache,
692 
+			),
693 
+			'EventEspresso\core\domain\services\admin\PluginUpsells'                                                      => array(
694 
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
695 
+			),
696 
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                    => array(
697 
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
698 
+				'EE_Session'             => EE_Dependency_Map::load_from_cache,
699 
+			),
700 
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings'                                => array(
701 
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
702 
+			),
703 
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                 => array(
704 
+				'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
705 
+				'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
706 
+				'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
707 
+				'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
708 
+				'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
709 
+			),
710 
+			'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                     => array(
711 
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
712 
+			),
713 
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                              => array(
714 
+				'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
715 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
716 
+			),
717 
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                => array(
718 
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
719 
+			),
720 
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                               => array(
721 
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
722 
+			),
723 
+			'EE_CPT_Strategy'                                                                                             => array(
724 
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
725 
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
726 
+			),
727 
+			'EventEspresso\core\services\loaders\ObjectIdentifier'                                                        => array(
728 
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
729 
+			),
730 
+			'EventEspresso\core\domain\services\assets\CoreAssetManager'                                                  => array(
731 
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
732 
+				'EE_Currency_Config'                                 => EE_Dependency_Map::load_from_cache,
733 
+				'EE_Template_Config'                                 => EE_Dependency_Map::load_from_cache,
734 
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
735 
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
736 
+			),
737 
+			'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array(
738 
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
739 
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache
740 
+			),
741 
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array(
742 
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
743 
+			),
744 
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array(
745 
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
746 
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache
747 
+			),
748 
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array(
749 
+				'EEM_Checkin' => EE_Dependency_Map::load_from_cache,
750 
+			),
751 
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array(
752 
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache,
753 
+			),
754 
+			'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array(
755 
+				'EEM_Transaction' => EE_Dependency_Map::load_from_cache,
756 
+			),
757 
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array(
758 
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
759 
+			),
760 
+			'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array(
761 
+				'EEM_Answer' => EE_Dependency_Map::load_from_cache,
762 
+				'EEM_Question' => EE_Dependency_Map::load_from_cache,
763 
+			),
764 
+			'EventEspresso\core\CPTs\CptQueryModifier' => array(
765 
+				null,
766 
+				null,
767 
+				null,
768 
+				'EE_Request_Handler'                          => EE_Dependency_Map::load_from_cache,
769 
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
770 
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
771 
+			),
772 
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array(
773 
+				'EE_Registry' => EE_Dependency_Map::load_from_cache,
774 
+				'EE_Config' => EE_Dependency_Map::load_from_cache
775 
+			),
776 
+			'EventEspresso\core\services\editor\BlockRegistrationManager'                                                 => array(
777 
+				'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache,
778 
+				'EventEspresso\core\domain\entities\editor\BlockCollection'      => EE_Dependency_Map::load_from_cache,
779 
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache,
780 
+				'EventEspresso\core\services\request\Request'                    => EE_Dependency_Map::load_from_cache,
781 
+			),
782 
+			'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => array(
783 
+				'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
784 
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
785 
+				'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
786 
+			),
787 
+			'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => array(
788 
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
789 
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
790 
+			),
791 
+			'EventEspresso\core\domain\entities\editor\blocks\EventAttendees' => array(
792 
+				'EventEspresso\core\domain\entities\editor\CoreBlocksAssetManager' => self::load_from_cache,
793 
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
794 
+				'EventEspresso\core\domain\services\blocks\EventAttendeesBlockRenderer' => self::load_from_cache,
795 
+			),
796 
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array(
797 
+				'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache,
798 
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
799 
+				'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
800 
+			),
801 
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array(
802 
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
803 
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
804 
+			),
805 
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array(
806 
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
807 
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache,
808 
+			),
809 
+			'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => array(
810 
+				'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache
811 
+			),
812 
+			'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => array(
813 
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
814 
+			),
815 
+			'EventEspresso\core\libraries\rest_api\controllers\model\Read' => array(
816 
+				'EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache
817 
+			),
818 
+			'EventEspresso\core\libraries\rest_api\calculations\Datetime' => array(
819 
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
820 
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
821 
+			),
822 
+			'EventEspresso\core\libraries\rest_api\calculations\Event' => array(
823 
+				'EEM_Event' => EE_Dependency_Map::load_from_cache,
824 
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
825 
+			),
826 
+			'EventEspresso\core\libraries\rest_api\calculations\Registration' => array(
827 
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
828 
+			),
829 
+			'EventEspresso\core\services\session\SessionStartHandler' => array(
830 
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
831 
+			),
832 
+			'EE_URL_Validation_Strategy' => array(
833 
+				null,
834 
+				null,
835 
+				'EventEspresso\core\services\validators\URLValidator' => EE_Dependency_Map::load_from_cache
836 
+			),
837 
+			'EventEspresso\admin_pages\general_settings\OrganizationSettings' => array(
838 
+				'EE_Registry'                                             => EE_Dependency_Map::load_from_cache,
839 
+				'EE_Organization_Config'                                  => EE_Dependency_Map::load_from_cache,
840 
+				'EE_Core_Config'                                          => EE_Dependency_Map::load_from_cache,
841 
+				'EE_Network_Core_Config'                                  => EE_Dependency_Map::load_from_cache,
842 
+				'EventEspresso\core\services\address\CountrySubRegionDao' => EE_Dependency_Map::load_from_cache,
843 
+			),
844 
+			'EventEspresso\core\services\address\CountrySubRegionDao' => array(
845 
+				'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
846 
+				'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache
847 
+			),
848 
+			'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat' => array(
849 
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
850 
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
851 
+			),
852 
+			'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat' => array(
853 
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
854 
+				'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
855 
+			),
856 
+		);
857 
+	}
858 
+
859 
+
860 
+	/**
861 
+	 * Registers how core classes are loaded.
862 
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
863 
+	 *        'EE_Request_Handler' => 'load_core'
864 
+	 *        'EE_Messages_Queue'  => 'load_lib'
865 
+	 *        'EEH_Debug_Tools'    => 'load_helper'
866 
+	 * or, if greater control is required, by providing a custom closure. For example:
867 
+	 *        'Some_Class' => function () {
868 
+	 *            return new Some_Class();
869 
+	 *        },
870 
+	 * This is required for instantiating dependencies
871 
+	 * where an interface has been type hinted in a class constructor. For example:
872 
+	 *        'Required_Interface' => function () {
873 
+	 *            return new A_Class_That_Implements_Required_Interface();
874 
+	 *        },
875 
+	 */
876 
+	protected function _register_core_class_loaders()
877 
+	{
878 
+		$this->_class_loaders = array(
879 
+			// load_core
880 
+			'EE_Dependency_Map'                            => function () {
881 
+				return $this;
882 
+			},
883 
+			'EE_Capabilities'                              => 'load_core',
884 
+			'EE_Encryption'                                => 'load_core',
885 
+			'EE_Front_Controller'                          => 'load_core',
886 
+			'EE_Module_Request_Router'                     => 'load_core',
887 
+			'EE_Registry'                                  => 'load_core',
888 
+			'EE_Request'                                   => function () {
889 
+				return $this->legacy_request;
890 
+			},
891 
+			'EventEspresso\core\services\request\Request'  => function () {
892 
+				return $this->request;
893 
+			},
894 
+			'EventEspresso\core\services\request\Response' => function () {
895 
+				return $this->response;
896 
+			},
897 
+			'EE_Base'                                      => 'load_core',
898 
+			'EE_Request_Handler'                           => 'load_core',
899 
+			'EE_Session'                                   => 'load_core',
900 
+			'EE_Cron_Tasks'                                => 'load_core',
901 
+			'EE_System'                                    => 'load_core',
902 
+			'EE_Maintenance_Mode'                          => 'load_core',
903 
+			'EE_Register_CPTs'                             => 'load_core',
904 
+			'EE_Admin'                                     => 'load_core',
905 
+			'EE_CPT_Strategy'                              => 'load_core',
906 
+			// load_lib
907 
+			'EE_Message_Resource_Manager'                  => 'load_lib',
908 
+			'EE_Message_Type_Collection'                   => 'load_lib',
909 
+			'EE_Message_Type_Collection_Loader'            => 'load_lib',
910 
+			'EE_Messenger_Collection'                      => 'load_lib',
911 
+			'EE_Messenger_Collection_Loader'               => 'load_lib',
912 
+			'EE_Messages_Processor'                        => 'load_lib',
913 
+			'EE_Message_Repository'                        => 'load_lib',
914 
+			'EE_Messages_Queue'                            => 'load_lib',
915 
+			'EE_Messages_Data_Handler_Collection'          => 'load_lib',
916 
+			'EE_Message_Template_Group_Collection'         => 'load_lib',
917 
+			'EE_Payment_Method_Manager'                    => 'load_lib',
918 
+			'EE_Messages_Generator'                        => function () {
919 
+				return EE_Registry::instance()->load_lib(
920 
+					'Messages_Generator',
921 
+					array(),
922 
+					false,
923 
+					false
924 
+				);
925 
+			},
926 
+			'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
927 
+				return EE_Registry::instance()->load_lib(
928 
+					'Messages_Template_Defaults',
929 
+					$arguments,
930 
+					false,
931 
+					false
932 
+				);
933 
+			},
934 
+			// load_helper
935 
+			'EEH_Parse_Shortcodes'                         => function () {
936 
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
937 
+					return new EEH_Parse_Shortcodes();
938 
+				}
939 
+				return null;
940 
+			},
941 
+			'EE_Template_Config'                           => function () {
942 
+				return EE_Config::instance()->template_settings;
943 
+			},
944 
+			'EE_Currency_Config'                           => function () {
945 
+				return EE_Config::instance()->currency;
946 
+			},
947 
+			'EE_Registration_Config'                       => function () {
948 
+				return EE_Config::instance()->registration;
949 
+			},
950 
+			'EE_Core_Config'                               => function () {
951 
+				return EE_Config::instance()->core;
952 
+			},
953 
+			'EventEspresso\core\services\loaders\Loader'   => function () {
954 
+				return LoaderFactory::getLoader();
955 
+			},
956 
+			'EE_Network_Config'                            => function () {
957 
+				return EE_Network_Config::instance();
958 
+			},
959 
+			'EE_Config'                                    => function () {
960 
+				return EE_Config::instance();
961 
+			},
962 
+			'EventEspresso\core\domain\Domain'             => function () {
963 
+				return DomainFactory::getEventEspressoCoreDomain();
964 
+			},
965 
+			'EE_Admin_Config'                              => function () {
966 
+				return EE_Config::instance()->admin;
967 
+			},
968 
+			'EE_Organization_Config'                       => function () {
969 
+				return EE_Config::instance()->organization;
970 
+			},
971 
+			'EE_Network_Core_Config'                       => function () {
972 
+				return EE_Network_Config::instance()->core;
973 
+			},
974 
+			'EE_Environment_Config'                        => function () {
975 
+				return EE_Config::instance()->environment;
976 
+			},
977 
+		);
978 
+	}
979 
+
980 
+
981 
+	/**
982 
+	 * can be used for supplying alternate names for classes,
983 
+	 * or for connecting interface names to instantiable classes
984 
+	 */
985 
+	protected function _register_core_aliases()
986 
+	{
987 
+		$aliases = array(
988 
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
989 
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
990 
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
991 
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
992 
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
993 
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
994 
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
995 
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
996 
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
997 
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
998 
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
999 
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
1000 
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
1001 
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
1002 
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
1003 
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
1004 
+			'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
1005 
+			'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
1006 
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
1007 
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
1008 
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
1009 
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
1010 
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
1011 
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
1012 
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
1013 
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
1014 
+			'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
1015 
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
1016 
+			'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
1017 
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
1018 
+			'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
1019 
+			'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
1020 
+			'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
1021 
+			'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
1022 
+			'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
1023 
+			'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
1024 
+			'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
1025 
+		);
1026 
+		foreach ($aliases as $alias => $fqn) {
1027 
+			if (is_array($fqn)) {
1028 
+				foreach ($fqn as $class => $for_class) {
1029 
+					$this->class_cache->addAlias($class, $alias, $for_class);
1030 
+				}
1031 
+				continue;
1032 
+			}
1033 
+			$this->class_cache->addAlias($fqn, $alias);
1034 
+		}
1035 
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
1036 
+			$this->class_cache->addAlias(
1037 
+				'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
1038 
+				'EventEspresso\core\services\notices\NoticeConverterInterface'
1039 
+			);
1040 
+		}
1041 
+	}
1042 
+
1043 
+
1044 
+	/**
1045 
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
1046 
+	 * request Primarily used by unit tests.
1047 
+	 */
1048 
+	public function reset()
1049 
+	{
1050 
+		$this->_register_core_class_loaders();
1051 
+		$this->_register_core_dependencies();
1052 
+	}
1053 
+
1054 
+
1055 
+	/**
1056 
+	 * PLZ NOTE: a better name for this method would be is_alias()
1057 
+	 * because it returns TRUE if the provided fully qualified name IS an alias
1058 
+	 * WHY?
1059 
+	 * Because if a class is type hinting for a concretion,
1060 
+	 * then why would we need to find another class to supply it?
1061 
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
1062 
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
1063 
+	 * Don't go looking for some substitute.
1064 
+	 * Whereas if a class is type hinting for an interface...
1065 
+	 * then we need to find an actual class to use.
1066 
+	 * So the interface IS the alias for some other FQN,
1067 
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
1068 
+	 * represents some other class.
1069 
+	 *
1070 
+	 * @deprecated 4.9.62.p
1071 
+	 * @param string $fqn
1072 
+	 * @param string $for_class
1073 
+	 * @return bool
1074 
+	 */
1075 
+	public function has_alias($fqn = '', $for_class = '')
1076 
+	{
1077 
+		return $this->isAlias($fqn, $for_class);
1078 
+	}
1079 
+
1080 
+
1081 
+	/**
1082 
+	 * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
1083 
+	 * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
1084 
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
1085 
+	 *  for example:
1086 
+	 *      if the following two entries were added to the _aliases array:
1087 
+	 *          array(
1088 
+	 *              'interface_alias'           => 'some\namespace\interface'
1089 
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
1090 
+	 *          )
1091 
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
1092 
+	 *      to load an instance of 'some\namespace\classname'
1093 
+	 *
1094 
+	 * @deprecated 4.9.62.p
1095 
+	 * @param string $alias
1096 
+	 * @param string $for_class
1097 
+	 * @return string
1098 
+	 */
1099 
+	public function get_alias($alias = '', $for_class = '')
1100 
+	{
1101 
+		return $this->getFqnForAlias($alias, $for_class);
1102 
+	}
1103 1103 
 }
Please login to merge, or discard this patch.
Spacing   +37 added lines, -37 removed lines patch added patch discarded remove patch 
@@ -122,7 +122,7 @@  discard block
 
 block discarded – undo
122 122 
     public static function instance(ClassInterfaceCache $class_cache = null)
123 123 
     {
124 124 
         // check if class object is instantiated, and instantiated properly
125 
-        if (! self::$_instance instanceof EE_Dependency_Map
125 
+        if ( ! self::$_instance instanceof EE_Dependency_Map
126 126 
             && $class_cache instanceof ClassInterfaceCache
127 127 
         ) {
128 128 
             self::$_instance = new EE_Dependency_Map($class_cache);
 
@@ -203,18 +203,18 @@  discard block
 
 block discarded – undo
203 203 
     ) {
204 204 
         $class = trim($class, '\\');
205 205 
         $registered = false;
206 
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
207 
-            self::$_instance->_dependency_map[ $class ] = array();
206 
+        if (empty(self::$_instance->_dependency_map[$class])) {
207 
+            self::$_instance->_dependency_map[$class] = array();
208 208 
         }
209 209 
         // we need to make sure that any aliases used when registering a dependency
210 210 
         // get resolved to the correct class name
211 211 
         foreach ($dependencies as $dependency => $load_source) {
212 212 
             $alias = self::$_instance->getFqnForAlias($dependency);
213 213 
             if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
214 
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
214 
+                || ! isset(self::$_instance->_dependency_map[$class][$alias])
215 215 
             ) {
216 
-                unset($dependencies[ $dependency ]);
217 
-                $dependencies[ $alias ] = $load_source;
216 
+                unset($dependencies[$dependency]);
217 
+                $dependencies[$alias] = $load_source;
218 218 
                 $registered = true;
219 219 
             }
220 220 
         }
 
@@ -224,13 +224,13 @@  discard block
 
 block discarded – undo
224 224 
         // ie: with A = B + C, entries in B take precedence over duplicate entries in C
225 225 
         // Union is way faster than array_merge() but should be used with caution...
226 226 
         // especially with numerically indexed arrays
227 
-        $dependencies += self::$_instance->_dependency_map[ $class ];
227 
+        $dependencies += self::$_instance->_dependency_map[$class];
228 228 
         // now we need to ensure that the resulting dependencies
229 229 
         // array only has the entries that are required for the class
230 230 
         // so first count how many dependencies were originally registered for the class
231 
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
231 
+        $dependency_count = count(self::$_instance->_dependency_map[$class]);
232 232 
         // if that count is non-zero (meaning dependencies were already registered)
233 
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
233 
+        self::$_instance->_dependency_map[$class] = $dependency_count
234 234 
             // then truncate the  final array to match that count
235 235 
             ? array_slice($dependencies, 0, $dependency_count)
236 236 
             // otherwise just take the incoming array because nothing previously existed
 
@@ -247,13 +247,13 @@  discard block
 
 block discarded – undo
247 247 
      */
248 248 
     public static function register_class_loader($class_name, $loader = 'load_core')
249 249 
     {
250 
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
250 
+        if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
251 251 
             throw new DomainException(
252 252 
                 esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
253 253 
             );
254 254 
         }
255 255 
         // check that loader is callable or method starts with "load_" and exists in EE_Registry
256 
-        if (! is_callable($loader)
256 
+        if ( ! is_callable($loader)
257 257 
             && (
258 258 
                 strpos($loader, 'load_') !== 0
259 259 
                 || ! method_exists('EE_Registry', $loader)
 
@@ -270,8 +270,8 @@  discard block
 
 block discarded – undo
270 270 
             );
271 271 
         }
272 272 
         $class_name = self::$_instance->getFqnForAlias($class_name);
273 
-        if (! isset(self::$_instance->_class_loaders[ $class_name ])) {
274 
-            self::$_instance->_class_loaders[ $class_name ] = $loader;
273 
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
274 
+            self::$_instance->_class_loaders[$class_name] = $loader;
275 275 
             return true;
276 276 
         }
277 277 
         return false;
 
@@ -299,7 +299,7 @@  discard block
 
 block discarded – undo
299 299 
         if (strpos($class_name, 'EEM_') === 0) {
300 300 
             $class_name = 'LEGACY_MODELS';
301 301 
         }
302 
-        return isset($this->_dependency_map[ $class_name ]) ? true : false;
302 
+        return isset($this->_dependency_map[$class_name]) ? true : false;
303 303 
     }
304 304
305 305 
 
@@ -317,7 +317,7 @@  discard block
 
 block discarded – undo
317 317 
             $class_name = 'LEGACY_MODELS';
318 318 
         }
319 319 
         $dependency = $this->getFqnForAlias($dependency, $class_name);
320 
-        return isset($this->_dependency_map[ $class_name ][ $dependency ])
320 
+        return isset($this->_dependency_map[$class_name][$dependency])
321 321 
             ? true
322 322 
             : false;
323 323 
     }
 
@@ -338,7 +338,7 @@  discard block
 
 block discarded – undo
338 338 
         }
339 339 
         $dependency = $this->getFqnForAlias($dependency);
340 340 
         return $this->has_dependency_for_class($class_name, $dependency)
341 
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
341 
+            ? $this->_dependency_map[$class_name][$dependency]
342 342 
             : EE_Dependency_Map::not_registered;
343 343 
     }
344 344 
 
@@ -361,7 +361,7 @@  discard block
 
 block discarded – undo
361 361 
             return 'load_core';
362 362 
         }
363 363 
         $class_name = $this->getFqnForAlias($class_name);
364 
-        return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : '';
364 
+        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
365 365 
     }
366 366
367 367 
 
@@ -877,7 +877,7 @@  discard block
 
 block discarded – undo
877 877 
     {
878 878 
         $this->_class_loaders = array(
879 879 
             // load_core
880 
-            'EE_Dependency_Map'                            => function () {
880 
+            'EE_Dependency_Map'                            => function() {
881 881 
                 return $this;
882 882 
             },
883 883 
             'EE_Capabilities'                              => 'load_core',
 
@@ -885,13 +885,13 @@  discard block
 
 block discarded – undo
885 885 
             'EE_Front_Controller'                          => 'load_core',
886 886 
             'EE_Module_Request_Router'                     => 'load_core',
887 887 
             'EE_Registry'                                  => 'load_core',
888 
-            'EE_Request'                                   => function () {
888 
+            'EE_Request'                                   => function() {
889 889 
                 return $this->legacy_request;
890 890 
             },
891 
-            'EventEspresso\core\services\request\Request'  => function () {
891 
+            'EventEspresso\core\services\request\Request'  => function() {
892 892 
                 return $this->request;
893 893 
             },
894 
-            'EventEspresso\core\services\request\Response' => function () {
894 
+            'EventEspresso\core\services\request\Response' => function() {
895 895 
                 return $this->response;
896 896 
             },
897 897 
             'EE_Base'                                      => 'load_core',
 
@@ -915,7 +915,7 @@  discard block
 
 block discarded – undo
915 915 
             'EE_Messages_Data_Handler_Collection'          => 'load_lib',
916 916 
             'EE_Message_Template_Group_Collection'         => 'load_lib',
917 917 
             'EE_Payment_Method_Manager'                    => 'load_lib',
918 
-            'EE_Messages_Generator'                        => function () {
918 
+            'EE_Messages_Generator'                        => function() {
919 919 
                 return EE_Registry::instance()->load_lib(
920 920 
                     'Messages_Generator',
921 921 
                     array(),
 
@@ -923,7 +923,7 @@  discard block
 
 block discarded – undo
923 923 
                     false
924 924 
                 );
925 925 
             },
926 
-            'EE_Messages_Template_Defaults'                => function ($arguments = array()) {
926 
+            'EE_Messages_Template_Defaults'                => function($arguments = array()) {
927 927 
                 return EE_Registry::instance()->load_lib(
928 928 
                     'Messages_Template_Defaults',
929 929 
                     $arguments,
 
@@ -932,46 +932,46 @@  discard block
 
 block discarded – undo
932 932 
                 );
933 933 
             },
934 934 
             // load_helper
935 
-            'EEH_Parse_Shortcodes'                         => function () {
935 
+            'EEH_Parse_Shortcodes'                         => function() {
936 936 
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
937 937 
                     return new EEH_Parse_Shortcodes();
938 938 
                 }
939 939 
                 return null;
940 940 
             },
941 
-            'EE_Template_Config'                           => function () {
941 
+            'EE_Template_Config'                           => function() {
942 942 
                 return EE_Config::instance()->template_settings;
943 943 
             },
944 
-            'EE_Currency_Config'                           => function () {
944 
+            'EE_Currency_Config'                           => function() {
945 945 
                 return EE_Config::instance()->currency;
946 946 
             },
947 
-            'EE_Registration_Config'                       => function () {
947 
+            'EE_Registration_Config'                       => function() {
948 948 
                 return EE_Config::instance()->registration;
949 949 
             },
950 
-            'EE_Core_Config'                               => function () {
950 
+            'EE_Core_Config'                               => function() {
951 951 
                 return EE_Config::instance()->core;
952 952 
             },
953 
-            'EventEspresso\core\services\loaders\Loader'   => function () {
953 
+            'EventEspresso\core\services\loaders\Loader'   => function() {
954 954 
                 return LoaderFactory::getLoader();
955 955 
             },
956 
-            'EE_Network_Config'                            => function () {
956 
+            'EE_Network_Config'                            => function() {
957 957 
                 return EE_Network_Config::instance();
958 958 
             },
959 
-            'EE_Config'                                    => function () {
959 
+            'EE_Config'                                    => function() {
960 960 
                 return EE_Config::instance();
961 961 
             },
962 
-            'EventEspresso\core\domain\Domain'             => function () {
962 
+            'EventEspresso\core\domain\Domain'             => function() {
963 963 
                 return DomainFactory::getEventEspressoCoreDomain();
964 964 
             },
965 
-            'EE_Admin_Config'                              => function () {
965 
+            'EE_Admin_Config'                              => function() {
966 966 
                 return EE_Config::instance()->admin;
967 967 
             },
968 
-            'EE_Organization_Config'                       => function () {
968 
+            'EE_Organization_Config'                       => function() {
969 969 
                 return EE_Config::instance()->organization;
970 970 
             },
971 
-            'EE_Network_Core_Config'                       => function () {
971 
+            'EE_Network_Core_Config'                       => function() {
972 972 
                 return EE_Network_Config::instance()->core;
973 973 
             },
974 
-            'EE_Environment_Config'                        => function () {
974 
+            'EE_Environment_Config'                        => function() {
975 975 
                 return EE_Config::instance()->environment;
976 976 
             },
977 977 
         );
 
@@ -1032,7 +1032,7 @@  discard block
 
 block discarded – undo
1032 1032 
             }
1033 1033 
             $this->class_cache->addAlias($fqn, $alias);
1034 1034 
         }
1035 
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
1035 
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
1036 1036 
             $this->class_cache->addAlias(
1037 1037 
                 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
1038 1038 
                 'EventEspresso\core\services\notices\NoticeConverterInterface'
Please login to merge, or discard this patch.
core/EE_Config.core.php 2 patches
Indentation   +3145 added lines, -3145 removed lines patch added patch discarded remove patch 
@@ -14,2509 +14,2509 @@  discard block
 
 block discarded – undo
14 14 
 final class EE_Config implements ResettableInterface
15 15 
 {
16 16
17 
-    const OPTION_NAME = 'ee_config';
18 
-
19 
-    const LOG_NAME = 'ee_config_log';
20 
-
21 
-    const LOG_LENGTH = 100;
22 
-
23 
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
24 
-
25 
-    /**
26 
-     *    instance of the EE_Config object
27 
-     *
28 
-     * @var    EE_Config $_instance
29 
-     * @access    private
30 
-     */
31 
-    private static $_instance;
32 
-
33 
-    /**
34 
-     * @var boolean $_logging_enabled
35 
-     */
36 
-    private static $_logging_enabled = false;
37 
-
38 
-    /**
39 
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
40 
-     */
41 
-    private $legacy_shortcodes_manager;
42 
-
43 
-    /**
44 
-     * An StdClass whose property names are addon slugs,
45 
-     * and values are their config classes
46 
-     *
47 
-     * @var StdClass
48 
-     */
49 
-    public $addons;
50 
-
51 
-    /**
52 
-     * @var EE_Admin_Config
53 
-     */
54 
-    public $admin;
55 
-
56 
-    /**
57 
-     * @var EE_Core_Config
58 
-     */
59 
-    public $core;
60 
-
61 
-    /**
62 
-     * @var EE_Currency_Config
63 
-     */
64 
-    public $currency;
65 
-
66 
-    /**
67 
-     * @var EE_Organization_Config
68 
-     */
69 
-    public $organization;
70 
-
71 
-    /**
72 
-     * @var EE_Registration_Config
73 
-     */
74 
-    public $registration;
75 
-
76 
-    /**
77 
-     * @var EE_Template_Config
78 
-     */
79 
-    public $template_settings;
80 
-
81 
-    /**
82 
-     * Holds EE environment values.
83 
-     *
84 
-     * @var EE_Environment_Config
85 
-     */
86 
-    public $environment;
87 
-
88 
-    /**
89 
-     * settings pertaining to Google maps
90 
-     *
91 
-     * @var EE_Map_Config
92 
-     */
93 
-    public $map_settings;
94 
-
95 
-    /**
96 
-     * settings pertaining to Taxes
97 
-     *
98 
-     * @var EE_Tax_Config
99 
-     */
100 
-    public $tax_settings;
101 
-
102 
-    /**
103 
-     * Settings pertaining to global messages settings.
104 
-     *
105 
-     * @var EE_Messages_Config
106 
-     */
107 
-    public $messages;
108 
-
109 
-    /**
110 
-     * @deprecated
111 
-     * @var EE_Gateway_Config
112 
-     */
113 
-    public $gateway;
114 
-
115 
-    /**
116 
-     * @var    array $_addon_option_names
117 
-     * @access    private
118 
-     */
119 
-    private $_addon_option_names = array();
120 
-
121 
-    /**
122 
-     * @var    array $_module_route_map
123 
-     * @access    private
124 
-     */
125 
-    private static $_module_route_map = array();
126 
-
127 
-    /**
128 
-     * @var    array $_module_forward_map
129 
-     * @access    private
130 
-     */
131 
-    private static $_module_forward_map = array();
132 
-
133 
-    /**
134 
-     * @var    array $_module_view_map
135 
-     * @access    private
136 
-     */
137 
-    private static $_module_view_map = array();
138 
-
139 
-
140 
-    /**
141 
-     * @singleton method used to instantiate class object
142 
-     * @access    public
143 
-     * @return EE_Config instance
144 
-     */
145 
-    public static function instance()
146 
-    {
147 
-        // check if class object is instantiated, and instantiated properly
148 
-        if (! self::$_instance instanceof EE_Config) {
149 
-            self::$_instance = new self();
150 
-        }
151 
-        return self::$_instance;
152 
-    }
153 
-
154 
-
155 
-    /**
156 
-     * Resets the config
157 
-     *
158 
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
159 
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
160 
-     *                               reflect its state in the database
161 
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
162 
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
163 
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
164 
-     *                               site was put into maintenance mode)
165 
-     * @return EE_Config
166 
-     */
167 
-    public static function reset($hard_reset = false, $reinstantiate = true)
168 
-    {
169 
-        if (self::$_instance instanceof EE_Config) {
170 
-            if ($hard_reset) {
171 
-                self::$_instance->legacy_shortcodes_manager = null;
172 
-                self::$_instance->_addon_option_names = array();
173 
-                self::$_instance->_initialize_config();
174 
-                self::$_instance->update_espresso_config();
175 
-            }
176 
-            self::$_instance->update_addon_option_names();
177 
-        }
178 
-        self::$_instance = null;
179 
-        // we don't need to reset the static properties imo because those should
180 
-        // only change when a module is added or removed. Currently we don't
181 
-        // support removing a module during a request when it previously existed
182 
-        if ($reinstantiate) {
183 
-            return self::instance();
184 
-        } else {
185 
-            return null;
186 
-        }
187 
-    }
188 
-
189 
-
190 
-    /**
191 
-     *    class constructor
192 
-     *
193 
-     * @access    private
194 
-     */
195 
-    private function __construct()
196 
-    {
197 
-        do_action('AHEE__EE_Config__construct__begin', $this);
198 
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
199 
-        // setup empty config classes
200 
-        $this->_initialize_config();
201 
-        // load existing EE site settings
202 
-        $this->_load_core_config();
203 
-        // confirm everything loaded correctly and set filtered defaults if not
204 
-        $this->_verify_config();
205 
-        //  register shortcodes and modules
206 
-        add_action(
207 
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
208 
-            array($this, 'register_shortcodes_and_modules'),
209 
-            999
210 
-        );
211 
-        //  initialize shortcodes and modules
212 
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
213 
-        // register widgets
214 
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
215 
-        // shutdown
216 
-        add_action('shutdown', array($this, 'shutdown'), 10);
217 
-        // construct__end hook
218 
-        do_action('AHEE__EE_Config__construct__end', $this);
219 
-        // hardcoded hack
220 
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
221 
-    }
222 
-
223 
-
224 
-    /**
225 
-     * @return boolean
226 
-     */
227 
-    public static function logging_enabled()
228 
-    {
229 
-        return self::$_logging_enabled;
230 
-    }
231 
-
232 
-
233 
-    /**
234 
-     * use to get the current theme if needed from static context
235 
-     *
236 
-     * @return string current theme set.
237 
-     */
238 
-    public static function get_current_theme()
239 
-    {
240 
-        return isset(self::$_instance->template_settings->current_espresso_theme)
241 
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
242 
-    }
243 
-
244 
-
245 
-    /**
246 
-     *        _initialize_config
247 
-     *
248 
-     * @access private
249 
-     * @return void
250 
-     */
251 
-    private function _initialize_config()
252 
-    {
253 
-        EE_Config::trim_log();
254 
-        // set defaults
255 
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
256 
-        $this->addons = new stdClass();
257 
-        // set _module_route_map
258 
-        EE_Config::$_module_route_map = array();
259 
-        // set _module_forward_map
260 
-        EE_Config::$_module_forward_map = array();
261 
-        // set _module_view_map
262 
-        EE_Config::$_module_view_map = array();
263 
-    }
264 
-
265 
-
266 
-    /**
267 
-     *        load core plugin configuration
268 
-     *
269 
-     * @access private
270 
-     * @return void
271 
-     */
272 
-    private function _load_core_config()
273 
-    {
274 
-        // load_core_config__start hook
275 
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
276 
-        $espresso_config = $this->get_espresso_config();
277 
-        foreach ($espresso_config as $config => $settings) {
278 
-            // load_core_config__start hook
279 
-            $settings = apply_filters(
280 
-                'FHEE__EE_Config___load_core_config__config_settings',
281 
-                $settings,
282 
-                $config,
283 
-                $this
284 
-            );
285 
-            if (is_object($settings) && property_exists($this, $config)) {
286 
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
287 
-                // call configs populate method to ensure any defaults are set for empty values.
288 
-                if (method_exists($settings, 'populate')) {
289 
-                    $this->{$config}->populate();
290 
-                }
291 
-                if (method_exists($settings, 'do_hooks')) {
292 
-                    $this->{$config}->do_hooks();
293 
-                }
294 
-            }
295 
-        }
296 
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
297 
-            $this->update_espresso_config();
298 
-        }
299 
-        // load_core_config__end hook
300 
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
301 
-    }
302 
-
303 
-
304 
-    /**
305 
-     *    _verify_config
306 
-     *
307 
-     * @access    protected
308 
-     * @return    void
309 
-     */
310 
-    protected function _verify_config()
311 
-    {
312 
-        $this->core = $this->core instanceof EE_Core_Config
313 
-            ? $this->core
314 
-            : new EE_Core_Config();
315 
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
316 
-        $this->organization = $this->organization instanceof EE_Organization_Config
317 
-            ? $this->organization
318 
-            : new EE_Organization_Config();
319 
-        $this->organization = apply_filters(
320 
-            'FHEE__EE_Config___initialize_config__organization',
321 
-            $this->organization
322 
-        );
323 
-        $this->currency = $this->currency instanceof EE_Currency_Config
324 
-            ? $this->currency
325 
-            : new EE_Currency_Config();
326 
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
327 
-        $this->registration = $this->registration instanceof EE_Registration_Config
328 
-            ? $this->registration
329 
-            : new EE_Registration_Config();
330 
-        $this->registration = apply_filters(
331 
-            'FHEE__EE_Config___initialize_config__registration',
332 
-            $this->registration
333 
-        );
334 
-        $this->admin = $this->admin instanceof EE_Admin_Config
335 
-            ? $this->admin
336 
-            : new EE_Admin_Config();
337 
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
338 
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
339 
-            ? $this->template_settings
340 
-            : new EE_Template_Config();
341 
-        $this->template_settings = apply_filters(
342 
-            'FHEE__EE_Config___initialize_config__template_settings',
343 
-            $this->template_settings
344 
-        );
345 
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
346 
-            ? $this->map_settings
347 
-            : new EE_Map_Config();
348 
-        $this->map_settings = apply_filters(
349 
-            'FHEE__EE_Config___initialize_config__map_settings',
350 
-            $this->map_settings
351 
-        );
352 
-        $this->environment = $this->environment instanceof EE_Environment_Config
353 
-            ? $this->environment
354 
-            : new EE_Environment_Config();
355 
-        $this->environment = apply_filters(
356 
-            'FHEE__EE_Config___initialize_config__environment',
357 
-            $this->environment
358 
-        );
359 
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
360 
-            ? $this->tax_settings
361 
-            : new EE_Tax_Config();
362 
-        $this->tax_settings = apply_filters(
363 
-            'FHEE__EE_Config___initialize_config__tax_settings',
364 
-            $this->tax_settings
365 
-        );
366 
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
367 
-        $this->messages = $this->messages instanceof EE_Messages_Config
368 
-            ? $this->messages
369 
-            : new EE_Messages_Config();
370 
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
371 
-            ? $this->gateway
372 
-            : new EE_Gateway_Config();
373 
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
374 
-        $this->legacy_shortcodes_manager = null;
375 
-    }
376 
-
377 
-
378 
-    /**
379 
-     *    get_espresso_config
380 
-     *
381 
-     * @access    public
382 
-     * @return    array of espresso config stuff
383 
-     */
384 
-    public function get_espresso_config()
385 
-    {
386 
-        // grab espresso configuration
387 
-        return apply_filters(
388 
-            'FHEE__EE_Config__get_espresso_config__CFG',
389 
-            get_option(EE_Config::OPTION_NAME, array())
390 
-        );
391 
-    }
392 
-
393 
-
394 
-    /**
395 
-     *    double_check_config_comparison
396 
-     *
397 
-     * @access    public
398 
-     * @param string $option
399 
-     * @param        $old_value
400 
-     * @param        $value
401 
-     */
402 
-    public function double_check_config_comparison($option = '', $old_value, $value)
403 
-    {
404 
-        // make sure we're checking the ee config
405 
-        if ($option === EE_Config::OPTION_NAME) {
406 
-            // run a loose comparison of the old value against the new value for type and properties,
407 
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
408 
-            if ($value != $old_value) {
409 
-                // if they are NOT the same, then remove the hook,
410 
-                // which means the subsequent update results will be based solely on the update query results
411 
-                // the reason we do this is because, as stated above,
412 
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
413 
-                // this happens PRIOR to serialization and any subsequent update.
414 
-                // If values are found to match their previous old value,
415 
-                // then WP bails before performing any update.
416 
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
417 
-                // it just pulled from the db, with the one being passed to it (which will not match).
418 
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
419 
-                // MySQL MAY ALSO NOT perform the update because
420 
-                // the string it sees in the db looks the same as the new one it has been passed!!!
421 
-                // This results in the query returning an "affected rows" value of ZERO,
422 
-                // which gets returned immediately by WP update_option and looks like an error.
423 
-                remove_action('update_option', array($this, 'check_config_updated'));
424 
-            }
425 
-        }
426 
-    }
427 
-
428 
-
429 
-    /**
430 
-     *    update_espresso_config
431 
-     *
432 
-     * @access   public
433 
-     */
434 
-    protected function _reset_espresso_addon_config()
435 
-    {
436 
-        $this->_addon_option_names = array();
437 
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
438 
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
439 
-            if ($addon_config_obj instanceof EE_Config_Base) {
440 
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
441 
-            }
442 
-            $this->addons->{$addon_name} = null;
443 
-        }
444 
-    }
445 
-
446 
-
447 
-    /**
448 
-     *    update_espresso_config
449 
-     *
450 
-     * @access   public
451 
-     * @param   bool $add_success
452 
-     * @param   bool $add_error
453 
-     * @return   bool
454 
-     */
455 
-    public function update_espresso_config($add_success = false, $add_error = true)
456 
-    {
457 
-        // don't allow config updates during WP heartbeats
458 
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
459 
-            return false;
460 
-        }
461 
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
462 
-        // $clone = clone( self::$_instance );
463 
-        // self::$_instance = NULL;
464 
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
465 
-        $this->_reset_espresso_addon_config();
466 
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
467 
-        // but BEFORE the actual update occurs
468 
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
469 
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
470 
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
471 
-        $this->legacy_shortcodes_manager = null;
472 
-        // now update "ee_config"
473 
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
474 
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
475 
-        EE_Config::log(EE_Config::OPTION_NAME);
476 
-        // if not saved... check if the hook we just added still exists;
477 
-        // if it does, it means one of two things:
478 
-        // that update_option bailed at the($value === $old_value) conditional,
479 
-        // or...
480 
-        // the db update query returned 0 rows affected
481 
-        // (probably because the data  value was the same from it's perspective)
482 
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
483 
-        // but just means no update occurred, so don't display an error to the user.
484 
-        // BUT... if update_option returns FALSE, AND the hook is missing,
485 
-        // then it means that something truly went wrong
486 
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
487 
-        // remove our action since we don't want it in the system anymore
488 
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
489 
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
490 
-        // self::$_instance = $clone;
491 
-        // unset( $clone );
492 
-        // if config remains the same or was updated successfully
493 
-        if ($saved) {
494 
-            if ($add_success) {
495 
-                EE_Error::add_success(
496 
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
497 
-                    __FILE__,
498 
-                    __FUNCTION__,
499 
-                    __LINE__
500 
-                );
501 
-            }
502 
-            return true;
503 
-        } else {
504 
-            if ($add_error) {
505 
-                EE_Error::add_error(
506 
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
507 
-                    __FILE__,
508 
-                    __FUNCTION__,
509 
-                    __LINE__
510 
-                );
511 
-            }
512 
-            return false;
513 
-        }
514 
-    }
515 
-
516 
-
517 
-    /**
518 
-     *    _verify_config_params
519 
-     *
520 
-     * @access    private
521 
-     * @param    string         $section
522 
-     * @param    string         $name
523 
-     * @param    string         $config_class
524 
-     * @param    EE_Config_Base $config_obj
525 
-     * @param    array          $tests_to_run
526 
-     * @param    bool           $display_errors
527 
-     * @return    bool    TRUE on success, FALSE on fail
528 
-     */
529 
-    private function _verify_config_params(
530 
-        $section = '',
531 
-        $name = '',
532 
-        $config_class = '',
533 
-        $config_obj = null,
534 
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
535 
-        $display_errors = true
536 
-    ) {
537 
-        try {
538 
-            foreach ($tests_to_run as $test) {
539 
-                switch ($test) {
540 
-                    // TEST #1 : check that section was set
541 
-                    case 1:
542 
-                        if (empty($section)) {
543 
-                            if ($display_errors) {
544 
-                                throw new EE_Error(
545 
-                                    sprintf(
546 
-                                        __(
547 
-                                            'No configuration section has been provided while attempting to save "%s".',
548 
-                                            'event_espresso'
549 
-                                        ),
550 
-                                        $config_class
551 
-                                    )
552 
-                                );
553 
-                            }
554 
-                            return false;
555 
-                        }
556 
-                        break;
557 
-                    // TEST #2 : check that settings section exists
558 
-                    case 2:
559 
-                        if (! isset($this->{$section})) {
560 
-                            if ($display_errors) {
561 
-                                throw new EE_Error(
562 
-                                    sprintf(
563 
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
564 
-                                        $section
565 
-                                    )
566 
-                                );
567 
-                            }
568 
-                            return false;
569 
-                        }
570 
-                        break;
571 
-                    // TEST #3 : check that section is the proper format
572 
-                    case 3:
573 
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
574 
-                        ) {
575 
-                            if ($display_errors) {
576 
-                                throw new EE_Error(
577 
-                                    sprintf(
578 
-                                        __(
579 
-                                            'The "%s" configuration settings have not been formatted correctly.',
580 
-                                            'event_espresso'
581 
-                                        ),
582 
-                                        $section
583 
-                                    )
584 
-                                );
585 
-                            }
586 
-                            return false;
587 
-                        }
588 
-                        break;
589 
-                    // TEST #4 : check that config section name has been set
590 
-                    case 4:
591 
-                        if (empty($name)) {
592 
-                            if ($display_errors) {
593 
-                                throw new EE_Error(
594 
-                                    __(
595 
-                                        'No name has been provided for the specific configuration section.',
596 
-                                        'event_espresso'
597 
-                                    )
598 
-                                );
599 
-                            }
600 
-                            return false;
601 
-                        }
602 
-                        break;
603 
-                    // TEST #5 : check that a config class name has been set
604 
-                    case 5:
605 
-                        if (empty($config_class)) {
606 
-                            if ($display_errors) {
607 
-                                throw new EE_Error(
608 
-                                    __(
609 
-                                        'No class name has been provided for the specific configuration section.',
610 
-                                        'event_espresso'
611 
-                                    )
612 
-                                );
613 
-                            }
614 
-                            return false;
615 
-                        }
616 
-                        break;
617 
-                    // TEST #6 : verify config class is accessible
618 
-                    case 6:
619 
-                        if (! class_exists($config_class)) {
620 
-                            if ($display_errors) {
621 
-                                throw new EE_Error(
622 
-                                    sprintf(
623 
-                                        __(
624 
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
625 
-                                            'event_espresso'
626 
-                                        ),
627 
-                                        $config_class
628 
-                                    )
629 
-                                );
630 
-                            }
631 
-                            return false;
632 
-                        }
633 
-                        break;
634 
-                    // TEST #7 : check that config has even been set
635 
-                    case 7:
636 
-                        if (! isset($this->{$section}->{$name})) {
637 
-                            if ($display_errors) {
638 
-                                throw new EE_Error(
639 
-                                    sprintf(
640 
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
641 
-                                        $section,
642 
-                                        $name
643 
-                                    )
644 
-                                );
645 
-                            }
646 
-                            return false;
647 
-                        } else {
648 
-                            // and make sure it's not serialized
649 
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
650 
-                        }
651 
-                        break;
652 
-                    // TEST #8 : check that config is the requested type
653 
-                    case 8:
654 
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
655 
-                            if ($display_errors) {
656 
-                                throw new EE_Error(
657 
-                                    sprintf(
658 
-                                        __(
659 
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
660 
-                                            'event_espresso'
661 
-                                        ),
662 
-                                        $section,
663 
-                                        $name,
664 
-                                        $config_class
665 
-                                    )
666 
-                                );
667 
-                            }
668 
-                            return false;
669 
-                        }
670 
-                        break;
671 
-                    // TEST #9 : verify config object
672 
-                    case 9:
673 
-                        if (! $config_obj instanceof EE_Config_Base) {
674 
-                            if ($display_errors) {
675 
-                                throw new EE_Error(
676 
-                                    sprintf(
677 
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
678 
-                                        print_r($config_obj, true)
679 
-                                    )
680 
-                                );
681 
-                            }
682 
-                            return false;
683 
-                        }
684 
-                        break;
685 
-                }
686 
-            }
687 
-        } catch (EE_Error $e) {
688 
-            $e->get_error();
689 
-        }
690 
-        // you have successfully run the gauntlet
691 
-        return true;
692 
-    }
693 
-
694 
-
695 
-    /**
696 
-     *    _generate_config_option_name
697 
-     *
698 
-     * @access        protected
699 
-     * @param        string $section
700 
-     * @param        string $name
701 
-     * @return        string
702 
-     */
703 
-    private function _generate_config_option_name($section = '', $name = '')
704 
-    {
705 
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
706 
-    }
707 
-
708 
-
709 
-    /**
710 
-     *    _set_config_class
711 
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
712 
-     *
713 
-     * @access    private
714 
-     * @param    string $config_class
715 
-     * @param    string $name
716 
-     * @return    string
717 
-     */
718 
-    private function _set_config_class($config_class = '', $name = '')
719 
-    {
720 
-        return ! empty($config_class)
721 
-            ? $config_class
722 
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
723 
-    }
724 
-
725 
-
726 
-    /**
727 
-     *    set_config
728 
-     *
729 
-     * @access    protected
730 
-     * @param    string         $section
731 
-     * @param    string         $name
732 
-     * @param    string         $config_class
733 
-     * @param    EE_Config_Base $config_obj
734 
-     * @return    EE_Config_Base
735 
-     */
736 
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
737 
-    {
738 
-        // ensure config class is set to something
739 
-        $config_class = $this->_set_config_class($config_class, $name);
740 
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
741 
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
742 
-            return null;
743 
-        }
744 
-        $config_option_name = $this->_generate_config_option_name($section, $name);
745 
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
746 
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
747 
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
748 
-            $this->update_addon_option_names();
749 
-        }
750 
-        // verify the incoming config object but suppress errors
751 
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
752 
-            $config_obj = new $config_class();
753 
-        }
754 
-        if (get_option($config_option_name)) {
755 
-            EE_Config::log($config_option_name);
756 
-            update_option($config_option_name, $config_obj);
757 
-            $this->{$section}->{$name} = $config_obj;
758 
-            return $this->{$section}->{$name};
759 
-        } else {
760 
-            // create a wp-option for this config
761 
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
762 
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
763 
-                return $this->{$section}->{$name};
764 
-            } else {
765 
-                EE_Error::add_error(
766 
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
767 
-                    __FILE__,
768 
-                    __FUNCTION__,
769 
-                    __LINE__
770 
-                );
771 
-                return null;
772 
-            }
773 
-        }
774 
-    }
775 
-
776 
-
777 
-    /**
778 
-     *    update_config
779 
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
780 
-     *
781 
-     * @access    public
782 
-     * @param    string                $section
783 
-     * @param    string                $name
784 
-     * @param    EE_Config_Base|string $config_obj
785 
-     * @param    bool                  $throw_errors
786 
-     * @return    bool
787 
-     */
788 
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
789 
-    {
790 
-        // don't allow config updates during WP heartbeats
791 
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
792 
-            return false;
793 
-        }
794 
-        $config_obj = maybe_unserialize($config_obj);
795 
-        // get class name of the incoming object
796 
-        $config_class = get_class($config_obj);
797 
-        // run tests 1-5 and 9 to verify config
798 
-        if (! $this->_verify_config_params(
799 
-            $section,
800 
-            $name,
801 
-            $config_class,
802 
-            $config_obj,
803 
-            array(1, 2, 3, 4, 7, 9)
804 
-        )
805 
-        ) {
806 
-            return false;
807 
-        }
808 
-        $config_option_name = $this->_generate_config_option_name($section, $name);
809 
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
810 
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
811 
-            // save new config to db
812 
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
813 
-                return true;
814 
-            }
815 
-        } else {
816 
-            // first check if the record already exists
817 
-            $existing_config = get_option($config_option_name);
818 
-            $config_obj = serialize($config_obj);
819 
-            // just return if db record is already up to date (NOT type safe comparison)
820 
-            if ($existing_config == $config_obj) {
821 
-                $this->{$section}->{$name} = $config_obj;
822 
-                return true;
823 
-            } elseif (update_option($config_option_name, $config_obj)) {
824 
-                EE_Config::log($config_option_name);
825 
-                // update wp-option for this config class
826 
-                $this->{$section}->{$name} = $config_obj;
827 
-                return true;
828 
-            } elseif ($throw_errors) {
829 
-                EE_Error::add_error(
830 
-                    sprintf(
831 
-                        __(
832 
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
833 
-                            'event_espresso'
834 
-                        ),
835 
-                        $config_class,
836 
-                        'EE_Config->' . $section . '->' . $name
837 
-                    ),
838 
-                    __FILE__,
839 
-                    __FUNCTION__,
840 
-                    __LINE__
841 
-                );
842 
-            }
843 
-        }
844 
-        return false;
845 
-    }
846 
-
847 
-
848 
-    /**
849 
-     *    get_config
850 
-     *
851 
-     * @access    public
852 
-     * @param    string $section
853 
-     * @param    string $name
854 
-     * @param    string $config_class
855 
-     * @return    mixed EE_Config_Base | NULL
856 
-     */
857 
-    public function get_config($section = '', $name = '', $config_class = '')
858 
-    {
859 
-        // ensure config class is set to something
860 
-        $config_class = $this->_set_config_class($config_class, $name);
861 
-        // run tests 1-4, 6 and 7 to verify that all params have been set
862 
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
863 
-            return null;
864 
-        }
865 
-        // now test if the requested config object exists, but suppress errors
866 
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
867 
-            // config already exists, so pass it back
868 
-            return $this->{$section}->{$name};
869 
-        }
870 
-        // load config option from db if it exists
871 
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
872 
-        // verify the newly retrieved config object, but suppress errors
873 
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
874 
-            // config is good, so set it and pass it back
875 
-            $this->{$section}->{$name} = $config_obj;
876 
-            return $this->{$section}->{$name};
877 
-        }
878 
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
879 
-        $config_obj = $this->set_config($section, $name, $config_class);
880 
-        // verify the newly created config object
881 
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
882 
-            return $this->{$section}->{$name};
883 
-        } else {
884 
-            EE_Error::add_error(
885 
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
886 
-                __FILE__,
887 
-                __FUNCTION__,
888 
-                __LINE__
889 
-            );
890 
-        }
891 
-        return null;
892 
-    }
893 
-
894 
-
895 
-    /**
896 
-     *    get_config_option
897 
-     *
898 
-     * @access    public
899 
-     * @param    string $config_option_name
900 
-     * @return    mixed EE_Config_Base | FALSE
901 
-     */
902 
-    public function get_config_option($config_option_name = '')
903 
-    {
904 
-        // retrieve the wp-option for this config class.
905 
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
906 
-        if (empty($config_option)) {
907 
-            EE_Config::log($config_option_name . '-NOT-FOUND');
908 
-        }
909 
-        return $config_option;
910 
-    }
911 
-
912 
-
913 
-    /**
914 
-     * log
915 
-     *
916 
-     * @param string $config_option_name
917 
-     */
918 
-    public static function log($config_option_name = '')
919 
-    {
920 
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
921 
-            $config_log = get_option(EE_Config::LOG_NAME, array());
922 
-            // copy incoming $_REQUEST and sanitize it so we can save it
923 
-            $_request = $_REQUEST;
924 
-            array_walk_recursive($_request, 'sanitize_text_field');
925 
-            $config_log[ (string) microtime(true) ] = array(
926 
-                'config_name' => $config_option_name,
927 
-                'request'     => $_request,
928 
-            );
929 
-            update_option(EE_Config::LOG_NAME, $config_log);
930 
-        }
931 
-    }
932 
-
933 
-
934 
-    /**
935 
-     * trim_log
936 
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
937 
-     */
938 
-    public static function trim_log()
939 
-    {
940 
-        if (! EE_Config::logging_enabled()) {
941 
-            return;
942 
-        }
943 
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
944 
-        $log_length = count($config_log);
945 
-        if ($log_length > EE_Config::LOG_LENGTH) {
946 
-            ksort($config_log);
947 
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
948 
-            update_option(EE_Config::LOG_NAME, $config_log);
949 
-        }
950 
-    }
951 
-
952 
-
953 
-    /**
954 
-     *    get_page_for_posts
955 
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
956 
-     *    wp-option "page_for_posts", or "posts" if no page is selected
957 
-     *
958 
-     * @access    public
959 
-     * @return    string
960 
-     */
961 
-    public static function get_page_for_posts()
962 
-    {
963 
-        $page_for_posts = get_option('page_for_posts');
964 
-        if (! $page_for_posts) {
965 
-            return 'posts';
966 
-        }
967 
-        /** @type WPDB $wpdb */
968 
-        global $wpdb;
969 
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
970 
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
971 
-    }
972 
-
973 
-
974 
-    /**
975 
-     *    register_shortcodes_and_modules.
976 
-     *    At this point, it's too early to tell if we're maintenance mode or not.
977 
-     *    In fact, this is where we give modules a chance to let core know they exist
978 
-     *    so they can help trigger maintenance mode if it's needed
979 
-     *
980 
-     * @access    public
981 
-     * @return    void
982 
-     */
983 
-    public function register_shortcodes_and_modules()
984 
-    {
985 
-        // allow modules to set hooks for the rest of the system
986 
-        EE_Registry::instance()->modules = $this->_register_modules();
987 
-    }
988 
-
989 
-
990 
-    /**
991 
-     *    initialize_shortcodes_and_modules
992 
-     *    meaning they can start adding their hooks to get stuff done
993 
-     *
994 
-     * @access    public
995 
-     * @return    void
996 
-     */
997 
-    public function initialize_shortcodes_and_modules()
998 
-    {
999 
-        // allow modules to set hooks for the rest of the system
1000 
-        $this->_initialize_modules();
1001 
-    }
1002 
-
1003 
-
1004 
-    /**
1005 
-     *    widgets_init
1006 
-     *
1007 
-     * @access private
1008 
-     * @return void
1009 
-     */
1010 
-    public function widgets_init()
1011 
-    {
1012 
-        // only init widgets on admin pages when not in complete maintenance, and
1013 
-        // on frontend when not in any maintenance mode
1014 
-        if (! EE_Maintenance_Mode::instance()->level()
1015 
-            || (
1016 
-                is_admin()
1017 
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
1018 
-            )
1019 
-        ) {
1020 
-            // grab list of installed widgets
1021 
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
1022 
-            // filter list of modules to register
1023 
-            $widgets_to_register = apply_filters(
1024 
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
1025 
-                $widgets_to_register
1026 
-            );
1027 
-            if (! empty($widgets_to_register)) {
1028 
-                // cycle thru widget folders
1029 
-                foreach ($widgets_to_register as $widget_path) {
1030 
-                    // add to list of installed widget modules
1031 
-                    EE_Config::register_ee_widget($widget_path);
1032 
-                }
1033 
-            }
1034 
-            // filter list of installed modules
1035 
-            EE_Registry::instance()->widgets = apply_filters(
1036 
-                'FHEE__EE_Config__register_widgets__installed_widgets',
1037 
-                EE_Registry::instance()->widgets
1038 
-            );
1039 
-        }
1040 
-    }
1041 
-
1042 
-
1043 
-    /**
1044 
-     *    register_ee_widget - makes core aware of this widget
1045 
-     *
1046 
-     * @access    public
1047 
-     * @param    string $widget_path - full path up to and including widget folder
1048 
-     * @return    void
1049 
-     */
1050 
-    public static function register_ee_widget($widget_path = null)
1051 
-    {
1052 
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
1053 
-        $widget_ext = '.widget.php';
1054 
-        // make all separators match
1055 
-        $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
1056 
-        // does the file path INCLUDE the actual file name as part of the path ?
1057 
-        if (strpos($widget_path, $widget_ext) !== false) {
1058 
-            // grab and shortcode file name from directory name and break apart at dots
1059 
-            $file_name = explode('.', basename($widget_path));
1060 
-            // take first segment from file name pieces and remove class prefix if it exists
1061 
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
1062 
-            // sanitize shortcode directory name
1063 
-            $widget = sanitize_key($widget);
1064 
-            // now we need to rebuild the shortcode path
1065 
-            $widget_path = explode(DS, $widget_path);
1066 
-            // remove last segment
1067 
-            array_pop($widget_path);
1068 
-            // glue it back together
1069 
-            $widget_path = implode(DS, $widget_path);
1070 
-        } else {
1071 
-            // grab and sanitize widget directory name
1072 
-            $widget = sanitize_key(basename($widget_path));
1073 
-        }
1074 
-        // create classname from widget directory name
1075 
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
1076 
-        // add class prefix
1077 
-        $widget_class = 'EEW_' . $widget;
1078 
-        // does the widget exist ?
1079 
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
1080 
-            $msg = sprintf(
1081 
-                __(
1082 
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
1083 
-                    'event_espresso'
1084 
-                ),
1085 
-                $widget_class,
1086 
-                $widget_path . DS . $widget_class . $widget_ext
1087 
-            );
1088 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1089 
-            return;
1090 
-        }
1091 
-        // load the widget class file
1092 
-        require_once($widget_path . DS . $widget_class . $widget_ext);
1093 
-        // verify that class exists
1094 
-        if (! class_exists($widget_class)) {
1095 
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
1096 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1097 
-            return;
1098 
-        }
1099 
-        register_widget($widget_class);
1100 
-        // add to array of registered widgets
1101 
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
1102 
-    }
1103 
-
1104 
-
1105 
-    /**
1106 
-     *        _register_modules
1107 
-     *
1108 
-     * @access private
1109 
-     * @return array
1110 
-     */
1111 
-    private function _register_modules()
1112 
-    {
1113 
-        // grab list of installed modules
1114 
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
1115 
-        // filter list of modules to register
1116 
-        $modules_to_register = apply_filters(
1117 
-            'FHEE__EE_Config__register_modules__modules_to_register',
1118 
-            $modules_to_register
1119 
-        );
1120 
-        if (! empty($modules_to_register)) {
1121 
-            // loop through folders
1122 
-            foreach ($modules_to_register as $module_path) {
1123 
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
1124 
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
1125 
-                    && $module_path !== EE_MODULES . 'gateways'
1126 
-                ) {
1127 
-                    // add to list of installed modules
1128 
-                    EE_Config::register_module($module_path);
1129 
-                }
1130 
-            }
1131 
-        }
1132 
-        // filter list of installed modules
1133 
-        return apply_filters(
1134 
-            'FHEE__EE_Config___register_modules__installed_modules',
1135 
-            EE_Registry::instance()->modules
1136 
-        );
1137 
-    }
1138 
-
1139 
-
1140 
-    /**
1141 
-     *    register_module - makes core aware of this module
1142 
-     *
1143 
-     * @access    public
1144 
-     * @param    string $module_path - full path up to and including module folder
1145 
-     * @return    bool
1146 
-     */
1147 
-    public static function register_module($module_path = null)
1148 
-    {
1149 
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
1150 
-        $module_ext = '.module.php';
1151 
-        // make all separators match
1152 
-        $module_path = str_replace(array('\\', '/'), DS, $module_path);
1153 
-        // does the file path INCLUDE the actual file name as part of the path ?
1154 
-        if (strpos($module_path, $module_ext) !== false) {
1155 
-            // grab and shortcode file name from directory name and break apart at dots
1156 
-            $module_file = explode('.', basename($module_path));
1157 
-            // now we need to rebuild the shortcode path
1158 
-            $module_path = explode(DS, $module_path);
1159 
-            // remove last segment
1160 
-            array_pop($module_path);
1161 
-            // glue it back together
1162 
-            $module_path = implode(DS, $module_path) . DS;
1163 
-            // take first segment from file name pieces and sanitize it
1164 
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
1165 
-            // ensure class prefix is added
1166 
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
1167 
-        } else {
1168 
-            // we need to generate the filename based off of the folder name
1169 
-            // grab and sanitize module name
1170 
-            $module = strtolower(basename($module_path));
1171 
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
1172 
-            // like trailingslashit()
1173 
-            $module_path = rtrim($module_path, DS) . DS;
1174 
-            // create classname from module directory name
1175 
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
1176 
-            // add class prefix
1177 
-            $module_class = 'EED_' . $module;
1178 
-        }
1179 
-        // does the module exist ?
1180 
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
1181 
-            $msg = sprintf(
1182 
-                __(
1183 
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
1184 
-                    'event_espresso'
1185 
-                ),
1186 
-                $module
1187 
-            );
1188 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1189 
-            return false;
1190 
-        }
1191 
-        // load the module class file
1192 
-        require_once($module_path . $module_class . $module_ext);
1193 
-        // verify that class exists
1194 
-        if (! class_exists($module_class)) {
1195 
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
1196 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1197 
-            return false;
1198 
-        }
1199 
-        // add to array of registered modules
1200 
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
1201 
-        do_action(
1202 
-            'AHEE__EE_Config__register_module__complete',
1203 
-            $module_class,
1204 
-            EE_Registry::instance()->modules->{$module_class}
1205 
-        );
1206 
-        return true;
1207 
-    }
1208 
-
1209 
-
1210 
-    /**
1211 
-     *    _initialize_modules
1212 
-     *    allow modules to set hooks for the rest of the system
1213 
-     *
1214 
-     * @access private
1215 
-     * @return void
1216 
-     */
1217 
-    private function _initialize_modules()
1218 
-    {
1219 
-        // cycle thru shortcode folders
1220 
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
1221 
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
1222 
-            // which set hooks ?
1223 
-            if (is_admin()) {
1224 
-                // fire immediately
1225 
-                call_user_func(array($module_class, 'set_hooks_admin'));
1226 
-            } else {
1227 
-                // delay until other systems are online
1228 
-                add_action(
1229 
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
1230 
-                    array($module_class, 'set_hooks')
1231 
-                );
1232 
-            }
1233 
-        }
1234 
-    }
1235 
-
1236 
-
1237 
-    /**
1238 
-     *    register_route - adds module method routes to route_map
1239 
-     *
1240 
-     * @access    public
1241 
-     * @param    string $route       - "pretty" public alias for module method
1242 
-     * @param    string $module      - module name (classname without EED_ prefix)
1243 
-     * @param    string $method_name - the actual module method to be routed to
1244 
-     * @param    string $key         - url param key indicating a route is being called
1245 
-     * @return    bool
1246 
-     */
1247 
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
1248 
-    {
1249 
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
1250 
-        $module = str_replace('EED_', '', $module);
1251 
-        $module_class = 'EED_' . $module;
1252 
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
1253 
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
1254 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1255 
-            return false;
1256 
-        }
1257 
-        if (empty($route)) {
1258 
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
1259 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1260 
-            return false;
1261 
-        }
1262 
-        if (! method_exists('EED_' . $module, $method_name)) {
1263 
-            $msg = sprintf(
1264 
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
1265 
-                $route
1266 
-            );
1267 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1268 
-            return false;
1269 
-        }
1270 
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
1271 
-        return true;
1272 
-    }
1273 
-
1274 
-
1275 
-    /**
1276 
-     *    get_route - get module method route
1277 
-     *
1278 
-     * @access    public
1279 
-     * @param    string $route - "pretty" public alias for module method
1280 
-     * @param    string $key   - url param key indicating a route is being called
1281 
-     * @return    string
1282 
-     */
1283 
-    public static function get_route($route = null, $key = 'ee')
1284 
-    {
1285 
-        do_action('AHEE__EE_Config__get_route__begin', $route);
1286 
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
1287 
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
1288 
-            return EE_Config::$_module_route_map[ $key ][ $route ];
1289 
-        }
1290 
-        return null;
1291 
-    }
1292 
-
1293 
-
1294 
-    /**
1295 
-     *    get_routes - get ALL module method routes
1296 
-     *
1297 
-     * @access    public
1298 
-     * @return    array
1299 
-     */
1300 
-    public static function get_routes()
1301 
-    {
1302 
-        return EE_Config::$_module_route_map;
1303 
-    }
1304 
-
1305 
-
1306 
-    /**
1307 
-     *    register_forward - allows modules to forward request to another module for further processing
1308 
-     *
1309 
-     * @access    public
1310 
-     * @param    string       $route   - "pretty" public alias for module method
1311 
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
1312 
-     *                                 class, allows different forwards to be served based on status
1313 
-     * @param    array|string $forward - function name or array( class, method )
1314 
-     * @param    string       $key     - url param key indicating a route is being called
1315 
-     * @return    bool
1316 
-     */
1317 
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
1318 
-    {
1319 
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
1320 
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1321 
-            $msg = sprintf(
1322 
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
1323 
-                $route
1324 
-            );
1325 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1326 
-            return false;
1327 
-        }
1328 
-        if (empty($forward)) {
1329 
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
1330 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1331 
-            return false;
1332 
-        }
1333 
-        if (is_array($forward)) {
1334 
-            if (! isset($forward[1])) {
1335 
-                $msg = sprintf(
1336 
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
1337 
-                    $route
1338 
-                );
1339 
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1340 
-                return false;
1341 
-            }
1342 
-            if (! method_exists($forward[0], $forward[1])) {
1343 
-                $msg = sprintf(
1344 
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
1345 
-                    $forward[1],
1346 
-                    $route
1347 
-                );
1348 
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1349 
-                return false;
1350 
-            }
1351 
-        } elseif (! function_exists($forward)) {
1352 
-            $msg = sprintf(
1353 
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
1354 
-                $forward,
1355 
-                $route
1356 
-            );
1357 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1358 
-            return false;
1359 
-        }
1360 
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
1361 
-        return true;
1362 
-    }
1363 
-
1364 
-
1365 
-    /**
1366 
-     *    get_forward - get forwarding route
1367 
-     *
1368 
-     * @access    public
1369 
-     * @param    string  $route  - "pretty" public alias for module method
1370 
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1371 
-     *                           allows different forwards to be served based on status
1372 
-     * @param    string  $key    - url param key indicating a route is being called
1373 
-     * @return    string
1374 
-     */
1375 
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
1376 
-    {
1377 
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
1378 
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
1379 
-            return apply_filters(
1380 
-                'FHEE__EE_Config__get_forward',
1381 
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
1382 
-                $route,
1383 
-                $status
1384 
-            );
1385 
-        }
1386 
-        return null;
1387 
-    }
1388 
-
1389 
-
1390 
-    /**
1391 
-     *    register_forward - allows modules to specify different view templates for different method routes and status
1392 
-     *    results
1393 
-     *
1394 
-     * @access    public
1395 
-     * @param    string  $route  - "pretty" public alias for module method
1396 
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1397 
-     *                           allows different views to be served based on status
1398 
-     * @param    string  $view
1399 
-     * @param    string  $key    - url param key indicating a route is being called
1400 
-     * @return    bool
1401 
-     */
1402 
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
1403 
-    {
1404 
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
1405 
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1406 
-            $msg = sprintf(
1407 
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
1408 
-                $route
1409 
-            );
1410 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1411 
-            return false;
1412 
-        }
1413 
-        if (! is_readable($view)) {
1414 
-            $msg = sprintf(
1415 
-                __(
1416 
-                    'The %s view file could not be found or is not readable due to file permissions.',
1417 
-                    'event_espresso'
1418 
-                ),
1419 
-                $view
1420 
-            );
1421 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1422 
-            return false;
1423 
-        }
1424 
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
1425 
-        return true;
1426 
-    }
1427 
-
1428 
-
1429 
-    /**
1430 
-     *    get_view - get view for route and status
1431 
-     *
1432 
-     * @access    public
1433 
-     * @param    string  $route  - "pretty" public alias for module method
1434 
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1435 
-     *                           allows different views to be served based on status
1436 
-     * @param    string  $key    - url param key indicating a route is being called
1437 
-     * @return    string
1438 
-     */
1439 
-    public static function get_view($route = null, $status = 0, $key = 'ee')
1440 
-    {
1441 
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
1442 
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
1443 
-            return apply_filters(
1444 
-                'FHEE__EE_Config__get_view',
1445 
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
1446 
-                $route,
1447 
-                $status
1448 
-            );
1449 
-        }
1450 
-        return null;
1451 
-    }
1452 
-
1453 
-
1454 
-    public function update_addon_option_names()
1455 
-    {
1456 
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
1457 
-    }
1458 
-
1459 
-
1460 
-    public function shutdown()
1461 
-    {
1462 
-        $this->update_addon_option_names();
1463 
-    }
1464 
-
1465 
-
1466 
-    /**
1467 
-     * @return LegacyShortcodesManager
1468 
-     */
1469 
-    public static function getLegacyShortcodesManager()
1470 
-    {
1471 
-
1472 
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1473 
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
1474 
-                EE_Registry::instance()
1475 
-            );
1476 
-        }
1477 
-        return EE_Config::instance()->legacy_shortcodes_manager;
1478 
-    }
1479 
-
1480 
-
1481 
-    /**
1482 
-     * register_shortcode - makes core aware of this shortcode
1483 
-     *
1484 
-     * @deprecated 4.9.26
1485 
-     * @param    string $shortcode_path - full path up to and including shortcode folder
1486 
-     * @return    bool
1487 
-     */
1488 
-    public static function register_shortcode($shortcode_path = null)
1489 
-    {
1490 
-        EE_Error::doing_it_wrong(
1491 
-            __METHOD__,
1492 
-            __(
1493 
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
1494 
-                'event_espresso'
1495 
-            ),
1496 
-            '4.9.26'
1497 
-        );
1498 
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
1499 
-    }
1500 
-}
1501 
-
1502 
-/**
1503 
- * Base class used for config classes. These classes should generally not have
1504 
- * magic functions in use, except we'll allow them to magically set and get stuff...
1505 
- * basically, they should just be well-defined stdClasses
1506 
- */
1507 
-class EE_Config_Base
1508 
-{
1509 
-
1510 
-    /**
1511 
-     * Utility function for escaping the value of a property and returning.
1512 
-     *
1513 
-     * @param string $property property name (checks to see if exists).
1514 
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1515 
-     * @throws \EE_Error
1516 
-     */
1517 
-    public function get_pretty($property)
1518 
-    {
1519 
-        if (! property_exists($this, $property)) {
1520 
-            throw new EE_Error(
1521 
-                sprintf(
1522 
-                    __(
1523 
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
1524 
-                        'event_espresso'
1525 
-                    ),
1526 
-                    get_class($this),
1527 
-                    $property
1528 
-                )
1529 
-            );
1530 
-        }
1531 
-        // just handling escaping of strings for now.
1532 
-        if (is_string($this->{$property})) {
1533 
-            return stripslashes($this->{$property});
1534 
-        }
1535 
-        return $this->{$property};
1536 
-    }
1537 
-
1538 
-
1539 
-    public function populate()
1540 
-    {
1541 
-        // grab defaults via a new instance of this class.
1542 
-        $class_name = get_class($this);
1543 
-        $defaults = new $class_name;
1544 
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
1545 
-        // default from our $defaults object.
1546 
-        foreach (get_object_vars($defaults) as $property => $value) {
1547 
-            if ($this->{$property} === null) {
1548 
-                $this->{$property} = $value;
1549 
-            }
1550 
-        }
1551 
-        // cleanup
1552 
-        unset($defaults);
1553 
-    }
1554 
-
1555 
-
1556 
-    /**
1557 
-     *        __isset
1558 
-     *
1559 
-     * @param $a
1560 
-     * @return bool
1561 
-     */
1562 
-    public function __isset($a)
1563 
-    {
1564 
-        return false;
1565 
-    }
1566 
-
1567 
-
1568 
-    /**
1569 
-     *        __unset
1570 
-     *
1571 
-     * @param $a
1572 
-     * @return bool
1573 
-     */
1574 
-    public function __unset($a)
1575 
-    {
1576 
-        return false;
1577 
-    }
1578 
-
1579 
-
1580 
-    /**
1581 
-     *        __clone
1582 
-     */
1583 
-    public function __clone()
1584 
-    {
1585 
-    }
1586 
-
1587 
-
1588 
-    /**
1589 
-     *        __wakeup
1590 
-     */
1591 
-    public function __wakeup()
1592 
-    {
1593 
-    }
1594 
-
1595 
-
1596 
-    /**
1597 
-     *        __destruct
1598 
-     */
1599 
-    public function __destruct()
1600 
-    {
1601 
-    }
1602 
-}
1603 
-
1604 
-/**
1605 
- * Class for defining what's in the EE_Config relating to registration settings
1606 
- */
1607 
-class EE_Core_Config extends EE_Config_Base
1608 
-{
1609 
-
1610 
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
1611 
-
1612 
-
1613 
-    public $current_blog_id;
1614 
-
1615 
-    public $ee_ueip_optin;
1616 
-
1617 
-    public $ee_ueip_has_notified;
1618 
-
1619 
-    /**
1620 
-     * Not to be confused with the 4 critical page variables (See
1621 
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
1622 
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
1623 
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
1624 
-     *
1625 
-     * @var array
1626 
-     */
1627 
-    public $post_shortcodes;
1628 
-
1629 
-    public $module_route_map;
1630 
-
1631 
-    public $module_forward_map;
1632 
-
1633 
-    public $module_view_map;
1634 
-
1635 
-    /**
1636 
-     * The next 4 vars are the IDs of critical EE pages.
1637 
-     *
1638 
-     * @var int
1639 
-     */
1640 
-    public $reg_page_id;
1641 
-
1642 
-    public $txn_page_id;
1643 
-
1644 
-    public $thank_you_page_id;
1645 
-
1646 
-    public $cancel_page_id;
1647 
-
1648 
-    /**
1649 
-     * The next 4 vars are the URLs of critical EE pages.
1650 
-     *
1651 
-     * @var int
1652 
-     */
1653 
-    public $reg_page_url;
1654 
-
1655 
-    public $txn_page_url;
1656 
-
1657 
-    public $thank_you_page_url;
1658 
-
1659 
-    public $cancel_page_url;
1660 
-
1661 
-    /**
1662 
-     * The next vars relate to the custom slugs for EE CPT routes
1663 
-     */
1664 
-    public $event_cpt_slug;
1665 
-
1666 
-    /**
1667 
-     * This caches the _ee_ueip_option in case this config is reset in the same
1668 
-     * request across blog switches in a multisite context.
1669 
-     * Avoids extra queries to the db for this option.
1670 
-     *
1671 
-     * @var bool
1672 
-     */
1673 
-    public static $ee_ueip_option;
1674 
-
1675 
-
1676 
-    /**
1677 
-     *    class constructor
1678 
-     *
1679 
-     * @access    public
1680 
-     */
1681 
-    public function __construct()
1682 
-    {
1683 
-        // set default organization settings
1684 
-        $this->current_blog_id = get_current_blog_id();
1685 
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
1686 
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
1687 
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
1688 
-        $this->post_shortcodes = array();
1689 
-        $this->module_route_map = array();
1690 
-        $this->module_forward_map = array();
1691 
-        $this->module_view_map = array();
1692 
-        // critical EE page IDs
1693 
-        $this->reg_page_id = 0;
1694 
-        $this->txn_page_id = 0;
1695 
-        $this->thank_you_page_id = 0;
1696 
-        $this->cancel_page_id = 0;
1697 
-        // critical EE page URLs
1698 
-        $this->reg_page_url = '';
1699 
-        $this->txn_page_url = '';
1700 
-        $this->thank_you_page_url = '';
1701 
-        $this->cancel_page_url = '';
1702 
-        // cpt slugs
1703 
-        $this->event_cpt_slug = __('events', 'event_espresso');
1704 
-        // ueip constant check
1705 
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
1706 
-            $this->ee_ueip_optin = false;
1707 
-            $this->ee_ueip_has_notified = true;
1708 
-        }
1709 
-    }
1710 
-
1711 
-
1712 
-    /**
1713 
-     * @return array
1714 
-     */
1715 
-    public function get_critical_pages_array()
1716 
-    {
1717 
-        return array(
1718 
-            $this->reg_page_id,
1719 
-            $this->txn_page_id,
1720 
-            $this->thank_you_page_id,
1721 
-            $this->cancel_page_id,
1722 
-        );
1723 
-    }
1724 
-
1725 
-
1726 
-    /**
1727 
-     * @return array
1728 
-     */
1729 
-    public function get_critical_pages_shortcodes_array()
1730 
-    {
1731 
-        return array(
1732 
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
1733 
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
1734 
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
1735 
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
1736 
-        );
1737 
-    }
1738 
-
1739 
-
1740 
-    /**
1741 
-     *  gets/returns URL for EE reg_page
1742 
-     *
1743 
-     * @access    public
1744 
-     * @return    string
1745 
-     */
1746 
-    public function reg_page_url()
1747 
-    {
1748 
-        if (! $this->reg_page_url) {
1749 
-            $this->reg_page_url = add_query_arg(
1750 
-                array('uts' => time()),
1751 
-                get_permalink($this->reg_page_id)
1752 
-            ) . '#checkout';
1753 
-        }
1754 
-        return $this->reg_page_url;
1755 
-    }
1756 
-
1757 
-
1758 
-    /**
1759 
-     *  gets/returns URL for EE txn_page
1760 
-     *
1761 
-     * @param array $query_args like what gets passed to
1762 
-     *                          add_query_arg() as the first argument
1763 
-     * @access    public
1764 
-     * @return    string
1765 
-     */
1766 
-    public function txn_page_url($query_args = array())
1767 
-    {
1768 
-        if (! $this->txn_page_url) {
1769 
-            $this->txn_page_url = get_permalink($this->txn_page_id);
1770 
-        }
1771 
-        if ($query_args) {
1772 
-            return add_query_arg($query_args, $this->txn_page_url);
1773 
-        } else {
1774 
-            return $this->txn_page_url;
1775 
-        }
1776 
-    }
1777 
-
1778 
-
1779 
-    /**
1780 
-     *  gets/returns URL for EE thank_you_page
1781 
-     *
1782 
-     * @param array $query_args like what gets passed to
1783 
-     *                          add_query_arg() as the first argument
1784 
-     * @access    public
1785 
-     * @return    string
1786 
-     */
1787 
-    public function thank_you_page_url($query_args = array())
1788 
-    {
1789 
-        if (! $this->thank_you_page_url) {
1790 
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
1791 
-        }
1792 
-        if ($query_args) {
1793 
-            return add_query_arg($query_args, $this->thank_you_page_url);
1794 
-        } else {
1795 
-            return $this->thank_you_page_url;
1796 
-        }
1797 
-    }
1798 
-
1799 
-
1800 
-    /**
1801 
-     *  gets/returns URL for EE cancel_page
1802 
-     *
1803 
-     * @access    public
1804 
-     * @return    string
1805 
-     */
1806 
-    public function cancel_page_url()
1807 
-    {
1808 
-        if (! $this->cancel_page_url) {
1809 
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
1810 
-        }
1811 
-        return $this->cancel_page_url;
1812 
-    }
1813 
-
1814 
-
1815 
-    /**
1816 
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
1817 
-     *
1818 
-     * @since 4.7.5
1819 
-     */
1820 
-    protected function _reset_urls()
1821 
-    {
1822 
-        $this->reg_page_url = '';
1823 
-        $this->txn_page_url = '';
1824 
-        $this->cancel_page_url = '';
1825 
-        $this->thank_you_page_url = '';
1826 
-    }
1827 
-
1828 
-
1829 
-    /**
1830 
-     * Used to return what the optin value is set for the EE User Experience Program.
1831 
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
1832 
-     * on the main site only.
1833 
-     *
1834 
-     * @return bool
1835 
-     */
1836 
-    protected function _get_main_ee_ueip_optin()
1837 
-    {
1838 
-        // if this is the main site then we can just bypass our direct query.
1839 
-        if (is_main_site()) {
1840 
-            return get_option(self::OPTION_NAME_UXIP, false);
1841 
-        }
1842 
-        // is this already cached for this request?  If so use it.
1843 
-        if (EE_Core_Config::$ee_ueip_option !== null) {
1844 
-            return EE_Core_Config::$ee_ueip_option;
1845 
-        }
1846 
-        global $wpdb;
1847 
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
1848 
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
1849 
-        $option = self::OPTION_NAME_UXIP;
1850 
-        // set correct table for query
1851 
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
1852 
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
1853 
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
1854 
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
1855 
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
1856 
-        // for the purpose of caching.
1857 
-        $pre = apply_filters('pre_option_' . $option, false, $option);
1858 
-        if (false !== $pre) {
1859 
-            EE_Core_Config::$ee_ueip_option = $pre;
1860 
-            return EE_Core_Config::$ee_ueip_option;
1861 
-        }
1862 
-        $row = $wpdb->get_row(
1863 
-            $wpdb->prepare(
1864 
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
1865 
-                $option
1866 
-            )
1867 
-        );
1868 
-        if (is_object($row)) {
1869 
-            $value = $row->option_value;
1870 
-        } else { // option does not exist so use default.
1871 
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
1872 
-            return EE_Core_Config::$ee_ueip_option;
1873 
-        }
1874 
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
1875 
-        return EE_Core_Config::$ee_ueip_option;
1876 
-    }
1877 
-
1878 
-
1879 
-    /**
1880 
-     * Utility function for escaping the value of a property and returning.
1881 
-     *
1882 
-     * @param string $property property name (checks to see if exists).
1883 
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1884 
-     * @throws \EE_Error
1885 
-     */
1886 
-    public function get_pretty($property)
1887 
-    {
1888 
-        if ($property === self::OPTION_NAME_UXIP) {
1889 
-            return $this->ee_ueip_optin ? 'yes' : 'no';
1890 
-        }
1891 
-        return parent::get_pretty($property);
1892 
-    }
1893 
-
1894 
-
1895 
-    /**
1896 
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
1897 
-     * on the object.
1898 
-     *
1899 
-     * @return array
1900 
-     */
1901 
-    public function __sleep()
1902 
-    {
1903 
-        // reset all url properties
1904 
-        $this->_reset_urls();
1905 
-        // return what to save to db
1906 
-        return array_keys(get_object_vars($this));
1907 
-    }
1908 
-}
1909 
-
1910 
-/**
1911 
- * Config class for storing info on the Organization
1912 
- */
1913 
-class EE_Organization_Config extends EE_Config_Base
1914 
-{
1915 
-
1916 
-    /**
1917 
-     * @var string $name
1918 
-     * eg EE4.1
1919 
-     */
1920 
-    public $name;
1921 
-
1922 
-    /**
1923 
-     * @var string $address_1
1924 
-     * eg 123 Onna Road
1925 
-     */
1926 
-    public $address_1 = '';
1927 
-
1928 
-    /**
1929 
-     * @var string $address_2
1930 
-     * eg PO Box 123
1931 
-     */
1932 
-    public $address_2 = '';
1933 
-
1934 
-    /**
1935 
-     * @var string $city
1936 
-     * eg Inna City
1937 
-     */
1938 
-    public $city = '';
1939 
-
1940 
-    /**
1941 
-     * @var int $STA_ID
1942 
-     * eg 4
1943 
-     */
1944 
-    public $STA_ID = 0;
1945 
-
1946 
-    /**
1947 
-     * @var string $CNT_ISO
1948 
-     * eg US
1949 
-     */
1950 
-    public $CNT_ISO = '';
1951 
-
1952 
-    /**
1953 
-     * @var string $zip
1954 
-     * eg 12345  or V1A 2B3
1955 
-     */
1956 
-    public $zip = '';
1957 
-
1958 
-    /**
1959 
-     * @var string $email
1960 
-     * eg [email protected]
1961 
-     */
1962 
-    public $email;
1963 
-
1964 
-    /**
1965 
-     * @var string $phone
1966 
-     * eg. 111-111-1111
1967 
-     */
1968 
-    public $phone = '';
1969 
-
1970 
-    /**
1971 
-     * @var string $vat
1972 
-     * VAT/Tax Number
1973 
-     */
1974 
-    public $vat = '';
1975 
-
1976 
-    /**
1977 
-     * @var string $logo_url
1978 
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
1979 
-     */
1980 
-    public $logo_url = '';
1981 
-
1982 
-    /**
1983 
-     * The below are all various properties for holding links to organization social network profiles
1984 
-     *
1985 
-     * @var string
1986 
-     */
1987 
-    /**
1988 
-     * facebook (facebook.com/profile.name)
1989 
-     *
1990 
-     * @var string
1991 
-     */
1992 
-    public $facebook = '';
1993 
-
1994 
-    /**
1995 
-     * twitter (twitter.com/twitter_handle)
1996 
-     *
1997 
-     * @var string
1998 
-     */
1999 
-    public $twitter = '';
2000 
-
2001 
-    /**
2002 
-     * linkedin (linkedin.com/in/profile_name)
2003 
-     *
2004 
-     * @var string
2005 
-     */
2006 
-    public $linkedin = '';
2007 
-
2008 
-    /**
2009 
-     * pinterest (www.pinterest.com/profile_name)
2010 
-     *
2011 
-     * @var string
2012 
-     */
2013 
-    public $pinterest = '';
2014 
-
2015 
-    /**
2016 
-     * google+ (google.com/+profileName)
2017 
-     *
2018 
-     * @var string
2019 
-     */
2020 
-    public $google = '';
2021 
-
2022 
-    /**
2023 
-     * instagram (instagram.com/handle)
2024 
-     *
2025 
-     * @var string
2026 
-     */
2027 
-    public $instagram = '';
2028 
-
2029 
-
2030 
-    /**
2031 
-     *    class constructor
2032 
-     *
2033 
-     * @access    public
2034 
-     */
2035 
-    public function __construct()
2036 
-    {
2037 
-        // set default organization settings
2038 
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
2039 
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
2040 
-        $this->email = get_bloginfo('admin_email');
2041 
-    }
2042 
-}
2043 
-
2044 
-/**
2045 
- * Class for defining what's in the EE_Config relating to currency
2046 
- */
2047 
-class EE_Currency_Config extends EE_Config_Base
2048 
-{
2049 
-
2050 
-    /**
2051 
-     * @var string $code
2052 
-     * eg 'US'
2053 
-     */
2054 
-    public $code;
2055 
-
2056 
-    /**
2057 
-     * @var string $name
2058 
-     * eg 'Dollar'
2059 
-     */
2060 
-    public $name;
2061 
-
2062 
-    /**
2063 
-     * plural name
2064 
-     *
2065 
-     * @var string $plural
2066 
-     * eg 'Dollars'
2067 
-     */
2068 
-    public $plural;
2069 
-
2070 
-    /**
2071 
-     * currency sign
2072 
-     *
2073 
-     * @var string $sign
2074 
-     * eg '$'
2075 
-     */
2076 
-    public $sign;
2077 
-
2078 
-    /**
2079 
-     * Whether the currency sign should come before the number or not
2080 
-     *
2081 
-     * @var boolean $sign_b4
2082 
-     */
2083 
-    public $sign_b4;
2084 
-
2085 
-    /**
2086 
-     * How many digits should come after the decimal place
2087 
-     *
2088 
-     * @var int $dec_plc
2089 
-     */
2090 
-    public $dec_plc;
2091 
-
2092 
-    /**
2093 
-     * Symbol to use for decimal mark
2094 
-     *
2095 
-     * @var string $dec_mrk
2096 
-     * eg '.'
2097 
-     */
2098 
-    public $dec_mrk;
2099 
-
2100 
-    /**
2101 
-     * Symbol to use for thousands
2102 
-     *
2103 
-     * @var string $thsnds
2104 
-     * eg ','
2105 
-     */
2106 
-    public $thsnds;
2107 
-
2108 
-
2109 
-    /**
2110 
-     *    class constructor
2111 
-     *
2112 
-     * @access    public
2113 
-     * @param string $CNT_ISO
2114 
-     * @throws \EE_Error
2115 
-     */
2116 
-    public function __construct($CNT_ISO = '')
2117 
-    {
2118 
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
2119 
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
2120 
-        // get country code from organization settings or use default
2121 
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
2122 
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
2123 
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
2124 
-            : '';
2125 
-        // but override if requested
2126 
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
2127 
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
2128 
-        if (! empty($CNT_ISO)
2129 
-            && EE_Maintenance_Mode::instance()->models_can_query()
2130 
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
2131 
-        ) {
2132 
-            // retrieve the country settings from the db, just in case they have been customized
2133 
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
2134 
-            if ($country instanceof EE_Country) {
2135 
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
2136 
-                $this->name = $country->currency_name_single();    // Dollar
2137 
-                $this->plural = $country->currency_name_plural();    // Dollars
2138 
-                $this->sign = $country->currency_sign();            // currency sign: $
2139 
-                $this->sign_b4 = $country->currency_sign_before(
2140 
-                );        // currency sign before or after: $TRUE  or  FALSE$
2141 
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
2142 
-                $this->dec_mrk = $country->currency_decimal_mark(
2143 
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2144 
-                $this->thsnds = $country->currency_thousands_separator(
2145 
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2146 
-            }
2147 
-        }
2148 
-        // fallback to hardcoded defaults, in case the above failed
2149 
-        if (empty($this->code)) {
2150 
-            // set default currency settings
2151 
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
2152 
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
2153 
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
2154 
-            $this->sign = '$';    // currency sign: $
2155 
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
2156 
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
2157 
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2158 
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2159 
-        }
2160 
-    }
2161 
-}
2162 
-
2163 
-/**
2164 
- * Class for defining what's in the EE_Config relating to registration settings
2165 
- */
2166 
-class EE_Registration_Config extends EE_Config_Base
2167 
-{
2168 
-
2169 
-    /**
2170 
-     * Default registration status
2171 
-     *
2172 
-     * @var string $default_STS_ID
2173 
-     * eg 'RPP'
2174 
-     */
2175 
-    public $default_STS_ID;
2176 
-
2177 
-    /**
2178 
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
2179 
-     * registrations)
2180 
-     *
2181 
-     * @var int
2182 
-     */
2183 
-    public $default_maximum_number_of_tickets;
2184 
-
2185 
-    /**
2186 
-     * level of validation to apply to email addresses
2187 
-     *
2188 
-     * @var string $email_validation_level
2189 
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
2190 
-     */
2191 
-    public $email_validation_level;
2192 
-
2193 
-    /**
2194 
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
2195 
-     *
2196 
-     * @var boolean $show_pending_payment_options
2197 
-     */
2198 
-    public $show_pending_payment_options;
2199 
-
2200 
-    /**
2201 
-     * Whether to skip the registration confirmation page
2202 
-     *
2203 
-     * @var boolean $skip_reg_confirmation
2204 
-     */
2205 
-    public $skip_reg_confirmation;
2206 
-
2207 
-    /**
2208 
-     * an array of SPCO reg steps where:
2209 
-     *        the keys denotes the reg step order
2210 
-     *        each element consists of an array with the following elements:
2211 
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
2212 
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
2213 
-     *            "slug" => the URL param used to trigger the reg step
2214 
-     *
2215 
-     * @var array $reg_steps
2216 
-     */
2217 
-    public $reg_steps;
2218 
-
2219 
-    /**
2220 
-     * Whether registration confirmation should be the last page of SPCO
2221 
-     *
2222 
-     * @var boolean $reg_confirmation_last
2223 
-     */
2224 
-    public $reg_confirmation_last;
2225 
-
2226 
-    /**
2227 
-     * Whether or not to enable the EE Bot Trap
2228 
-     *
2229 
-     * @var boolean $use_bot_trap
2230 
-     */
2231 
-    public $use_bot_trap;
2232 
-
2233 
-    /**
2234 
-     * Whether or not to encrypt some data sent by the EE Bot Trap
2235 
-     *
2236 
-     * @var boolean $use_encryption
2237 
-     */
2238 
-    public $use_encryption;
2239 
-
2240 
-    /**
2241 
-     * Whether or not to use ReCaptcha
2242 
-     *
2243 
-     * @var boolean $use_captcha
2244 
-     */
2245 
-    public $use_captcha;
2246 
-
2247 
-    /**
2248 
-     * ReCaptcha Theme
2249 
-     *
2250 
-     * @var string $recaptcha_theme
2251 
-     *    options: 'dark', 'light', 'invisible'
2252 
-     */
2253 
-    public $recaptcha_theme;
2254 
-
2255 
-    /**
2256 
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
2257 
-     *
2258 
-     * @var string $recaptcha_badge
2259 
-     *    options: 'bottomright', 'bottomleft', 'inline'
2260 
-     */
2261 
-    public $recaptcha_badge;
17 
+	const OPTION_NAME = 'ee_config';
18 
+
19 
+	const LOG_NAME = 'ee_config_log';
20 
+
21 
+	const LOG_LENGTH = 100;
22 
+
23 
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
24 
+
25 
+	/**
26 
+	 *    instance of the EE_Config object
27 
+	 *
28 
+	 * @var    EE_Config $_instance
29 
+	 * @access    private
30 
+	 */
31 
+	private static $_instance;
32 
+
33 
+	/**
34 
+	 * @var boolean $_logging_enabled
35 
+	 */
36 
+	private static $_logging_enabled = false;
37 
+
38 
+	/**
39 
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
40 
+	 */
41 
+	private $legacy_shortcodes_manager;
42 
+
43 
+	/**
44 
+	 * An StdClass whose property names are addon slugs,
45 
+	 * and values are their config classes
46 
+	 *
47 
+	 * @var StdClass
48 
+	 */
49 
+	public $addons;
50 
+
51 
+	/**
52 
+	 * @var EE_Admin_Config
53 
+	 */
54 
+	public $admin;
55 
+
56 
+	/**
57 
+	 * @var EE_Core_Config
58 
+	 */
59 
+	public $core;
60 
+
61 
+	/**
62 
+	 * @var EE_Currency_Config
63 
+	 */
64 
+	public $currency;
65 
+
66 
+	/**
67 
+	 * @var EE_Organization_Config
68 
+	 */
69 
+	public $organization;
70 
+
71 
+	/**
72 
+	 * @var EE_Registration_Config
73 
+	 */
74 
+	public $registration;
75 
+
76 
+	/**
77 
+	 * @var EE_Template_Config
78 
+	 */
79 
+	public $template_settings;
80 
+
81 
+	/**
82 
+	 * Holds EE environment values.
83 
+	 *
84 
+	 * @var EE_Environment_Config
85 
+	 */
86 
+	public $environment;
87 
+
88 
+	/**
89 
+	 * settings pertaining to Google maps
90 
+	 *
91 
+	 * @var EE_Map_Config
92 
+	 */
93 
+	public $map_settings;
94 
+
95 
+	/**
96 
+	 * settings pertaining to Taxes
97 
+	 *
98 
+	 * @var EE_Tax_Config
99 
+	 */
100 
+	public $tax_settings;
101 
+
102 
+	/**
103 
+	 * Settings pertaining to global messages settings.
104 
+	 *
105 
+	 * @var EE_Messages_Config
106 
+	 */
107 
+	public $messages;
108 
+
109 
+	/**
110 
+	 * @deprecated
111 
+	 * @var EE_Gateway_Config
112 
+	 */
113 
+	public $gateway;
114 
+
115 
+	/**
116 
+	 * @var    array $_addon_option_names
117 
+	 * @access    private
118 
+	 */
119 
+	private $_addon_option_names = array();
120 
+
121 
+	/**
122 
+	 * @var    array $_module_route_map
123 
+	 * @access    private
124 
+	 */
125 
+	private static $_module_route_map = array();
126 
+
127 
+	/**
128 
+	 * @var    array $_module_forward_map
129 
+	 * @access    private
130 
+	 */
131 
+	private static $_module_forward_map = array();
132 
+
133 
+	/**
134 
+	 * @var    array $_module_view_map
135 
+	 * @access    private
136 
+	 */
137 
+	private static $_module_view_map = array();
138 
+
139 
+
140 
+	/**
141 
+	 * @singleton method used to instantiate class object
142 
+	 * @access    public
143 
+	 * @return EE_Config instance
144 
+	 */
145 
+	public static function instance()
146 
+	{
147 
+		// check if class object is instantiated, and instantiated properly
148 
+		if (! self::$_instance instanceof EE_Config) {
149 
+			self::$_instance = new self();
150 
+		}
151 
+		return self::$_instance;
152 
+	}
153 
+
154 
+
155 
+	/**
156 
+	 * Resets the config
157 
+	 *
158 
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
159 
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
160 
+	 *                               reflect its state in the database
161 
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
162 
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
163 
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
164 
+	 *                               site was put into maintenance mode)
165 
+	 * @return EE_Config
166 
+	 */
167 
+	public static function reset($hard_reset = false, $reinstantiate = true)
168 
+	{
169 
+		if (self::$_instance instanceof EE_Config) {
170 
+			if ($hard_reset) {
171 
+				self::$_instance->legacy_shortcodes_manager = null;
172 
+				self::$_instance->_addon_option_names = array();
173 
+				self::$_instance->_initialize_config();
174 
+				self::$_instance->update_espresso_config();
175 
+			}
176 
+			self::$_instance->update_addon_option_names();
177 
+		}
178 
+		self::$_instance = null;
179 
+		// we don't need to reset the static properties imo because those should
180 
+		// only change when a module is added or removed. Currently we don't
181 
+		// support removing a module during a request when it previously existed
182 
+		if ($reinstantiate) {
183 
+			return self::instance();
184 
+		} else {
185 
+			return null;
186 
+		}
187 
+	}
188 
+
189 
+
190 
+	/**
191 
+	 *    class constructor
192 
+	 *
193 
+	 * @access    private
194 
+	 */
195 
+	private function __construct()
196 
+	{
197 
+		do_action('AHEE__EE_Config__construct__begin', $this);
198 
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
199 
+		// setup empty config classes
200 
+		$this->_initialize_config();
201 
+		// load existing EE site settings
202 
+		$this->_load_core_config();
203 
+		// confirm everything loaded correctly and set filtered defaults if not
204 
+		$this->_verify_config();
205 
+		//  register shortcodes and modules
206 
+		add_action(
207 
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
208 
+			array($this, 'register_shortcodes_and_modules'),
209 
+			999
210 
+		);
211 
+		//  initialize shortcodes and modules
212 
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
213 
+		// register widgets
214 
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
215 
+		// shutdown
216 
+		add_action('shutdown', array($this, 'shutdown'), 10);
217 
+		// construct__end hook
218 
+		do_action('AHEE__EE_Config__construct__end', $this);
219 
+		// hardcoded hack
220 
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
221 
+	}
222 
+
223 
+
224 
+	/**
225 
+	 * @return boolean
226 
+	 */
227 
+	public static function logging_enabled()
228 
+	{
229 
+		return self::$_logging_enabled;
230 
+	}
231 
+
232 
+
233 
+	/**
234 
+	 * use to get the current theme if needed from static context
235 
+	 *
236 
+	 * @return string current theme set.
237 
+	 */
238 
+	public static function get_current_theme()
239 
+	{
240 
+		return isset(self::$_instance->template_settings->current_espresso_theme)
241 
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
242 
+	}
243 
+
244 
+
245 
+	/**
246 
+	 *        _initialize_config
247 
+	 *
248 
+	 * @access private
249 
+	 * @return void
250 
+	 */
251 
+	private function _initialize_config()
252 
+	{
253 
+		EE_Config::trim_log();
254 
+		// set defaults
255 
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
256 
+		$this->addons = new stdClass();
257 
+		// set _module_route_map
258 
+		EE_Config::$_module_route_map = array();
259 
+		// set _module_forward_map
260 
+		EE_Config::$_module_forward_map = array();
261 
+		// set _module_view_map
262 
+		EE_Config::$_module_view_map = array();
263 
+	}
264 
+
265 
+
266 
+	/**
267 
+	 *        load core plugin configuration
268 
+	 *
269 
+	 * @access private
270 
+	 * @return void
271 
+	 */
272 
+	private function _load_core_config()
273 
+	{
274 
+		// load_core_config__start hook
275 
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
276 
+		$espresso_config = $this->get_espresso_config();
277 
+		foreach ($espresso_config as $config => $settings) {
278 
+			// load_core_config__start hook
279 
+			$settings = apply_filters(
280 
+				'FHEE__EE_Config___load_core_config__config_settings',
281 
+				$settings,
282 
+				$config,
283 
+				$this
284 
+			);
285 
+			if (is_object($settings) && property_exists($this, $config)) {
286 
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
287 
+				// call configs populate method to ensure any defaults are set for empty values.
288 
+				if (method_exists($settings, 'populate')) {
289 
+					$this->{$config}->populate();
290 
+				}
291 
+				if (method_exists($settings, 'do_hooks')) {
292 
+					$this->{$config}->do_hooks();
293 
+				}
294 
+			}
295 
+		}
296 
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
297 
+			$this->update_espresso_config();
298 
+		}
299 
+		// load_core_config__end hook
300 
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
301 
+	}
302 
+
303 
+
304 
+	/**
305 
+	 *    _verify_config
306 
+	 *
307 
+	 * @access    protected
308 
+	 * @return    void
309 
+	 */
310 
+	protected function _verify_config()
311 
+	{
312 
+		$this->core = $this->core instanceof EE_Core_Config
313 
+			? $this->core
314 
+			: new EE_Core_Config();
315 
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
316 
+		$this->organization = $this->organization instanceof EE_Organization_Config
317 
+			? $this->organization
318 
+			: new EE_Organization_Config();
319 
+		$this->organization = apply_filters(
320 
+			'FHEE__EE_Config___initialize_config__organization',
321 
+			$this->organization
322 
+		);
323 
+		$this->currency = $this->currency instanceof EE_Currency_Config
324 
+			? $this->currency
325 
+			: new EE_Currency_Config();
326 
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
327 
+		$this->registration = $this->registration instanceof EE_Registration_Config
328 
+			? $this->registration
329 
+			: new EE_Registration_Config();
330 
+		$this->registration = apply_filters(
331 
+			'FHEE__EE_Config___initialize_config__registration',
332 
+			$this->registration
333 
+		);
334 
+		$this->admin = $this->admin instanceof EE_Admin_Config
335 
+			? $this->admin
336 
+			: new EE_Admin_Config();
337 
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
338 
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
339 
+			? $this->template_settings
340 
+			: new EE_Template_Config();
341 
+		$this->template_settings = apply_filters(
342 
+			'FHEE__EE_Config___initialize_config__template_settings',
343 
+			$this->template_settings
344 
+		);
345 
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
346 
+			? $this->map_settings
347 
+			: new EE_Map_Config();
348 
+		$this->map_settings = apply_filters(
349 
+			'FHEE__EE_Config___initialize_config__map_settings',
350 
+			$this->map_settings
351 
+		);
352 
+		$this->environment = $this->environment instanceof EE_Environment_Config
353 
+			? $this->environment
354 
+			: new EE_Environment_Config();
355 
+		$this->environment = apply_filters(
356 
+			'FHEE__EE_Config___initialize_config__environment',
357 
+			$this->environment
358 
+		);
359 
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
360 
+			? $this->tax_settings
361 
+			: new EE_Tax_Config();
362 
+		$this->tax_settings = apply_filters(
363 
+			'FHEE__EE_Config___initialize_config__tax_settings',
364 
+			$this->tax_settings
365 
+		);
366 
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
367 
+		$this->messages = $this->messages instanceof EE_Messages_Config
368 
+			? $this->messages
369 
+			: new EE_Messages_Config();
370 
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
371 
+			? $this->gateway
372 
+			: new EE_Gateway_Config();
373 
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
374 
+		$this->legacy_shortcodes_manager = null;
375 
+	}
376 
+
377 
+
378 
+	/**
379 
+	 *    get_espresso_config
380 
+	 *
381 
+	 * @access    public
382 
+	 * @return    array of espresso config stuff
383 
+	 */
384 
+	public function get_espresso_config()
385 
+	{
386 
+		// grab espresso configuration
387 
+		return apply_filters(
388 
+			'FHEE__EE_Config__get_espresso_config__CFG',
389 
+			get_option(EE_Config::OPTION_NAME, array())
390 
+		);
391 
+	}
392 
+
393 
+
394 
+	/**
395 
+	 *    double_check_config_comparison
396 
+	 *
397 
+	 * @access    public
398 
+	 * @param string $option
399 
+	 * @param        $old_value
400 
+	 * @param        $value
401 
+	 */
402 
+	public function double_check_config_comparison($option = '', $old_value, $value)
403 
+	{
404 
+		// make sure we're checking the ee config
405 
+		if ($option === EE_Config::OPTION_NAME) {
406 
+			// run a loose comparison of the old value against the new value for type and properties,
407 
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
408 
+			if ($value != $old_value) {
409 
+				// if they are NOT the same, then remove the hook,
410 
+				// which means the subsequent update results will be based solely on the update query results
411 
+				// the reason we do this is because, as stated above,
412 
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
413 
+				// this happens PRIOR to serialization and any subsequent update.
414 
+				// If values are found to match their previous old value,
415 
+				// then WP bails before performing any update.
416 
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
417 
+				// it just pulled from the db, with the one being passed to it (which will not match).
418 
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
419 
+				// MySQL MAY ALSO NOT perform the update because
420 
+				// the string it sees in the db looks the same as the new one it has been passed!!!
421 
+				// This results in the query returning an "affected rows" value of ZERO,
422 
+				// which gets returned immediately by WP update_option and looks like an error.
423 
+				remove_action('update_option', array($this, 'check_config_updated'));
424 
+			}
425 
+		}
426 
+	}
427 
+
428 
+
429 
+	/**
430 
+	 *    update_espresso_config
431 
+	 *
432 
+	 * @access   public
433 
+	 */
434 
+	protected function _reset_espresso_addon_config()
435 
+	{
436 
+		$this->_addon_option_names = array();
437 
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
438 
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
439 
+			if ($addon_config_obj instanceof EE_Config_Base) {
440 
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
441 
+			}
442 
+			$this->addons->{$addon_name} = null;
443 
+		}
444 
+	}
445 
+
446 
+
447 
+	/**
448 
+	 *    update_espresso_config
449 
+	 *
450 
+	 * @access   public
451 
+	 * @param   bool $add_success
452 
+	 * @param   bool $add_error
453 
+	 * @return   bool
454 
+	 */
455 
+	public function update_espresso_config($add_success = false, $add_error = true)
456 
+	{
457 
+		// don't allow config updates during WP heartbeats
458 
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
459 
+			return false;
460 
+		}
461 
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
462 
+		// $clone = clone( self::$_instance );
463 
+		// self::$_instance = NULL;
464 
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
465 
+		$this->_reset_espresso_addon_config();
466 
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
467 
+		// but BEFORE the actual update occurs
468 
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
469 
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
470 
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
471 
+		$this->legacy_shortcodes_manager = null;
472 
+		// now update "ee_config"
473 
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
474 
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
475 
+		EE_Config::log(EE_Config::OPTION_NAME);
476 
+		// if not saved... check if the hook we just added still exists;
477 
+		// if it does, it means one of two things:
478 
+		// that update_option bailed at the($value === $old_value) conditional,
479 
+		// or...
480 
+		// the db update query returned 0 rows affected
481 
+		// (probably because the data  value was the same from it's perspective)
482 
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
483 
+		// but just means no update occurred, so don't display an error to the user.
484 
+		// BUT... if update_option returns FALSE, AND the hook is missing,
485 
+		// then it means that something truly went wrong
486 
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
487 
+		// remove our action since we don't want it in the system anymore
488 
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
489 
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
490 
+		// self::$_instance = $clone;
491 
+		// unset( $clone );
492 
+		// if config remains the same or was updated successfully
493 
+		if ($saved) {
494 
+			if ($add_success) {
495 
+				EE_Error::add_success(
496 
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
497 
+					__FILE__,
498 
+					__FUNCTION__,
499 
+					__LINE__
500 
+				);
501 
+			}
502 
+			return true;
503 
+		} else {
504 
+			if ($add_error) {
505 
+				EE_Error::add_error(
506 
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
507 
+					__FILE__,
508 
+					__FUNCTION__,
509 
+					__LINE__
510 
+				);
511 
+			}
512 
+			return false;
513 
+		}
514 
+	}
515 
+
516 
+
517 
+	/**
518 
+	 *    _verify_config_params
519 
+	 *
520 
+	 * @access    private
521 
+	 * @param    string         $section
522 
+	 * @param    string         $name
523 
+	 * @param    string         $config_class
524 
+	 * @param    EE_Config_Base $config_obj
525 
+	 * @param    array          $tests_to_run
526 
+	 * @param    bool           $display_errors
527 
+	 * @return    bool    TRUE on success, FALSE on fail
528 
+	 */
529 
+	private function _verify_config_params(
530 
+		$section = '',
531 
+		$name = '',
532 
+		$config_class = '',
533 
+		$config_obj = null,
534 
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
535 
+		$display_errors = true
536 
+	) {
537 
+		try {
538 
+			foreach ($tests_to_run as $test) {
539 
+				switch ($test) {
540 
+					// TEST #1 : check that section was set
541 
+					case 1:
542 
+						if (empty($section)) {
543 
+							if ($display_errors) {
544 
+								throw new EE_Error(
545 
+									sprintf(
546 
+										__(
547 
+											'No configuration section has been provided while attempting to save "%s".',
548 
+											'event_espresso'
549 
+										),
550 
+										$config_class
551 
+									)
552 
+								);
553 
+							}
554 
+							return false;
555 
+						}
556 
+						break;
557 
+					// TEST #2 : check that settings section exists
558 
+					case 2:
559 
+						if (! isset($this->{$section})) {
560 
+							if ($display_errors) {
561 
+								throw new EE_Error(
562 
+									sprintf(
563 
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
564 
+										$section
565 
+									)
566 
+								);
567 
+							}
568 
+							return false;
569 
+						}
570 
+						break;
571 
+					// TEST #3 : check that section is the proper format
572 
+					case 3:
573 
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
574 
+						) {
575 
+							if ($display_errors) {
576 
+								throw new EE_Error(
577 
+									sprintf(
578 
+										__(
579 
+											'The "%s" configuration settings have not been formatted correctly.',
580 
+											'event_espresso'
581 
+										),
582 
+										$section
583 
+									)
584 
+								);
585 
+							}
586 
+							return false;
587 
+						}
588 
+						break;
589 
+					// TEST #4 : check that config section name has been set
590 
+					case 4:
591 
+						if (empty($name)) {
592 
+							if ($display_errors) {
593 
+								throw new EE_Error(
594 
+									__(
595 
+										'No name has been provided for the specific configuration section.',
596 
+										'event_espresso'
597 
+									)
598 
+								);
599 
+							}
600 
+							return false;
601 
+						}
602 
+						break;
603 
+					// TEST #5 : check that a config class name has been set
604 
+					case 5:
605 
+						if (empty($config_class)) {
606 
+							if ($display_errors) {
607 
+								throw new EE_Error(
608 
+									__(
609 
+										'No class name has been provided for the specific configuration section.',
610 
+										'event_espresso'
611 
+									)
612 
+								);
613 
+							}
614 
+							return false;
615 
+						}
616 
+						break;
617 
+					// TEST #6 : verify config class is accessible
618 
+					case 6:
619 
+						if (! class_exists($config_class)) {
620 
+							if ($display_errors) {
621 
+								throw new EE_Error(
622 
+									sprintf(
623 
+										__(
624 
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
625 
+											'event_espresso'
626 
+										),
627 
+										$config_class
628 
+									)
629 
+								);
630 
+							}
631 
+							return false;
632 
+						}
633 
+						break;
634 
+					// TEST #7 : check that config has even been set
635 
+					case 7:
636 
+						if (! isset($this->{$section}->{$name})) {
637 
+							if ($display_errors) {
638 
+								throw new EE_Error(
639 
+									sprintf(
640 
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
641 
+										$section,
642 
+										$name
643 
+									)
644 
+								);
645 
+							}
646 
+							return false;
647 
+						} else {
648 
+							// and make sure it's not serialized
649 
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
650 
+						}
651 
+						break;
652 
+					// TEST #8 : check that config is the requested type
653 
+					case 8:
654 
+						if (! $this->{$section}->{$name} instanceof $config_class) {
655 
+							if ($display_errors) {
656 
+								throw new EE_Error(
657 
+									sprintf(
658 
+										__(
659 
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
660 
+											'event_espresso'
661 
+										),
662 
+										$section,
663 
+										$name,
664 
+										$config_class
665 
+									)
666 
+								);
667 
+							}
668 
+							return false;
669 
+						}
670 
+						break;
671 
+					// TEST #9 : verify config object
672 
+					case 9:
673 
+						if (! $config_obj instanceof EE_Config_Base) {
674 
+							if ($display_errors) {
675 
+								throw new EE_Error(
676 
+									sprintf(
677 
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
678 
+										print_r($config_obj, true)
679 
+									)
680 
+								);
681 
+							}
682 
+							return false;
683 
+						}
684 
+						break;
685 
+				}
686 
+			}
687 
+		} catch (EE_Error $e) {
688 
+			$e->get_error();
689 
+		}
690 
+		// you have successfully run the gauntlet
691 
+		return true;
692 
+	}
693 
+
694 
+
695 
+	/**
696 
+	 *    _generate_config_option_name
697 
+	 *
698 
+	 * @access        protected
699 
+	 * @param        string $section
700 
+	 * @param        string $name
701 
+	 * @return        string
702 
+	 */
703 
+	private function _generate_config_option_name($section = '', $name = '')
704 
+	{
705 
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
706 
+	}
707 
+
708 
+
709 
+	/**
710 
+	 *    _set_config_class
711 
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
712 
+	 *
713 
+	 * @access    private
714 
+	 * @param    string $config_class
715 
+	 * @param    string $name
716 
+	 * @return    string
717 
+	 */
718 
+	private function _set_config_class($config_class = '', $name = '')
719 
+	{
720 
+		return ! empty($config_class)
721 
+			? $config_class
722 
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
723 
+	}
724 
+
725 
+
726 
+	/**
727 
+	 *    set_config
728 
+	 *
729 
+	 * @access    protected
730 
+	 * @param    string         $section
731 
+	 * @param    string         $name
732 
+	 * @param    string         $config_class
733 
+	 * @param    EE_Config_Base $config_obj
734 
+	 * @return    EE_Config_Base
735 
+	 */
736 
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
737 
+	{
738 
+		// ensure config class is set to something
739 
+		$config_class = $this->_set_config_class($config_class, $name);
740 
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
741 
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
742 
+			return null;
743 
+		}
744 
+		$config_option_name = $this->_generate_config_option_name($section, $name);
745 
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
746 
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
747 
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
748 
+			$this->update_addon_option_names();
749 
+		}
750 
+		// verify the incoming config object but suppress errors
751 
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
752 
+			$config_obj = new $config_class();
753 
+		}
754 
+		if (get_option($config_option_name)) {
755 
+			EE_Config::log($config_option_name);
756 
+			update_option($config_option_name, $config_obj);
757 
+			$this->{$section}->{$name} = $config_obj;
758 
+			return $this->{$section}->{$name};
759 
+		} else {
760 
+			// create a wp-option for this config
761 
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
762 
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
763 
+				return $this->{$section}->{$name};
764 
+			} else {
765 
+				EE_Error::add_error(
766 
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
767 
+					__FILE__,
768 
+					__FUNCTION__,
769 
+					__LINE__
770 
+				);
771 
+				return null;
772 
+			}
773 
+		}
774 
+	}
775 
+
776 
+
777 
+	/**
778 
+	 *    update_config
779 
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
780 
+	 *
781 
+	 * @access    public
782 
+	 * @param    string                $section
783 
+	 * @param    string                $name
784 
+	 * @param    EE_Config_Base|string $config_obj
785 
+	 * @param    bool                  $throw_errors
786 
+	 * @return    bool
787 
+	 */
788 
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
789 
+	{
790 
+		// don't allow config updates during WP heartbeats
791 
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
792 
+			return false;
793 
+		}
794 
+		$config_obj = maybe_unserialize($config_obj);
795 
+		// get class name of the incoming object
796 
+		$config_class = get_class($config_obj);
797 
+		// run tests 1-5 and 9 to verify config
798 
+		if (! $this->_verify_config_params(
799 
+			$section,
800 
+			$name,
801 
+			$config_class,
802 
+			$config_obj,
803 
+			array(1, 2, 3, 4, 7, 9)
804 
+		)
805 
+		) {
806 
+			return false;
807 
+		}
808 
+		$config_option_name = $this->_generate_config_option_name($section, $name);
809 
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
810 
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
811 
+			// save new config to db
812 
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
813 
+				return true;
814 
+			}
815 
+		} else {
816 
+			// first check if the record already exists
817 
+			$existing_config = get_option($config_option_name);
818 
+			$config_obj = serialize($config_obj);
819 
+			// just return if db record is already up to date (NOT type safe comparison)
820 
+			if ($existing_config == $config_obj) {
821 
+				$this->{$section}->{$name} = $config_obj;
822 
+				return true;
823 
+			} elseif (update_option($config_option_name, $config_obj)) {
824 
+				EE_Config::log($config_option_name);
825 
+				// update wp-option for this config class
826 
+				$this->{$section}->{$name} = $config_obj;
827 
+				return true;
828 
+			} elseif ($throw_errors) {
829 
+				EE_Error::add_error(
830 
+					sprintf(
831 
+						__(
832 
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
833 
+							'event_espresso'
834 
+						),
835 
+						$config_class,
836 
+						'EE_Config->' . $section . '->' . $name
837 
+					),
838 
+					__FILE__,
839 
+					__FUNCTION__,
840 
+					__LINE__
841 
+				);
842 
+			}
843 
+		}
844 
+		return false;
845 
+	}
846 
+
847 
+
848 
+	/**
849 
+	 *    get_config
850 
+	 *
851 
+	 * @access    public
852 
+	 * @param    string $section
853 
+	 * @param    string $name
854 
+	 * @param    string $config_class
855 
+	 * @return    mixed EE_Config_Base | NULL
856 
+	 */
857 
+	public function get_config($section = '', $name = '', $config_class = '')
858 
+	{
859 
+		// ensure config class is set to something
860 
+		$config_class = $this->_set_config_class($config_class, $name);
861 
+		// run tests 1-4, 6 and 7 to verify that all params have been set
862 
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
863 
+			return null;
864 
+		}
865 
+		// now test if the requested config object exists, but suppress errors
866 
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
867 
+			// config already exists, so pass it back
868 
+			return $this->{$section}->{$name};
869 
+		}
870 
+		// load config option from db if it exists
871 
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
872 
+		// verify the newly retrieved config object, but suppress errors
873 
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
874 
+			// config is good, so set it and pass it back
875 
+			$this->{$section}->{$name} = $config_obj;
876 
+			return $this->{$section}->{$name};
877 
+		}
878 
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
879 
+		$config_obj = $this->set_config($section, $name, $config_class);
880 
+		// verify the newly created config object
881 
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
882 
+			return $this->{$section}->{$name};
883 
+		} else {
884 
+			EE_Error::add_error(
885 
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
886 
+				__FILE__,
887 
+				__FUNCTION__,
888 
+				__LINE__
889 
+			);
890 
+		}
891 
+		return null;
892 
+	}
893 
+
894 
+
895 
+	/**
896 
+	 *    get_config_option
897 
+	 *
898 
+	 * @access    public
899 
+	 * @param    string $config_option_name
900 
+	 * @return    mixed EE_Config_Base | FALSE
901 
+	 */
902 
+	public function get_config_option($config_option_name = '')
903 
+	{
904 
+		// retrieve the wp-option for this config class.
905 
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
906 
+		if (empty($config_option)) {
907 
+			EE_Config::log($config_option_name . '-NOT-FOUND');
908 
+		}
909 
+		return $config_option;
910 
+	}
911 
+
912 
+
913 
+	/**
914 
+	 * log
915 
+	 *
916 
+	 * @param string $config_option_name
917 
+	 */
918 
+	public static function log($config_option_name = '')
919 
+	{
920 
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
921 
+			$config_log = get_option(EE_Config::LOG_NAME, array());
922 
+			// copy incoming $_REQUEST and sanitize it so we can save it
923 
+			$_request = $_REQUEST;
924 
+			array_walk_recursive($_request, 'sanitize_text_field');
925 
+			$config_log[ (string) microtime(true) ] = array(
926 
+				'config_name' => $config_option_name,
927 
+				'request'     => $_request,
928 
+			);
929 
+			update_option(EE_Config::LOG_NAME, $config_log);
930 
+		}
931 
+	}
932 
+
933 
+
934 
+	/**
935 
+	 * trim_log
936 
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
937 
+	 */
938 
+	public static function trim_log()
939 
+	{
940 
+		if (! EE_Config::logging_enabled()) {
941 
+			return;
942 
+		}
943 
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
944 
+		$log_length = count($config_log);
945 
+		if ($log_length > EE_Config::LOG_LENGTH) {
946 
+			ksort($config_log);
947 
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
948 
+			update_option(EE_Config::LOG_NAME, $config_log);
949 
+		}
950 
+	}
951 
+
952 
+
953 
+	/**
954 
+	 *    get_page_for_posts
955 
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
956 
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
957 
+	 *
958 
+	 * @access    public
959 
+	 * @return    string
960 
+	 */
961 
+	public static function get_page_for_posts()
962 
+	{
963 
+		$page_for_posts = get_option('page_for_posts');
964 
+		if (! $page_for_posts) {
965 
+			return 'posts';
966 
+		}
967 
+		/** @type WPDB $wpdb */
968 
+		global $wpdb;
969 
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
970 
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
971 
+	}
972 
+
973 
+
974 
+	/**
975 
+	 *    register_shortcodes_and_modules.
976 
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
977 
+	 *    In fact, this is where we give modules a chance to let core know they exist
978 
+	 *    so they can help trigger maintenance mode if it's needed
979 
+	 *
980 
+	 * @access    public
981 
+	 * @return    void
982 
+	 */
983 
+	public function register_shortcodes_and_modules()
984 
+	{
985 
+		// allow modules to set hooks for the rest of the system
986 
+		EE_Registry::instance()->modules = $this->_register_modules();
987 
+	}
988 
+
989 
+
990 
+	/**
991 
+	 *    initialize_shortcodes_and_modules
992 
+	 *    meaning they can start adding their hooks to get stuff done
993 
+	 *
994 
+	 * @access    public
995 
+	 * @return    void
996 
+	 */
997 
+	public function initialize_shortcodes_and_modules()
998 
+	{
999 
+		// allow modules to set hooks for the rest of the system
1000 
+		$this->_initialize_modules();
1001 
+	}
1002 
+
1003 
+
1004 
+	/**
1005 
+	 *    widgets_init
1006 
+	 *
1007 
+	 * @access private
1008 
+	 * @return void
1009 
+	 */
1010 
+	public function widgets_init()
1011 
+	{
1012 
+		// only init widgets on admin pages when not in complete maintenance, and
1013 
+		// on frontend when not in any maintenance mode
1014 
+		if (! EE_Maintenance_Mode::instance()->level()
1015 
+			|| (
1016 
+				is_admin()
1017 
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
1018 
+			)
1019 
+		) {
1020 
+			// grab list of installed widgets
1021 
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
1022 
+			// filter list of modules to register
1023 
+			$widgets_to_register = apply_filters(
1024 
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
1025 
+				$widgets_to_register
1026 
+			);
1027 
+			if (! empty($widgets_to_register)) {
1028 
+				// cycle thru widget folders
1029 
+				foreach ($widgets_to_register as $widget_path) {
1030 
+					// add to list of installed widget modules
1031 
+					EE_Config::register_ee_widget($widget_path);
1032 
+				}
1033 
+			}
1034 
+			// filter list of installed modules
1035 
+			EE_Registry::instance()->widgets = apply_filters(
1036 
+				'FHEE__EE_Config__register_widgets__installed_widgets',
1037 
+				EE_Registry::instance()->widgets
1038 
+			);
1039 
+		}
1040 
+	}
1041 
+
1042 
+
1043 
+	/**
1044 
+	 *    register_ee_widget - makes core aware of this widget
1045 
+	 *
1046 
+	 * @access    public
1047 
+	 * @param    string $widget_path - full path up to and including widget folder
1048 
+	 * @return    void
1049 
+	 */
1050 
+	public static function register_ee_widget($widget_path = null)
1051 
+	{
1052 
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
1053 
+		$widget_ext = '.widget.php';
1054 
+		// make all separators match
1055 
+		$widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
1056 
+		// does the file path INCLUDE the actual file name as part of the path ?
1057 
+		if (strpos($widget_path, $widget_ext) !== false) {
1058 
+			// grab and shortcode file name from directory name and break apart at dots
1059 
+			$file_name = explode('.', basename($widget_path));
1060 
+			// take first segment from file name pieces and remove class prefix if it exists
1061 
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
1062 
+			// sanitize shortcode directory name
1063 
+			$widget = sanitize_key($widget);
1064 
+			// now we need to rebuild the shortcode path
1065 
+			$widget_path = explode(DS, $widget_path);
1066 
+			// remove last segment
1067 
+			array_pop($widget_path);
1068 
+			// glue it back together
1069 
+			$widget_path = implode(DS, $widget_path);
1070 
+		} else {
1071 
+			// grab and sanitize widget directory name
1072 
+			$widget = sanitize_key(basename($widget_path));
1073 
+		}
1074 
+		// create classname from widget directory name
1075 
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
1076 
+		// add class prefix
1077 
+		$widget_class = 'EEW_' . $widget;
1078 
+		// does the widget exist ?
1079 
+		if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
1080 
+			$msg = sprintf(
1081 
+				__(
1082 
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
1083 
+					'event_espresso'
1084 
+				),
1085 
+				$widget_class,
1086 
+				$widget_path . DS . $widget_class . $widget_ext
1087 
+			);
1088 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1089 
+			return;
1090 
+		}
1091 
+		// load the widget class file
1092 
+		require_once($widget_path . DS . $widget_class . $widget_ext);
1093 
+		// verify that class exists
1094 
+		if (! class_exists($widget_class)) {
1095 
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
1096 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1097 
+			return;
1098 
+		}
1099 
+		register_widget($widget_class);
1100 
+		// add to array of registered widgets
1101 
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
1102 
+	}
1103 
+
1104 
+
1105 
+	/**
1106 
+	 *        _register_modules
1107 
+	 *
1108 
+	 * @access private
1109 
+	 * @return array
1110 
+	 */
1111 
+	private function _register_modules()
1112 
+	{
1113 
+		// grab list of installed modules
1114 
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
1115 
+		// filter list of modules to register
1116 
+		$modules_to_register = apply_filters(
1117 
+			'FHEE__EE_Config__register_modules__modules_to_register',
1118 
+			$modules_to_register
1119 
+		);
1120 
+		if (! empty($modules_to_register)) {
1121 
+			// loop through folders
1122 
+			foreach ($modules_to_register as $module_path) {
1123 
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
1124 
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
1125 
+					&& $module_path !== EE_MODULES . 'gateways'
1126 
+				) {
1127 
+					// add to list of installed modules
1128 
+					EE_Config::register_module($module_path);
1129 
+				}
1130 
+			}
1131 
+		}
1132 
+		// filter list of installed modules
1133 
+		return apply_filters(
1134 
+			'FHEE__EE_Config___register_modules__installed_modules',
1135 
+			EE_Registry::instance()->modules
1136 
+		);
1137 
+	}
1138 
+
1139 
+
1140 
+	/**
1141 
+	 *    register_module - makes core aware of this module
1142 
+	 *
1143 
+	 * @access    public
1144 
+	 * @param    string $module_path - full path up to and including module folder
1145 
+	 * @return    bool
1146 
+	 */
1147 
+	public static function register_module($module_path = null)
1148 
+	{
1149 
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
1150 
+		$module_ext = '.module.php';
1151 
+		// make all separators match
1152 
+		$module_path = str_replace(array('\\', '/'), DS, $module_path);
1153 
+		// does the file path INCLUDE the actual file name as part of the path ?
1154 
+		if (strpos($module_path, $module_ext) !== false) {
1155 
+			// grab and shortcode file name from directory name and break apart at dots
1156 
+			$module_file = explode('.', basename($module_path));
1157 
+			// now we need to rebuild the shortcode path
1158 
+			$module_path = explode(DS, $module_path);
1159 
+			// remove last segment
1160 
+			array_pop($module_path);
1161 
+			// glue it back together
1162 
+			$module_path = implode(DS, $module_path) . DS;
1163 
+			// take first segment from file name pieces and sanitize it
1164 
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
1165 
+			// ensure class prefix is added
1166 
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
1167 
+		} else {
1168 
+			// we need to generate the filename based off of the folder name
1169 
+			// grab and sanitize module name
1170 
+			$module = strtolower(basename($module_path));
1171 
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
1172 
+			// like trailingslashit()
1173 
+			$module_path = rtrim($module_path, DS) . DS;
1174 
+			// create classname from module directory name
1175 
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
1176 
+			// add class prefix
1177 
+			$module_class = 'EED_' . $module;
1178 
+		}
1179 
+		// does the module exist ?
1180 
+		if (! is_readable($module_path . DS . $module_class . $module_ext)) {
1181 
+			$msg = sprintf(
1182 
+				__(
1183 
+					'The requested %s module file could not be found or is not readable due to file permissions.',
1184 
+					'event_espresso'
1185 
+				),
1186 
+				$module
1187 
+			);
1188 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1189 
+			return false;
1190 
+		}
1191 
+		// load the module class file
1192 
+		require_once($module_path . $module_class . $module_ext);
1193 
+		// verify that class exists
1194 
+		if (! class_exists($module_class)) {
1195 
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
1196 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1197 
+			return false;
1198 
+		}
1199 
+		// add to array of registered modules
1200 
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
1201 
+		do_action(
1202 
+			'AHEE__EE_Config__register_module__complete',
1203 
+			$module_class,
1204 
+			EE_Registry::instance()->modules->{$module_class}
1205 
+		);
1206 
+		return true;
1207 
+	}
1208 
+
1209 
+
1210 
+	/**
1211 
+	 *    _initialize_modules
1212 
+	 *    allow modules to set hooks for the rest of the system
1213 
+	 *
1214 
+	 * @access private
1215 
+	 * @return void
1216 
+	 */
1217 
+	private function _initialize_modules()
1218 
+	{
1219 
+		// cycle thru shortcode folders
1220 
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
1221 
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
1222 
+			// which set hooks ?
1223 
+			if (is_admin()) {
1224 
+				// fire immediately
1225 
+				call_user_func(array($module_class, 'set_hooks_admin'));
1226 
+			} else {
1227 
+				// delay until other systems are online
1228 
+				add_action(
1229 
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
1230 
+					array($module_class, 'set_hooks')
1231 
+				);
1232 
+			}
1233 
+		}
1234 
+	}
1235 
+
1236 
+
1237 
+	/**
1238 
+	 *    register_route - adds module method routes to route_map
1239 
+	 *
1240 
+	 * @access    public
1241 
+	 * @param    string $route       - "pretty" public alias for module method
1242 
+	 * @param    string $module      - module name (classname without EED_ prefix)
1243 
+	 * @param    string $method_name - the actual module method to be routed to
1244 
+	 * @param    string $key         - url param key indicating a route is being called
1245 
+	 * @return    bool
1246 
+	 */
1247 
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
1248 
+	{
1249 
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
1250 
+		$module = str_replace('EED_', '', $module);
1251 
+		$module_class = 'EED_' . $module;
1252 
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
1253 
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
1254 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1255 
+			return false;
1256 
+		}
1257 
+		if (empty($route)) {
1258 
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
1259 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1260 
+			return false;
1261 
+		}
1262 
+		if (! method_exists('EED_' . $module, $method_name)) {
1263 
+			$msg = sprintf(
1264 
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
1265 
+				$route
1266 
+			);
1267 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1268 
+			return false;
1269 
+		}
1270 
+		EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
1271 
+		return true;
1272 
+	}
1273 
+
1274 
+
1275 
+	/**
1276 
+	 *    get_route - get module method route
1277 
+	 *
1278 
+	 * @access    public
1279 
+	 * @param    string $route - "pretty" public alias for module method
1280 
+	 * @param    string $key   - url param key indicating a route is being called
1281 
+	 * @return    string
1282 
+	 */
1283 
+	public static function get_route($route = null, $key = 'ee')
1284 
+	{
1285 
+		do_action('AHEE__EE_Config__get_route__begin', $route);
1286 
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
1287 
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
1288 
+			return EE_Config::$_module_route_map[ $key ][ $route ];
1289 
+		}
1290 
+		return null;
1291 
+	}
1292 
+
1293 
+
1294 
+	/**
1295 
+	 *    get_routes - get ALL module method routes
1296 
+	 *
1297 
+	 * @access    public
1298 
+	 * @return    array
1299 
+	 */
1300 
+	public static function get_routes()
1301 
+	{
1302 
+		return EE_Config::$_module_route_map;
1303 
+	}
1304 
+
1305 
+
1306 
+	/**
1307 
+	 *    register_forward - allows modules to forward request to another module for further processing
1308 
+	 *
1309 
+	 * @access    public
1310 
+	 * @param    string       $route   - "pretty" public alias for module method
1311 
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
1312 
+	 *                                 class, allows different forwards to be served based on status
1313 
+	 * @param    array|string $forward - function name or array( class, method )
1314 
+	 * @param    string       $key     - url param key indicating a route is being called
1315 
+	 * @return    bool
1316 
+	 */
1317 
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
1318 
+	{
1319 
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
1320 
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1321 
+			$msg = sprintf(
1322 
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
1323 
+				$route
1324 
+			);
1325 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1326 
+			return false;
1327 
+		}
1328 
+		if (empty($forward)) {
1329 
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
1330 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1331 
+			return false;
1332 
+		}
1333 
+		if (is_array($forward)) {
1334 
+			if (! isset($forward[1])) {
1335 
+				$msg = sprintf(
1336 
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
1337 
+					$route
1338 
+				);
1339 
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1340 
+				return false;
1341 
+			}
1342 
+			if (! method_exists($forward[0], $forward[1])) {
1343 
+				$msg = sprintf(
1344 
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
1345 
+					$forward[1],
1346 
+					$route
1347 
+				);
1348 
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1349 
+				return false;
1350 
+			}
1351 
+		} elseif (! function_exists($forward)) {
1352 
+			$msg = sprintf(
1353 
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
1354 
+				$forward,
1355 
+				$route
1356 
+			);
1357 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1358 
+			return false;
1359 
+		}
1360 
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
1361 
+		return true;
1362 
+	}
1363 
+
1364 
+
1365 
+	/**
1366 
+	 *    get_forward - get forwarding route
1367 
+	 *
1368 
+	 * @access    public
1369 
+	 * @param    string  $route  - "pretty" public alias for module method
1370 
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1371 
+	 *                           allows different forwards to be served based on status
1372 
+	 * @param    string  $key    - url param key indicating a route is being called
1373 
+	 * @return    string
1374 
+	 */
1375 
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
1376 
+	{
1377 
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
1378 
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
1379 
+			return apply_filters(
1380 
+				'FHEE__EE_Config__get_forward',
1381 
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
1382 
+				$route,
1383 
+				$status
1384 
+			);
1385 
+		}
1386 
+		return null;
1387 
+	}
1388 
+
1389 
+
1390 
+	/**
1391 
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
1392 
+	 *    results
1393 
+	 *
1394 
+	 * @access    public
1395 
+	 * @param    string  $route  - "pretty" public alias for module method
1396 
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1397 
+	 *                           allows different views to be served based on status
1398 
+	 * @param    string  $view
1399 
+	 * @param    string  $key    - url param key indicating a route is being called
1400 
+	 * @return    bool
1401 
+	 */
1402 
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
1403 
+	{
1404 
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
1405 
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1406 
+			$msg = sprintf(
1407 
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
1408 
+				$route
1409 
+			);
1410 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1411 
+			return false;
1412 
+		}
1413 
+		if (! is_readable($view)) {
1414 
+			$msg = sprintf(
1415 
+				__(
1416 
+					'The %s view file could not be found or is not readable due to file permissions.',
1417 
+					'event_espresso'
1418 
+				),
1419 
+				$view
1420 
+			);
1421 
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1422 
+			return false;
1423 
+		}
1424 
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
1425 
+		return true;
1426 
+	}
1427 
+
1428 
+
1429 
+	/**
1430 
+	 *    get_view - get view for route and status
1431 
+	 *
1432 
+	 * @access    public
1433 
+	 * @param    string  $route  - "pretty" public alias for module method
1434 
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
1435 
+	 *                           allows different views to be served based on status
1436 
+	 * @param    string  $key    - url param key indicating a route is being called
1437 
+	 * @return    string
1438 
+	 */
1439 
+	public static function get_view($route = null, $status = 0, $key = 'ee')
1440 
+	{
1441 
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
1442 
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
1443 
+			return apply_filters(
1444 
+				'FHEE__EE_Config__get_view',
1445 
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
1446 
+				$route,
1447 
+				$status
1448 
+			);
1449 
+		}
1450 
+		return null;
1451 
+	}
1452 
+
1453 
+
1454 
+	public function update_addon_option_names()
1455 
+	{
1456 
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
1457 
+	}
1458 
+
1459 
+
1460 
+	public function shutdown()
1461 
+	{
1462 
+		$this->update_addon_option_names();
1463 
+	}
1464 
+
1465 
+
1466 
+	/**
1467 
+	 * @return LegacyShortcodesManager
1468 
+	 */
1469 
+	public static function getLegacyShortcodesManager()
1470 
+	{
1471 
+
1472 
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1473 
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
1474 
+				EE_Registry::instance()
1475 
+			);
1476 
+		}
1477 
+		return EE_Config::instance()->legacy_shortcodes_manager;
1478 
+	}
1479 
+
1480 
+
1481 
+	/**
1482 
+	 * register_shortcode - makes core aware of this shortcode
1483 
+	 *
1484 
+	 * @deprecated 4.9.26
1485 
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
1486 
+	 * @return    bool
1487 
+	 */
1488 
+	public static function register_shortcode($shortcode_path = null)
1489 
+	{
1490 
+		EE_Error::doing_it_wrong(
1491 
+			__METHOD__,
1492 
+			__(
1493 
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
1494 
+				'event_espresso'
1495 
+			),
1496 
+			'4.9.26'
1497 
+		);
1498 
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
1499 
+	}
1500 
+}
2262 1501
2263 
-    /**
2264 
-     * ReCaptcha Type
2265 
-     *
2266 
-     * @var string $recaptcha_type
2267 
-     *    options: 'audio', 'image'
2268 
-     */
2269 
-    public $recaptcha_type;
1502 
+/**
1503 
+ * Base class used for config classes. These classes should generally not have
1504 
+ * magic functions in use, except we'll allow them to magically set and get stuff...
1505 
+ * basically, they should just be well-defined stdClasses
1506 
+ */
1507 
+class EE_Config_Base
1508 
+{
2270 1509
2271 
-    /**
2272 
-     * ReCaptcha language
2273 
-     *
2274 
-     * @var string $recaptcha_language
2275 
-     * eg 'en'
2276 
-     */
2277 
-    public $recaptcha_language;
1510 
+	/**
1511 
+	 * Utility function for escaping the value of a property and returning.
1512 
+	 *
1513 
+	 * @param string $property property name (checks to see if exists).
1514 
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1515 
+	 * @throws \EE_Error
1516 
+	 */
1517 
+	public function get_pretty($property)
1518 
+	{
1519 
+		if (! property_exists($this, $property)) {
1520 
+			throw new EE_Error(
1521 
+				sprintf(
1522 
+					__(
1523 
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
1524 
+						'event_espresso'
1525 
+					),
1526 
+					get_class($this),
1527 
+					$property
1528 
+				)
1529 
+			);
1530 
+		}
1531 
+		// just handling escaping of strings for now.
1532 
+		if (is_string($this->{$property})) {
1533 
+			return stripslashes($this->{$property});
1534 
+		}
1535 
+		return $this->{$property};
1536 
+	}
1537 
+
1538 
+
1539 
+	public function populate()
1540 
+	{
1541 
+		// grab defaults via a new instance of this class.
1542 
+		$class_name = get_class($this);
1543 
+		$defaults = new $class_name;
1544 
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
1545 
+		// default from our $defaults object.
1546 
+		foreach (get_object_vars($defaults) as $property => $value) {
1547 
+			if ($this->{$property} === null) {
1548 
+				$this->{$property} = $value;
1549 
+			}
1550 
+		}
1551 
+		// cleanup
1552 
+		unset($defaults);
1553 
+	}
1554 
+
1555 
+
1556 
+	/**
1557 
+	 *        __isset
1558 
+	 *
1559 
+	 * @param $a
1560 
+	 * @return bool
1561 
+	 */
1562 
+	public function __isset($a)
1563 
+	{
1564 
+		return false;
1565 
+	}
1566 
+
1567 
+
1568 
+	/**
1569 
+	 *        __unset
1570 
+	 *
1571 
+	 * @param $a
1572 
+	 * @return bool
1573 
+	 */
1574 
+	public function __unset($a)
1575 
+	{
1576 
+		return false;
1577 
+	}
1578 
+
1579 
+
1580 
+	/**
1581 
+	 *        __clone
1582 
+	 */
1583 
+	public function __clone()
1584 
+	{
1585 
+	}
1586 
+
1587 
+
1588 
+	/**
1589 
+	 *        __wakeup
1590 
+	 */
1591 
+	public function __wakeup()
1592 
+	{
1593 
+	}
1594 
+
1595 
+
1596 
+	/**
1597 
+	 *        __destruct
1598 
+	 */
1599 
+	public function __destruct()
1600 
+	{
1601 
+	}
1602 
+}
2278 1603
2279 
-    /**
2280 
-     * ReCaptcha public key
2281 
-     *
2282 
-     * @var string $recaptcha_publickey
2283 
-     */
2284 
-    public $recaptcha_publickey;
1604 
+/**
1605 
+ * Class for defining what's in the EE_Config relating to registration settings
1606 
+ */
1607 
+class EE_Core_Config extends EE_Config_Base
1608 
+{
2285 1609
2286 
-    /**
2287 
-     * ReCaptcha private key
2288 
-     *
2289 
-     * @var string $recaptcha_privatekey
2290 
-     */
2291 
-    public $recaptcha_privatekey;
1610 
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
1611 
+
1612 
+
1613 
+	public $current_blog_id;
1614 
+
1615 
+	public $ee_ueip_optin;
1616 
+
1617 
+	public $ee_ueip_has_notified;
1618 
+
1619 
+	/**
1620 
+	 * Not to be confused with the 4 critical page variables (See
1621 
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
1622 
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
1623 
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
1624 
+	 *
1625 
+	 * @var array
1626 
+	 */
1627 
+	public $post_shortcodes;
1628 
+
1629 
+	public $module_route_map;
1630 
+
1631 
+	public $module_forward_map;
1632 
+
1633 
+	public $module_view_map;
1634 
+
1635 
+	/**
1636 
+	 * The next 4 vars are the IDs of critical EE pages.
1637 
+	 *
1638 
+	 * @var int
1639 
+	 */
1640 
+	public $reg_page_id;
1641 
+
1642 
+	public $txn_page_id;
1643 
+
1644 
+	public $thank_you_page_id;
1645 
+
1646 
+	public $cancel_page_id;
1647 
+
1648 
+	/**
1649 
+	 * The next 4 vars are the URLs of critical EE pages.
1650 
+	 *
1651 
+	 * @var int
1652 
+	 */
1653 
+	public $reg_page_url;
1654 
+
1655 
+	public $txn_page_url;
1656 
+
1657 
+	public $thank_you_page_url;
1658 
+
1659 
+	public $cancel_page_url;
1660 
+
1661 
+	/**
1662 
+	 * The next vars relate to the custom slugs for EE CPT routes
1663 
+	 */
1664 
+	public $event_cpt_slug;
1665 
+
1666 
+	/**
1667 
+	 * This caches the _ee_ueip_option in case this config is reset in the same
1668 
+	 * request across blog switches in a multisite context.
1669 
+	 * Avoids extra queries to the db for this option.
1670 
+	 *
1671 
+	 * @var bool
1672 
+	 */
1673 
+	public static $ee_ueip_option;
1674 
+
1675 
+
1676 
+	/**
1677 
+	 *    class constructor
1678 
+	 *
1679 
+	 * @access    public
1680 
+	 */
1681 
+	public function __construct()
1682 
+	{
1683 
+		// set default organization settings
1684 
+		$this->current_blog_id = get_current_blog_id();
1685 
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
1686 
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
1687 
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
1688 
+		$this->post_shortcodes = array();
1689 
+		$this->module_route_map = array();
1690 
+		$this->module_forward_map = array();
1691 
+		$this->module_view_map = array();
1692 
+		// critical EE page IDs
1693 
+		$this->reg_page_id = 0;
1694 
+		$this->txn_page_id = 0;
1695 
+		$this->thank_you_page_id = 0;
1696 
+		$this->cancel_page_id = 0;
1697 
+		// critical EE page URLs
1698 
+		$this->reg_page_url = '';
1699 
+		$this->txn_page_url = '';
1700 
+		$this->thank_you_page_url = '';
1701 
+		$this->cancel_page_url = '';
1702 
+		// cpt slugs
1703 
+		$this->event_cpt_slug = __('events', 'event_espresso');
1704 
+		// ueip constant check
1705 
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
1706 
+			$this->ee_ueip_optin = false;
1707 
+			$this->ee_ueip_has_notified = true;
1708 
+		}
1709 
+	}
1710 
+
1711 
+
1712 
+	/**
1713 
+	 * @return array
1714 
+	 */
1715 
+	public function get_critical_pages_array()
1716 
+	{
1717 
+		return array(
1718 
+			$this->reg_page_id,
1719 
+			$this->txn_page_id,
1720 
+			$this->thank_you_page_id,
1721 
+			$this->cancel_page_id,
1722 
+		);
1723 
+	}
1724 
+
1725 
+
1726 
+	/**
1727 
+	 * @return array
1728 
+	 */
1729 
+	public function get_critical_pages_shortcodes_array()
1730 
+	{
1731 
+		return array(
1732 
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
1733 
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
1734 
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
1735 
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
1736 
+		);
1737 
+	}
1738 
+
1739 
+
1740 
+	/**
1741 
+	 *  gets/returns URL for EE reg_page
1742 
+	 *
1743 
+	 * @access    public
1744 
+	 * @return    string
1745 
+	 */
1746 
+	public function reg_page_url()
1747 
+	{
1748 
+		if (! $this->reg_page_url) {
1749 
+			$this->reg_page_url = add_query_arg(
1750 
+				array('uts' => time()),
1751 
+				get_permalink($this->reg_page_id)
1752 
+			) . '#checkout';
1753 
+		}
1754 
+		return $this->reg_page_url;
1755 
+	}
1756 
+
1757 
+
1758 
+	/**
1759 
+	 *  gets/returns URL for EE txn_page
1760 
+	 *
1761 
+	 * @param array $query_args like what gets passed to
1762 
+	 *                          add_query_arg() as the first argument
1763 
+	 * @access    public
1764 
+	 * @return    string
1765 
+	 */
1766 
+	public function txn_page_url($query_args = array())
1767 
+	{
1768 
+		if (! $this->txn_page_url) {
1769 
+			$this->txn_page_url = get_permalink($this->txn_page_id);
1770 
+		}
1771 
+		if ($query_args) {
1772 
+			return add_query_arg($query_args, $this->txn_page_url);
1773 
+		} else {
1774 
+			return $this->txn_page_url;
1775 
+		}
1776 
+	}
1777 
+
1778 
+
1779 
+	/**
1780 
+	 *  gets/returns URL for EE thank_you_page
1781 
+	 *
1782 
+	 * @param array $query_args like what gets passed to
1783 
+	 *                          add_query_arg() as the first argument
1784 
+	 * @access    public
1785 
+	 * @return    string
1786 
+	 */
1787 
+	public function thank_you_page_url($query_args = array())
1788 
+	{
1789 
+		if (! $this->thank_you_page_url) {
1790 
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
1791 
+		}
1792 
+		if ($query_args) {
1793 
+			return add_query_arg($query_args, $this->thank_you_page_url);
1794 
+		} else {
1795 
+			return $this->thank_you_page_url;
1796 
+		}
1797 
+	}
1798 
+
1799 
+
1800 
+	/**
1801 
+	 *  gets/returns URL for EE cancel_page
1802 
+	 *
1803 
+	 * @access    public
1804 
+	 * @return    string
1805 
+	 */
1806 
+	public function cancel_page_url()
1807 
+	{
1808 
+		if (! $this->cancel_page_url) {
1809 
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
1810 
+		}
1811 
+		return $this->cancel_page_url;
1812 
+	}
1813 
+
1814 
+
1815 
+	/**
1816 
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
1817 
+	 *
1818 
+	 * @since 4.7.5
1819 
+	 */
1820 
+	protected function _reset_urls()
1821 
+	{
1822 
+		$this->reg_page_url = '';
1823 
+		$this->txn_page_url = '';
1824 
+		$this->cancel_page_url = '';
1825 
+		$this->thank_you_page_url = '';
1826 
+	}
1827 
+
1828 
+
1829 
+	/**
1830 
+	 * Used to return what the optin value is set for the EE User Experience Program.
1831 
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
1832 
+	 * on the main site only.
1833 
+	 *
1834 
+	 * @return bool
1835 
+	 */
1836 
+	protected function _get_main_ee_ueip_optin()
1837 
+	{
1838 
+		// if this is the main site then we can just bypass our direct query.
1839 
+		if (is_main_site()) {
1840 
+			return get_option(self::OPTION_NAME_UXIP, false);
1841 
+		}
1842 
+		// is this already cached for this request?  If so use it.
1843 
+		if (EE_Core_Config::$ee_ueip_option !== null) {
1844 
+			return EE_Core_Config::$ee_ueip_option;
1845 
+		}
1846 
+		global $wpdb;
1847 
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
1848 
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
1849 
+		$option = self::OPTION_NAME_UXIP;
1850 
+		// set correct table for query
1851 
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
1852 
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
1853 
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
1854 
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
1855 
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
1856 
+		// for the purpose of caching.
1857 
+		$pre = apply_filters('pre_option_' . $option, false, $option);
1858 
+		if (false !== $pre) {
1859 
+			EE_Core_Config::$ee_ueip_option = $pre;
1860 
+			return EE_Core_Config::$ee_ueip_option;
1861 
+		}
1862 
+		$row = $wpdb->get_row(
1863 
+			$wpdb->prepare(
1864 
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
1865 
+				$option
1866 
+			)
1867 
+		);
1868 
+		if (is_object($row)) {
1869 
+			$value = $row->option_value;
1870 
+		} else { // option does not exist so use default.
1871 
+			EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
1872 
+			return EE_Core_Config::$ee_ueip_option;
1873 
+		}
1874 
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
1875 
+		return EE_Core_Config::$ee_ueip_option;
1876 
+	}
1877 
+
1878 
+
1879 
+	/**
1880 
+	 * Utility function for escaping the value of a property and returning.
1881 
+	 *
1882 
+	 * @param string $property property name (checks to see if exists).
1883 
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
1884 
+	 * @throws \EE_Error
1885 
+	 */
1886 
+	public function get_pretty($property)
1887 
+	{
1888 
+		if ($property === self::OPTION_NAME_UXIP) {
1889 
+			return $this->ee_ueip_optin ? 'yes' : 'no';
1890 
+		}
1891 
+		return parent::get_pretty($property);
1892 
+	}
1893 
+
1894 
+
1895 
+	/**
1896 
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
1897 
+	 * on the object.
1898 
+	 *
1899 
+	 * @return array
1900 
+	 */
1901 
+	public function __sleep()
1902 
+	{
1903 
+		// reset all url properties
1904 
+		$this->_reset_urls();
1905 
+		// return what to save to db
1906 
+		return array_keys(get_object_vars($this));
1907 
+	}
1908 
+}
2292 1909
2293 
-    /**
2294 
-     * array of form names protected by ReCaptcha
2295 
-     *
2296 
-     * @var array $recaptcha_protected_forms
2297 
-     */
2298 
-    public $recaptcha_protected_forms;
1910 
+/**
1911 
+ * Config class for storing info on the Organization
1912 
+ */
1913 
+class EE_Organization_Config extends EE_Config_Base
1914 
+{
2299 1915
2300 
-    /**
2301 
-     * ReCaptcha width
2302 
-     *
2303 
-     * @var int $recaptcha_width
2304 
-     * @deprecated
2305 
-     */
2306 
-    public $recaptcha_width;
1916 
+	/**
1917 
+	 * @var string $name
1918 
+	 * eg EE4.1
1919 
+	 */
1920 
+	public $name;
1921 
+
1922 
+	/**
1923 
+	 * @var string $address_1
1924 
+	 * eg 123 Onna Road
1925 
+	 */
1926 
+	public $address_1 = '';
1927 
+
1928 
+	/**
1929 
+	 * @var string $address_2
1930 
+	 * eg PO Box 123
1931 
+	 */
1932 
+	public $address_2 = '';
1933 
+
1934 
+	/**
1935 
+	 * @var string $city
1936 
+	 * eg Inna City
1937 
+	 */
1938 
+	public $city = '';
1939 
+
1940 
+	/**
1941 
+	 * @var int $STA_ID
1942 
+	 * eg 4
1943 
+	 */
1944 
+	public $STA_ID = 0;
1945 
+
1946 
+	/**
1947 
+	 * @var string $CNT_ISO
1948 
+	 * eg US
1949 
+	 */
1950 
+	public $CNT_ISO = '';
1951 
+
1952 
+	/**
1953 
+	 * @var string $zip
1954 
+	 * eg 12345  or V1A 2B3
1955 
+	 */
1956 
+	public $zip = '';
1957 
+
1958 
+	/**
1959 
+	 * @var string $email
1960 
+	 * eg [email protected]
1961 
+	 */
1962 
+	public $email;
1963 
+
1964 
+	/**
1965 
+	 * @var string $phone
1966 
+	 * eg. 111-111-1111
1967 
+	 */
1968 
+	public $phone = '';
1969 
+
1970 
+	/**
1971 
+	 * @var string $vat
1972 
+	 * VAT/Tax Number
1973 
+	 */
1974 
+	public $vat = '';
1975 
+
1976 
+	/**
1977 
+	 * @var string $logo_url
1978 
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
1979 
+	 */
1980 
+	public $logo_url = '';
1981 
+
1982 
+	/**
1983 
+	 * The below are all various properties for holding links to organization social network profiles
1984 
+	 *
1985 
+	 * @var string
1986 
+	 */
1987 
+	/**
1988 
+	 * facebook (facebook.com/profile.name)
1989 
+	 *
1990 
+	 * @var string
1991 
+	 */
1992 
+	public $facebook = '';
1993 
+
1994 
+	/**
1995 
+	 * twitter (twitter.com/twitter_handle)
1996 
+	 *
1997 
+	 * @var string
1998 
+	 */
1999 
+	public $twitter = '';
2000 
+
2001 
+	/**
2002 
+	 * linkedin (linkedin.com/in/profile_name)
2003 
+	 *
2004 
+	 * @var string
2005 
+	 */
2006 
+	public $linkedin = '';
2007 
+
2008 
+	/**
2009 
+	 * pinterest (www.pinterest.com/profile_name)
2010 
+	 *
2011 
+	 * @var string
2012 
+	 */
2013 
+	public $pinterest = '';
2014 
+
2015 
+	/**
2016 
+	 * google+ (google.com/+profileName)
2017 
+	 *
2018 
+	 * @var string
2019 
+	 */
2020 
+	public $google = '';
2021 
+
2022 
+	/**
2023 
+	 * instagram (instagram.com/handle)
2024 
+	 *
2025 
+	 * @var string
2026 
+	 */
2027 
+	public $instagram = '';
2028 
+
2029 
+
2030 
+	/**
2031 
+	 *    class constructor
2032 
+	 *
2033 
+	 * @access    public
2034 
+	 */
2035 
+	public function __construct()
2036 
+	{
2037 
+		// set default organization settings
2038 
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
2039 
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
2040 
+		$this->email = get_bloginfo('admin_email');
2041 
+	}
2042 
+}
2307 2043
2308 
-    /**
2309 
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
2310 
-     *
2311 
-     * @var boolean $track_invalid_checkout_access
2312 
-     */
2313 
-    protected $track_invalid_checkout_access = true;
2044 
+/**
2045 
+ * Class for defining what's in the EE_Config relating to currency
2046 
+ */
2047 
+class EE_Currency_Config extends EE_Config_Base
2048 
+{
2314 2049
2315 
-    /**
2316 
-     * Whether or not to show the privacy policy consent checkbox
2317 
-     *
2318 
-     * @var bool
2319 
-     */
2320 
-    public $consent_checkbox_enabled;
2050 
+	/**
2051 
+	 * @var string $code
2052 
+	 * eg 'US'
2053 
+	 */
2054 
+	public $code;
2055 
+
2056 
+	/**
2057 
+	 * @var string $name
2058 
+	 * eg 'Dollar'
2059 
+	 */
2060 
+	public $name;
2061 
+
2062 
+	/**
2063 
+	 * plural name
2064 
+	 *
2065 
+	 * @var string $plural
2066 
+	 * eg 'Dollars'
2067 
+	 */
2068 
+	public $plural;
2069 
+
2070 
+	/**
2071 
+	 * currency sign
2072 
+	 *
2073 
+	 * @var string $sign
2074 
+	 * eg '$'
2075 
+	 */
2076 
+	public $sign;
2077 
+
2078 
+	/**
2079 
+	 * Whether the currency sign should come before the number or not
2080 
+	 *
2081 
+	 * @var boolean $sign_b4
2082 
+	 */
2083 
+	public $sign_b4;
2084 
+
2085 
+	/**
2086 
+	 * How many digits should come after the decimal place
2087 
+	 *
2088 
+	 * @var int $dec_plc
2089 
+	 */
2090 
+	public $dec_plc;
2091 
+
2092 
+	/**
2093 
+	 * Symbol to use for decimal mark
2094 
+	 *
2095 
+	 * @var string $dec_mrk
2096 
+	 * eg '.'
2097 
+	 */
2098 
+	public $dec_mrk;
2099 
+
2100 
+	/**
2101 
+	 * Symbol to use for thousands
2102 
+	 *
2103 
+	 * @var string $thsnds
2104 
+	 * eg ','
2105 
+	 */
2106 
+	public $thsnds;
2107 
+
2108 
+
2109 
+	/**
2110 
+	 *    class constructor
2111 
+	 *
2112 
+	 * @access    public
2113 
+	 * @param string $CNT_ISO
2114 
+	 * @throws \EE_Error
2115 
+	 */
2116 
+	public function __construct($CNT_ISO = '')
2117 
+	{
2118 
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
2119 
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
2120 
+		// get country code from organization settings or use default
2121 
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
2122 
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
2123 
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
2124 
+			: '';
2125 
+		// but override if requested
2126 
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
2127 
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
2128 
+		if (! empty($CNT_ISO)
2129 
+			&& EE_Maintenance_Mode::instance()->models_can_query()
2130 
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
2131 
+		) {
2132 
+			// retrieve the country settings from the db, just in case they have been customized
2133 
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
2134 
+			if ($country instanceof EE_Country) {
2135 
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
2136 
+				$this->name = $country->currency_name_single();    // Dollar
2137 
+				$this->plural = $country->currency_name_plural();    // Dollars
2138 
+				$this->sign = $country->currency_sign();            // currency sign: $
2139 
+				$this->sign_b4 = $country->currency_sign_before(
2140 
+				);        // currency sign before or after: $TRUE  or  FALSE$
2141 
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
2142 
+				$this->dec_mrk = $country->currency_decimal_mark(
2143 
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2144 
+				$this->thsnds = $country->currency_thousands_separator(
2145 
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2146 
+			}
2147 
+		}
2148 
+		// fallback to hardcoded defaults, in case the above failed
2149 
+		if (empty($this->code)) {
2150 
+			// set default currency settings
2151 
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
2152 
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
2153 
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
2154 
+			$this->sign = '$';    // currency sign: $
2155 
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
2156 
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
2157 
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2158 
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2159 
+		}
2160 
+	}
2161 
+}
2321 2162
2322 
-    /**
2323 
-     * Label text to show on the checkbox
2324 
-     *
2325 
-     * @var string
2326 
-     */
2327 
-    public $consent_checkbox_label_text;
2163 
+/**
2164 
+ * Class for defining what's in the EE_Config relating to registration settings
2165 
+ */
2166 
+class EE_Registration_Config extends EE_Config_Base
2167 
+{
2328 2168
2329 
-    /*
2169 
+	/**
2170 
+	 * Default registration status
2171 
+	 *
2172 
+	 * @var string $default_STS_ID
2173 
+	 * eg 'RPP'
2174 
+	 */
2175 
+	public $default_STS_ID;
2176 
+
2177 
+	/**
2178 
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
2179 
+	 * registrations)
2180 
+	 *
2181 
+	 * @var int
2182 
+	 */
2183 
+	public $default_maximum_number_of_tickets;
2184 
+
2185 
+	/**
2186 
+	 * level of validation to apply to email addresses
2187 
+	 *
2188 
+	 * @var string $email_validation_level
2189 
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
2190 
+	 */
2191 
+	public $email_validation_level;
2192 
+
2193 
+	/**
2194 
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
2195 
+	 *
2196 
+	 * @var boolean $show_pending_payment_options
2197 
+	 */
2198 
+	public $show_pending_payment_options;
2199 
+
2200 
+	/**
2201 
+	 * Whether to skip the registration confirmation page
2202 
+	 *
2203 
+	 * @var boolean $skip_reg_confirmation
2204 
+	 */
2205 
+	public $skip_reg_confirmation;
2206 
+
2207 
+	/**
2208 
+	 * an array of SPCO reg steps where:
2209 
+	 *        the keys denotes the reg step order
2210 
+	 *        each element consists of an array with the following elements:
2211 
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
2212 
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
2213 
+	 *            "slug" => the URL param used to trigger the reg step
2214 
+	 *
2215 
+	 * @var array $reg_steps
2216 
+	 */
2217 
+	public $reg_steps;
2218 
+
2219 
+	/**
2220 
+	 * Whether registration confirmation should be the last page of SPCO
2221 
+	 *
2222 
+	 * @var boolean $reg_confirmation_last
2223 
+	 */
2224 
+	public $reg_confirmation_last;
2225 
+
2226 
+	/**
2227 
+	 * Whether or not to enable the EE Bot Trap
2228 
+	 *
2229 
+	 * @var boolean $use_bot_trap
2230 
+	 */
2231 
+	public $use_bot_trap;
2232 
+
2233 
+	/**
2234 
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
2235 
+	 *
2236 
+	 * @var boolean $use_encryption
2237 
+	 */
2238 
+	public $use_encryption;
2239 
+
2240 
+	/**
2241 
+	 * Whether or not to use ReCaptcha
2242 
+	 *
2243 
+	 * @var boolean $use_captcha
2244 
+	 */
2245 
+	public $use_captcha;
2246 
+
2247 
+	/**
2248 
+	 * ReCaptcha Theme
2249 
+	 *
2250 
+	 * @var string $recaptcha_theme
2251 
+	 *    options: 'dark', 'light', 'invisible'
2252 
+	 */
2253 
+	public $recaptcha_theme;
2254 
+
2255 
+	/**
2256 
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
2257 
+	 *
2258 
+	 * @var string $recaptcha_badge
2259 
+	 *    options: 'bottomright', 'bottomleft', 'inline'
2260 
+	 */
2261 
+	public $recaptcha_badge;
2262 
+
2263 
+	/**
2264 
+	 * ReCaptcha Type
2265 
+	 *
2266 
+	 * @var string $recaptcha_type
2267 
+	 *    options: 'audio', 'image'
2268 
+	 */
2269 
+	public $recaptcha_type;
2270 
+
2271 
+	/**
2272 
+	 * ReCaptcha language
2273 
+	 *
2274 
+	 * @var string $recaptcha_language
2275 
+	 * eg 'en'
2276 
+	 */
2277 
+	public $recaptcha_language;
2278 
+
2279 
+	/**
2280 
+	 * ReCaptcha public key
2281 
+	 *
2282 
+	 * @var string $recaptcha_publickey
2283 
+	 */
2284 
+	public $recaptcha_publickey;
2285 
+
2286 
+	/**
2287 
+	 * ReCaptcha private key
2288 
+	 *
2289 
+	 * @var string $recaptcha_privatekey
2290 
+	 */
2291 
+	public $recaptcha_privatekey;
2292 
+
2293 
+	/**
2294 
+	 * array of form names protected by ReCaptcha
2295 
+	 *
2296 
+	 * @var array $recaptcha_protected_forms
2297 
+	 */
2298 
+	public $recaptcha_protected_forms;
2299 
+
2300 
+	/**
2301 
+	 * ReCaptcha width
2302 
+	 *
2303 
+	 * @var int $recaptcha_width
2304 
+	 * @deprecated
2305 
+	 */
2306 
+	public $recaptcha_width;
2307 
+
2308 
+	/**
2309 
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
2310 
+	 *
2311 
+	 * @var boolean $track_invalid_checkout_access
2312 
+	 */
2313 
+	protected $track_invalid_checkout_access = true;
2314 
+
2315 
+	/**
2316 
+	 * Whether or not to show the privacy policy consent checkbox
2317 
+	 *
2318 
+	 * @var bool
2319 
+	 */
2320 
+	public $consent_checkbox_enabled;
2321 
+
2322 
+	/**
2323 
+	 * Label text to show on the checkbox
2324 
+	 *
2325 
+	 * @var string
2326 
+	 */
2327 
+	public $consent_checkbox_label_text;
2328 
+
2329 
+	/*
2330 2330 
      * String describing how long to keep payment logs. Passed into DateTime constructor
2331 2331 
      * @var string
2332 2332 
      */
2333 
-    public $gateway_log_lifespan = '1 week';
2334 
-
2335 
-
2336 
-    /**
2337 
-     *    class constructor
2338 
-     *
2339 
-     * @access    public
2340 
-     */
2341 
-    public function __construct()
2342 
-    {
2343 
-        // set default registration settings
2344 
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
2345 
-        $this->email_validation_level = 'wp_default';
2346 
-        $this->show_pending_payment_options = true;
2347 
-        $this->skip_reg_confirmation = true;
2348 
-        $this->reg_steps = array();
2349 
-        $this->reg_confirmation_last = false;
2350 
-        $this->use_bot_trap = true;
2351 
-        $this->use_encryption = true;
2352 
-        $this->use_captcha = false;
2353 
-        $this->recaptcha_theme = 'light';
2354 
-        $this->recaptcha_badge = 'bottomleft';
2355 
-        $this->recaptcha_type = 'image';
2356 
-        $this->recaptcha_language = 'en';
2357 
-        $this->recaptcha_publickey = null;
2358 
-        $this->recaptcha_privatekey = null;
2359 
-        $this->recaptcha_protected_forms = array();
2360 
-        $this->recaptcha_width = 500;
2361 
-        $this->default_maximum_number_of_tickets = 10;
2362 
-        $this->consent_checkbox_enabled = false;
2363 
-        $this->consent_checkbox_label_text = '';
2364 
-        $this->gateway_log_lifespan = '7 days';
2365 
-    }
2366 
-
2367 
-
2368 
-    /**
2369 
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
2370 
-     *
2371 
-     * @since 4.8.8.rc.019
2372 
-     */
2373 
-    public function do_hooks()
2374 
-    {
2375 
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
2376 
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
2377 
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
2378 
-    }
2379 
-
2380 
-
2381 
-    /**
2382 
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
2383 
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
2384 
-     */
2385 
-    public function set_default_reg_status_on_EEM_Event()
2386 
-    {
2387 
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
2388 
-    }
2389 
-
2390 
-
2391 
-    /**
2392 
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
2393 
-     * for Events matches the config setting for default_maximum_number_of_tickets
2394 
-     */
2395 
-    public function set_default_max_ticket_on_EEM_Event()
2396 
-    {
2397 
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
2398 
-    }
2399 
-
2400 
-
2401 
-    /**
2402 
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
2403 
-     * constructed because that happens before we can get the privacy policy page's permalink.
2404 
-     *
2405 
-     * @throws InvalidArgumentException
2406 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2407 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2408 
-     */
2409 
-    public function setDefaultCheckboxLabelText()
2410 
-    {
2411 
-        if ($this->getConsentCheckboxLabelText() === null
2412 
-            || $this->getConsentCheckboxLabelText() === '') {
2413 
-            $opening_a_tag = '';
2414 
-            $closing_a_tag = '';
2415 
-            if (function_exists('get_privacy_policy_url')) {
2416 
-                $privacy_page_url = get_privacy_policy_url();
2417 
-                if (! empty($privacy_page_url)) {
2418 
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
2419 
-                    $closing_a_tag = '</a>';
2420 
-                }
2421 
-            }
2422 
-            $loader = LoaderFactory::getLoader();
2423 
-            $org_config = $loader->getShared('EE_Organization_Config');
2424 
-            /**
2425 
-             * @var $org_config EE_Organization_Config
2426 
-             */
2427 
-
2428 
-            $this->setConsentCheckboxLabelText(
2429 
-                sprintf(
2430 
-                    esc_html__(
2431 
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
2432 
-                        'event_espresso'
2433 
-                    ),
2434 
-                    $org_config->name,
2435 
-                    $opening_a_tag,
2436 
-                    $closing_a_tag
2437 
-                )
2438 
-            );
2439 
-        }
2440 
-    }
2441 
-
2442 
-
2443 
-    /**
2444 
-     * @return boolean
2445 
-     */
2446 
-    public function track_invalid_checkout_access()
2447 
-    {
2448 
-        return $this->track_invalid_checkout_access;
2449 
-    }
2450 
-
2451 
-
2452 
-    /**
2453 
-     * @param boolean $track_invalid_checkout_access
2454 
-     */
2455 
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
2456 
-    {
2457 
-        $this->track_invalid_checkout_access = filter_var(
2458 
-            $track_invalid_checkout_access,
2459 
-            FILTER_VALIDATE_BOOLEAN
2460 
-        );
2461 
-    }
2462 
-
2463 
-
2464 
-    /**
2465 
-     * Gets the options to make availalbe for the gateway log lifespan
2466 
-     * @return array
2467 
-     */
2468 
-    public function gatewayLogLifespanOptions()
2469 
-    {
2470 
-        return (array) apply_filters(
2471 
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
2472 
-            array(
2473 
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
2474 
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
2475 
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
2476 
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
2477 
-                '30 days' => esc_html__('30 Days', 'event_espresso')
2478 
-            )
2479 
-        );
2480 
-    }
2481 
-
2482 
-
2483 
-    /**
2484 
-     * @return bool
2485 
-     */
2486 
-    public function isConsentCheckboxEnabled()
2487 
-    {
2488 
-        return $this->consent_checkbox_enabled;
2489 
-    }
2490 
-
2491 
-
2492 
-    /**
2493 
-     * @param bool $consent_checkbox_enabled
2494 
-     */
2495 
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
2496 
-    {
2497 
-        $this->consent_checkbox_enabled = filter_var(
2498 
-            $consent_checkbox_enabled,
2499 
-            FILTER_VALIDATE_BOOLEAN
2500 
-        );
2501 
-    }
2502 
-
2503 
-
2504 
-    /**
2505 
-     * @return string
2506 
-     */
2507 
-    public function getConsentCheckboxLabelText()
2508 
-    {
2509 
-        return $this->consent_checkbox_label_text;
2510 
-    }
2511 
-
2512 
-
2513 
-    /**
2514 
-     * @param string $consent_checkbox_label_text
2515 
-     */
2516 
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
2517 
-    {
2518 
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
2519 
-    }
2333 
+	public $gateway_log_lifespan = '1 week';
2334 
+
2335 
+
2336 
+	/**
2337 
+	 *    class constructor
2338 
+	 *
2339 
+	 * @access    public
2340 
+	 */
2341 
+	public function __construct()
2342 
+	{
2343 
+		// set default registration settings
2344 
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
2345 
+		$this->email_validation_level = 'wp_default';
2346 
+		$this->show_pending_payment_options = true;
2347 
+		$this->skip_reg_confirmation = true;
2348 
+		$this->reg_steps = array();
2349 
+		$this->reg_confirmation_last = false;
2350 
+		$this->use_bot_trap = true;
2351 
+		$this->use_encryption = true;
2352 
+		$this->use_captcha = false;
2353 
+		$this->recaptcha_theme = 'light';
2354 
+		$this->recaptcha_badge = 'bottomleft';
2355 
+		$this->recaptcha_type = 'image';
2356 
+		$this->recaptcha_language = 'en';
2357 
+		$this->recaptcha_publickey = null;
2358 
+		$this->recaptcha_privatekey = null;
2359 
+		$this->recaptcha_protected_forms = array();
2360 
+		$this->recaptcha_width = 500;
2361 
+		$this->default_maximum_number_of_tickets = 10;
2362 
+		$this->consent_checkbox_enabled = false;
2363 
+		$this->consent_checkbox_label_text = '';
2364 
+		$this->gateway_log_lifespan = '7 days';
2365 
+	}
2366 
+
2367 
+
2368 
+	/**
2369 
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
2370 
+	 *
2371 
+	 * @since 4.8.8.rc.019
2372 
+	 */
2373 
+	public function do_hooks()
2374 
+	{
2375 
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
2376 
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
2377 
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
2378 
+	}
2379 
+
2380 
+
2381 
+	/**
2382 
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
2383 
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
2384 
+	 */
2385 
+	public function set_default_reg_status_on_EEM_Event()
2386 
+	{
2387 
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
2388 
+	}
2389 
+
2390 
+
2391 
+	/**
2392 
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
2393 
+	 * for Events matches the config setting for default_maximum_number_of_tickets
2394 
+	 */
2395 
+	public function set_default_max_ticket_on_EEM_Event()
2396 
+	{
2397 
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
2398 
+	}
2399 
+
2400 
+
2401 
+	/**
2402 
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
2403 
+	 * constructed because that happens before we can get the privacy policy page's permalink.
2404 
+	 *
2405 
+	 * @throws InvalidArgumentException
2406 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2407 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2408 
+	 */
2409 
+	public function setDefaultCheckboxLabelText()
2410 
+	{
2411 
+		if ($this->getConsentCheckboxLabelText() === null
2412 
+			|| $this->getConsentCheckboxLabelText() === '') {
2413 
+			$opening_a_tag = '';
2414 
+			$closing_a_tag = '';
2415 
+			if (function_exists('get_privacy_policy_url')) {
2416 
+				$privacy_page_url = get_privacy_policy_url();
2417 
+				if (! empty($privacy_page_url)) {
2418 
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
2419 
+					$closing_a_tag = '</a>';
2420 
+				}
2421 
+			}
2422 
+			$loader = LoaderFactory::getLoader();
2423 
+			$org_config = $loader->getShared('EE_Organization_Config');
2424 
+			/**
2425 
+			 * @var $org_config EE_Organization_Config
2426 
+			 */
2427 
+
2428 
+			$this->setConsentCheckboxLabelText(
2429 
+				sprintf(
2430 
+					esc_html__(
2431 
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
2432 
+						'event_espresso'
2433 
+					),
2434 
+					$org_config->name,
2435 
+					$opening_a_tag,
2436 
+					$closing_a_tag
2437 
+				)
2438 
+			);
2439 
+		}
2440 
+	}
2441 
+
2442 
+
2443 
+	/**
2444 
+	 * @return boolean
2445 
+	 */
2446 
+	public function track_invalid_checkout_access()
2447 
+	{
2448 
+		return $this->track_invalid_checkout_access;
2449 
+	}
2450 
+
2451 
+
2452 
+	/**
2453 
+	 * @param boolean $track_invalid_checkout_access
2454 
+	 */
2455 
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
2456 
+	{
2457 
+		$this->track_invalid_checkout_access = filter_var(
2458 
+			$track_invalid_checkout_access,
2459 
+			FILTER_VALIDATE_BOOLEAN
2460 
+		);
2461 
+	}
2462 
+
2463 
+
2464 
+	/**
2465 
+	 * Gets the options to make availalbe for the gateway log lifespan
2466 
+	 * @return array
2467 
+	 */
2468 
+	public function gatewayLogLifespanOptions()
2469 
+	{
2470 
+		return (array) apply_filters(
2471 
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
2472 
+			array(
2473 
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
2474 
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
2475 
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
2476 
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
2477 
+				'30 days' => esc_html__('30 Days', 'event_espresso')
2478 
+			)
2479 
+		);
2480 
+	}
2481 
+
2482 
+
2483 
+	/**
2484 
+	 * @return bool
2485 
+	 */
2486 
+	public function isConsentCheckboxEnabled()
2487 
+	{
2488 
+		return $this->consent_checkbox_enabled;
2489 
+	}
2490 
+
2491 
+
2492 
+	/**
2493 
+	 * @param bool $consent_checkbox_enabled
2494 
+	 */
2495 
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
2496 
+	{
2497 
+		$this->consent_checkbox_enabled = filter_var(
2498 
+			$consent_checkbox_enabled,
2499 
+			FILTER_VALIDATE_BOOLEAN
2500 
+		);
2501 
+	}
2502 
+
2503 
+
2504 
+	/**
2505 
+	 * @return string
2506 
+	 */
2507 
+	public function getConsentCheckboxLabelText()
2508 
+	{
2509 
+		return $this->consent_checkbox_label_text;
2510 
+	}
2511 
+
2512 
+
2513 
+	/**
2514 
+	 * @param string $consent_checkbox_label_text
2515 
+	 */
2516 
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
2517 
+	{
2518 
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
2519 
+	}
2520 2520 
 }
2521 2521
2522 2522 
 /**
 
@@ -2525,154 +2525,154 @@  discard block
 
 block discarded – undo
2525 2525 
 class EE_Admin_Config extends EE_Config_Base
2526 2526 
 {
2527 2527
2528 
-    /**
2529 
-     * @var boolean $use_personnel_manager
2530 
-     */
2531 
-    public $use_personnel_manager;
2532 
-
2533 
-    /**
2534 
-     * @var boolean $use_dashboard_widget
2535 
-     */
2536 
-    public $use_dashboard_widget;
2537 
-
2538 
-    /**
2539 
-     * @var int $events_in_dashboard
2540 
-     */
2541 
-    public $events_in_dashboard;
2542 
-
2543 
-    /**
2544 
-     * @var boolean $use_event_timezones
2545 
-     */
2546 
-    public $use_event_timezones;
2547 
-
2548 
-    /**
2549 
-     * @var boolean $use_full_logging
2550 
-     */
2551 
-    public $use_full_logging;
2552 
-
2553 
-    /**
2554 
-     * @var string $log_file_name
2555 
-     */
2556 
-    public $log_file_name;
2557 
-
2558 
-    /**
2559 
-     * @var string $debug_file_name
2560 
-     */
2561 
-    public $debug_file_name;
2562 
-
2563 
-    /**
2564 
-     * @var boolean $use_remote_logging
2565 
-     */
2566 
-    public $use_remote_logging;
2567 
-
2568 
-    /**
2569 
-     * @var string $remote_logging_url
2570 
-     */
2571 
-    public $remote_logging_url;
2572 
-
2573 
-    /**
2574 
-     * @var boolean $show_reg_footer
2575 
-     */
2576 
-    public $show_reg_footer;
2577 
-
2578 
-    /**
2579 
-     * @var string $affiliate_id
2580 
-     */
2581 
-    public $affiliate_id;
2582 
-
2583 
-    /**
2584 
-     * help tours on or off (global setting)
2585 
-     *
2586 
-     * @var boolean
2587 
-     */
2588 
-    public $help_tour_activation;
2589 
-
2590 
-    /**
2591 
-     * adds extra layer of encoding to session data to prevent serialization errors
2592 
-     * but is incompatible with some server configuration errors
2593 
-     * if you get "500 internal server errors" during registration, try turning this on
2594 
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
2595 
-     *
2596 
-     * @var boolean $encode_session_data
2597 
-     */
2598 
-    private $encode_session_data = false;
2599 
-
2600 
-
2601 
-    /**
2602 
-     *    class constructor
2603 
-     *
2604 
-     * @access    public
2605 
-     */
2606 
-    public function __construct()
2607 
-    {
2608 
-        // set default general admin settings
2609 
-        $this->use_personnel_manager = true;
2610 
-        $this->use_dashboard_widget = true;
2611 
-        $this->events_in_dashboard = 30;
2612 
-        $this->use_event_timezones = false;
2613 
-        $this->use_full_logging = false;
2614 
-        $this->use_remote_logging = false;
2615 
-        $this->remote_logging_url = null;
2616 
-        $this->show_reg_footer = true;
2617 
-        $this->affiliate_id = 'default';
2618 
-        $this->help_tour_activation = true;
2619 
-        $this->encode_session_data = false;
2620 
-    }
2621 
-
2622 
-
2623 
-    /**
2624 
-     * @param bool $reset
2625 
-     * @return string
2626 
-     */
2627 
-    public function log_file_name($reset = false)
2628 
-    {
2629 
-        if (empty($this->log_file_name) || $reset) {
2630 
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
2631 
-            EE_Config::instance()->update_espresso_config(false, false);
2632 
-        }
2633 
-        return $this->log_file_name;
2634 
-    }
2635 
-
2636 
-
2637 
-    /**
2638 
-     * @param bool $reset
2639 
-     * @return string
2640 
-     */
2641 
-    public function debug_file_name($reset = false)
2642 
-    {
2643 
-        if (empty($this->debug_file_name) || $reset) {
2644 
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
2645 
-            EE_Config::instance()->update_espresso_config(false, false);
2646 
-        }
2647 
-        return $this->debug_file_name;
2648 
-    }
2649 
-
2650 
-
2651 
-    /**
2652 
-     * @return string
2653 
-     */
2654 
-    public function affiliate_id()
2655 
-    {
2656 
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
2657 
-    }
2658 
-
2659 
-
2660 
-    /**
2661 
-     * @return boolean
2662 
-     */
2663 
-    public function encode_session_data()
2664 
-    {
2665 
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
2666 
-    }
2667 
-
2668 
-
2669 
-    /**
2670 
-     * @param boolean $encode_session_data
2671 
-     */
2672 
-    public function set_encode_session_data($encode_session_data)
2673 
-    {
2674 
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
2675 
-    }
2528 
+	/**
2529 
+	 * @var boolean $use_personnel_manager
2530 
+	 */
2531 
+	public $use_personnel_manager;
2532 
+
2533 
+	/**
2534 
+	 * @var boolean $use_dashboard_widget
2535 
+	 */
2536 
+	public $use_dashboard_widget;
2537 
+
2538 
+	/**
2539 
+	 * @var int $events_in_dashboard
2540 
+	 */
2541 
+	public $events_in_dashboard;
2542 
+
2543 
+	/**
2544 
+	 * @var boolean $use_event_timezones
2545 
+	 */
2546 
+	public $use_event_timezones;
2547 
+
2548 
+	/**
2549 
+	 * @var boolean $use_full_logging
2550 
+	 */
2551 
+	public $use_full_logging;
2552 
+
2553 
+	/**
2554 
+	 * @var string $log_file_name
2555 
+	 */
2556 
+	public $log_file_name;
2557 
+
2558 
+	/**
2559 
+	 * @var string $debug_file_name
2560 
+	 */
2561 
+	public $debug_file_name;
2562 
+
2563 
+	/**
2564 
+	 * @var boolean $use_remote_logging
2565 
+	 */
2566 
+	public $use_remote_logging;
2567 
+
2568 
+	/**
2569 
+	 * @var string $remote_logging_url
2570 
+	 */
2571 
+	public $remote_logging_url;
2572 
+
2573 
+	/**
2574 
+	 * @var boolean $show_reg_footer
2575 
+	 */
2576 
+	public $show_reg_footer;
2577 
+
2578 
+	/**
2579 
+	 * @var string $affiliate_id
2580 
+	 */
2581 
+	public $affiliate_id;
2582 
+
2583 
+	/**
2584 
+	 * help tours on or off (global setting)
2585 
+	 *
2586 
+	 * @var boolean
2587 
+	 */
2588 
+	public $help_tour_activation;
2589 
+
2590 
+	/**
2591 
+	 * adds extra layer of encoding to session data to prevent serialization errors
2592 
+	 * but is incompatible with some server configuration errors
2593 
+	 * if you get "500 internal server errors" during registration, try turning this on
2594 
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
2595 
+	 *
2596 
+	 * @var boolean $encode_session_data
2597 
+	 */
2598 
+	private $encode_session_data = false;
2599 
+
2600 
+
2601 
+	/**
2602 
+	 *    class constructor
2603 
+	 *
2604 
+	 * @access    public
2605 
+	 */
2606 
+	public function __construct()
2607 
+	{
2608 
+		// set default general admin settings
2609 
+		$this->use_personnel_manager = true;
2610 
+		$this->use_dashboard_widget = true;
2611 
+		$this->events_in_dashboard = 30;
2612 
+		$this->use_event_timezones = false;
2613 
+		$this->use_full_logging = false;
2614 
+		$this->use_remote_logging = false;
2615 
+		$this->remote_logging_url = null;
2616 
+		$this->show_reg_footer = true;
2617 
+		$this->affiliate_id = 'default';
2618 
+		$this->help_tour_activation = true;
2619 
+		$this->encode_session_data = false;
2620 
+	}
2621 
+
2622 
+
2623 
+	/**
2624 
+	 * @param bool $reset
2625 
+	 * @return string
2626 
+	 */
2627 
+	public function log_file_name($reset = false)
2628 
+	{
2629 
+		if (empty($this->log_file_name) || $reset) {
2630 
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
2631 
+			EE_Config::instance()->update_espresso_config(false, false);
2632 
+		}
2633 
+		return $this->log_file_name;
2634 
+	}
2635 
+
2636 
+
2637 
+	/**
2638 
+	 * @param bool $reset
2639 
+	 * @return string
2640 
+	 */
2641 
+	public function debug_file_name($reset = false)
2642 
+	{
2643 
+		if (empty($this->debug_file_name) || $reset) {
2644 
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
2645 
+			EE_Config::instance()->update_espresso_config(false, false);
2646 
+		}
2647 
+		return $this->debug_file_name;
2648 
+	}
2649 
+
2650 
+
2651 
+	/**
2652 
+	 * @return string
2653 
+	 */
2654 
+	public function affiliate_id()
2655 
+	{
2656 
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
2657 
+	}
2658 
+
2659 
+
2660 
+	/**
2661 
+	 * @return boolean
2662 
+	 */
2663 
+	public function encode_session_data()
2664 
+	{
2665 
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
2666 
+	}
2667 
+
2668 
+
2669 
+	/**
2670 
+	 * @param boolean $encode_session_data
2671 
+	 */
2672 
+	public function set_encode_session_data($encode_session_data)
2673 
+	{
2674 
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
2675 
+	}
2676 2676 
 }
2677 2677
2678 2678 
 /**
 
@@ -2681,70 +2681,70 @@  discard block
 
 block discarded – undo
2681 2681 
 class EE_Template_Config extends EE_Config_Base
2682 2682 
 {
2683 2683
2684 
-    /**
2685 
-     * @var boolean $enable_default_style
2686 
-     */
2687 
-    public $enable_default_style;
2688 
-
2689 
-    /**
2690 
-     * @var string $custom_style_sheet
2691 
-     */
2692 
-    public $custom_style_sheet;
2693 
-
2694 
-    /**
2695 
-     * @var boolean $display_address_in_regform
2696 
-     */
2697 
-    public $display_address_in_regform;
2698 
-
2699 
-    /**
2700 
-     * @var int $display_description_on_multi_reg_page
2701 
-     */
2702 
-    public $display_description_on_multi_reg_page;
2703 
-
2704 
-    /**
2705 
-     * @var boolean $use_custom_templates
2706 
-     */
2707 
-    public $use_custom_templates;
2708 
-
2709 
-    /**
2710 
-     * @var string $current_espresso_theme
2711 
-     */
2712 
-    public $current_espresso_theme;
2713 
-
2714 
-    /**
2715 
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
2716 
-     */
2717 
-    public $EED_Ticket_Selector;
2718 
-
2719 
-    /**
2720 
-     * @var EE_Event_Single_Config $EED_Event_Single
2721 
-     */
2722 
-    public $EED_Event_Single;
2723 
-
2724 
-    /**
2725 
-     * @var EE_Events_Archive_Config $EED_Events_Archive
2726 
-     */
2727 
-    public $EED_Events_Archive;
2728 
-
2729 
-
2730 
-    /**
2731 
-     *    class constructor
2732 
-     *
2733 
-     * @access    public
2734 
-     */
2735 
-    public function __construct()
2736 
-    {
2737 
-        // set default template settings
2738 
-        $this->enable_default_style = true;
2739 
-        $this->custom_style_sheet = null;
2740 
-        $this->display_address_in_regform = true;
2741 
-        $this->display_description_on_multi_reg_page = false;
2742 
-        $this->use_custom_templates = false;
2743 
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
2744 
-        $this->EED_Event_Single = null;
2745 
-        $this->EED_Events_Archive = null;
2746 
-        $this->EED_Ticket_Selector = null;
2747 
-    }
2684 
+	/**
2685 
+	 * @var boolean $enable_default_style
2686 
+	 */
2687 
+	public $enable_default_style;
2688 
+
2689 
+	/**
2690 
+	 * @var string $custom_style_sheet
2691 
+	 */
2692 
+	public $custom_style_sheet;
2693 
+
2694 
+	/**
2695 
+	 * @var boolean $display_address_in_regform
2696 
+	 */
2697 
+	public $display_address_in_regform;
2698 
+
2699 
+	/**
2700 
+	 * @var int $display_description_on_multi_reg_page
2701 
+	 */
2702 
+	public $display_description_on_multi_reg_page;
2703 
+
2704 
+	/**
2705 
+	 * @var boolean $use_custom_templates
2706 
+	 */
2707 
+	public $use_custom_templates;
2708 
+
2709 
+	/**
2710 
+	 * @var string $current_espresso_theme
2711 
+	 */
2712 
+	public $current_espresso_theme;
2713 
+
2714 
+	/**
2715 
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
2716 
+	 */
2717 
+	public $EED_Ticket_Selector;
2718 
+
2719 
+	/**
2720 
+	 * @var EE_Event_Single_Config $EED_Event_Single
2721 
+	 */
2722 
+	public $EED_Event_Single;
2723 
+
2724 
+	/**
2725 
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
2726 
+	 */
2727 
+	public $EED_Events_Archive;
2728 
+
2729 
+
2730 
+	/**
2731 
+	 *    class constructor
2732 
+	 *
2733 
+	 * @access    public
2734 
+	 */
2735 
+	public function __construct()
2736 
+	{
2737 
+		// set default template settings
2738 
+		$this->enable_default_style = true;
2739 
+		$this->custom_style_sheet = null;
2740 
+		$this->display_address_in_regform = true;
2741 
+		$this->display_description_on_multi_reg_page = false;
2742 
+		$this->use_custom_templates = false;
2743 
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
2744 
+		$this->EED_Event_Single = null;
2745 
+		$this->EED_Events_Archive = null;
2746 
+		$this->EED_Ticket_Selector = null;
2747 
+	}
2748 2748 
 }
2749 2749
2750 2750 
 /**
 
@@ -2753,114 +2753,114 @@  discard block
 
 block discarded – undo
2753 2753 
 class EE_Map_Config extends EE_Config_Base
2754 2754 
 {
2755 2755
2756 
-    /**
2757 
-     * @var boolean $use_google_maps
2758 
-     */
2759 
-    public $use_google_maps;
2760 
-
2761 
-    /**
2762 
-     * @var string $api_key
2763 
-     */
2764 
-    public $google_map_api_key;
2765 
-
2766 
-    /**
2767 
-     * @var int $event_details_map_width
2768 
-     */
2769 
-    public $event_details_map_width;
2770 
-
2771 
-    /**
2772 
-     * @var int $event_details_map_height
2773 
-     */
2774 
-    public $event_details_map_height;
2775 
-
2776 
-    /**
2777 
-     * @var int $event_details_map_zoom
2778 
-     */
2779 
-    public $event_details_map_zoom;
2780 
-
2781 
-    /**
2782 
-     * @var boolean $event_details_display_nav
2783 
-     */
2784 
-    public $event_details_display_nav;
2785 
-
2786 
-    /**
2787 
-     * @var boolean $event_details_nav_size
2788 
-     */
2789 
-    public $event_details_nav_size;
2790 
-
2791 
-    /**
2792 
-     * @var string $event_details_control_type
2793 
-     */
2794 
-    public $event_details_control_type;
2795 
-
2796 
-    /**
2797 
-     * @var string $event_details_map_align
2798 
-     */
2799 
-    public $event_details_map_align;
2800 
-
2801 
-    /**
2802 
-     * @var int $event_list_map_width
2803 
-     */
2804 
-    public $event_list_map_width;
2805 
-
2806 
-    /**
2807 
-     * @var int $event_list_map_height
2808 
-     */
2809 
-    public $event_list_map_height;
2810 
-
2811 
-    /**
2812 
-     * @var int $event_list_map_zoom
2813 
-     */
2814 
-    public $event_list_map_zoom;
2815 
-
2816 
-    /**
2817 
-     * @var boolean $event_list_display_nav
2818 
-     */
2819 
-    public $event_list_display_nav;
2820 
-
2821 
-    /**
2822 
-     * @var boolean $event_list_nav_size
2823 
-     */
2824 
-    public $event_list_nav_size;
2825 
-
2826 
-    /**
2827 
-     * @var string $event_list_control_type
2828 
-     */
2829 
-    public $event_list_control_type;
2830 
-
2831 
-    /**
2832 
-     * @var string $event_list_map_align
2833 
-     */
2834 
-    public $event_list_map_align;
2835 
-
2836 
-
2837 
-    /**
2838 
-     *    class constructor
2839 
-     *
2840 
-     * @access    public
2841 
-     */
2842 
-    public function __construct()
2843 
-    {
2844 
-        // set default map settings
2845 
-        $this->use_google_maps = true;
2846 
-        $this->google_map_api_key = '';
2847 
-        // for event details pages (reg page)
2848 
-        $this->event_details_map_width = 585;            // ee_map_width_single
2849 
-        $this->event_details_map_height = 362;            // ee_map_height_single
2850 
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
2851 
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
2852 
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
2853 
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
2854 
-        $this->event_details_map_align = 'center';            // ee_map_align_single
2855 
-        // for event list pages
2856 
-        $this->event_list_map_width = 300;            // ee_map_width
2857 
-        $this->event_list_map_height = 185;        // ee_map_height
2858 
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
2859 
-        $this->event_list_display_nav = false;        // ee_map_nav_display
2860 
-        $this->event_list_nav_size = true;            // ee_map_nav_size
2861 
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
2862 
-        $this->event_list_map_align = 'center';            // ee_map_align
2863 
-    }
2756 
+	/**
2757 
+	 * @var boolean $use_google_maps
2758 
+	 */
2759 
+	public $use_google_maps;
2760 
+
2761 
+	/**
2762 
+	 * @var string $api_key
2763 
+	 */
2764 
+	public $google_map_api_key;
2765 
+
2766 
+	/**
2767 
+	 * @var int $event_details_map_width
2768 
+	 */
2769 
+	public $event_details_map_width;
2770 
+
2771 
+	/**
2772 
+	 * @var int $event_details_map_height
2773 
+	 */
2774 
+	public $event_details_map_height;
2775 
+
2776 
+	/**
2777 
+	 * @var int $event_details_map_zoom
2778 
+	 */
2779 
+	public $event_details_map_zoom;
2780 
+
2781 
+	/**
2782 
+	 * @var boolean $event_details_display_nav
2783 
+	 */
2784 
+	public $event_details_display_nav;
2785 
+
2786 
+	/**
2787 
+	 * @var boolean $event_details_nav_size
2788 
+	 */
2789 
+	public $event_details_nav_size;
2790 
+
2791 
+	/**
2792 
+	 * @var string $event_details_control_type
2793 
+	 */
2794 
+	public $event_details_control_type;
2795 
+
2796 
+	/**
2797 
+	 * @var string $event_details_map_align
2798 
+	 */
2799 
+	public $event_details_map_align;
2800 
+
2801 
+	/**
2802 
+	 * @var int $event_list_map_width
2803 
+	 */
2804 
+	public $event_list_map_width;
2805 
+
2806 
+	/**
2807 
+	 * @var int $event_list_map_height
2808 
+	 */
2809 
+	public $event_list_map_height;
2810 
+
2811 
+	/**
2812 
+	 * @var int $event_list_map_zoom
2813 
+	 */
2814 
+	public $event_list_map_zoom;
2815 
+
2816 
+	/**
2817 
+	 * @var boolean $event_list_display_nav
2818 
+	 */
2819 
+	public $event_list_display_nav;
2820 
+
2821 
+	/**
2822 
+	 * @var boolean $event_list_nav_size
2823 
+	 */
2824 
+	public $event_list_nav_size;
2825 
+
2826 
+	/**
2827 
+	 * @var string $event_list_control_type
2828 
+	 */
2829 
+	public $event_list_control_type;
2830 
+
2831 
+	/**
2832 
+	 * @var string $event_list_map_align
2833 
+	 */
2834 
+	public $event_list_map_align;
2835 
+
2836 
+
2837 
+	/**
2838 
+	 *    class constructor
2839 
+	 *
2840 
+	 * @access    public
2841 
+	 */
2842 
+	public function __construct()
2843 
+	{
2844 
+		// set default map settings
2845 
+		$this->use_google_maps = true;
2846 
+		$this->google_map_api_key = '';
2847 
+		// for event details pages (reg page)
2848 
+		$this->event_details_map_width = 585;            // ee_map_width_single
2849 
+		$this->event_details_map_height = 362;            // ee_map_height_single
2850 
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
2851 
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
2852 
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
2853 
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
2854 
+		$this->event_details_map_align = 'center';            // ee_map_align_single
2855 
+		// for event list pages
2856 
+		$this->event_list_map_width = 300;            // ee_map_width
2857 
+		$this->event_list_map_height = 185;        // ee_map_height
2858 
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
2859 
+		$this->event_list_display_nav = false;        // ee_map_nav_display
2860 
+		$this->event_list_nav_size = true;            // ee_map_nav_size
2861 
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
2862 
+		$this->event_list_map_align = 'center';            // ee_map_align
2863 
+	}
2864 2864 
 }
2865 2865
2866 2866 
 /**
 
@@ -2869,46 +2869,46 @@  discard block
 
 block discarded – undo
2869 2869 
 class EE_Events_Archive_Config extends EE_Config_Base
2870 2870 
 {
2871 2871
2872 
-    public $display_status_banner;
2872 
+	public $display_status_banner;
2873 2873
2874 
-    public $display_description;
2874 
+	public $display_description;
2875 2875
2876 
-    public $display_ticket_selector;
2876 
+	public $display_ticket_selector;
2877 2877
2878 
-    public $display_datetimes;
2878 
+	public $display_datetimes;
2879 2879
2880 
-    public $display_venue;
2880 
+	public $display_venue;
2881 2881
2882 
-    public $display_expired_events;
2882 
+	public $display_expired_events;
2883 2883
2884 
-    public $use_sortable_display_order;
2884 
+	public $use_sortable_display_order;
2885 2885
2886 
-    public $display_order_tickets;
2886 
+	public $display_order_tickets;
2887 2887
2888 
-    public $display_order_datetimes;
2888 
+	public $display_order_datetimes;
2889 2889
2890 
-    public $display_order_event;
2890 
+	public $display_order_event;
2891 2891
2892 
-    public $display_order_venue;
2892 
+	public $display_order_venue;
2893 2893
2894 2894
2895 
-    /**
2896 
-     *    class constructor
2897 
-     */
2898 
-    public function __construct()
2899 
-    {
2900 
-        $this->display_status_banner = 0;
2901 
-        $this->display_description = 1;
2902 
-        $this->display_ticket_selector = 0;
2903 
-        $this->display_datetimes = 1;
2904 
-        $this->display_venue = 0;
2905 
-        $this->display_expired_events = 0;
2906 
-        $this->use_sortable_display_order = false;
2907 
-        $this->display_order_tickets = 100;
2908 
-        $this->display_order_datetimes = 110;
2909 
-        $this->display_order_event = 120;
2910 
-        $this->display_order_venue = 130;
2911 
-    }
2895 
+	/**
2896 
+	 *    class constructor
2897 
+	 */
2898 
+	public function __construct()
2899 
+	{
2900 
+		$this->display_status_banner = 0;
2901 
+		$this->display_description = 1;
2902 
+		$this->display_ticket_selector = 0;
2903 
+		$this->display_datetimes = 1;
2904 
+		$this->display_venue = 0;
2905 
+		$this->display_expired_events = 0;
2906 
+		$this->use_sortable_display_order = false;
2907 
+		$this->display_order_tickets = 100;
2908 
+		$this->display_order_datetimes = 110;
2909 
+		$this->display_order_event = 120;
2910 
+		$this->display_order_venue = 130;
2911 
+	}
2912 2912 
 }
2913 2913
2914 2914 
 /**
 
@@ -2917,34 +2917,34 @@  discard block
 
 block discarded – undo
2917 2917 
 class EE_Event_Single_Config extends EE_Config_Base
2918 2918 
 {
2919 2919
2920 
-    public $display_status_banner_single;
2920 
+	public $display_status_banner_single;
2921 2921
2922 
-    public $display_venue;
2922 
+	public $display_venue;
2923 2923
2924 
-    public $use_sortable_display_order;
2924 
+	public $use_sortable_display_order;
2925 2925
2926 
-    public $display_order_tickets;
2926 
+	public $display_order_tickets;
2927 2927
2928 
-    public $display_order_datetimes;
2928 
+	public $display_order_datetimes;
2929 2929
2930 
-    public $display_order_event;
2930 
+	public $display_order_event;
2931 2931
2932 
-    public $display_order_venue;
2932 
+	public $display_order_venue;
2933 2933
2934 2934
2935 
-    /**
2936 
-     *    class constructor
2937 
-     */
2938 
-    public function __construct()
2939 
-    {
2940 
-        $this->display_status_banner_single = 0;
2941 
-        $this->display_venue = 1;
2942 
-        $this->use_sortable_display_order = false;
2943 
-        $this->display_order_tickets = 100;
2944 
-        $this->display_order_datetimes = 110;
2945 
-        $this->display_order_event = 120;
2946 
-        $this->display_order_venue = 130;
2947 
-    }
2935 
+	/**
2936 
+	 *    class constructor
2937 
+	 */
2938 
+	public function __construct()
2939 
+	{
2940 
+		$this->display_status_banner_single = 0;
2941 
+		$this->display_venue = 1;
2942 
+		$this->use_sortable_display_order = false;
2943 
+		$this->display_order_tickets = 100;
2944 
+		$this->display_order_datetimes = 110;
2945 
+		$this->display_order_event = 120;
2946 
+		$this->display_order_venue = 130;
2947 
+	}
2948 2948 
 }
2949 2949
2950 2950 
 /**
 
@@ -2953,172 +2953,172 @@  discard block
 
 block discarded – undo
2953 2953 
 class EE_Ticket_Selector_Config extends EE_Config_Base
2954 2954 
 {
2955 2955
2956 
-    /**
2957 
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
2958 
-     */
2959 
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
2960 
-
2961 
-    /**
2962 
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
2963 
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
2964 
-     */
2965 
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
2966 
-
2967 
-    /**
2968 
-     * @var boolean $show_ticket_sale_columns
2969 
-     */
2970 
-    public $show_ticket_sale_columns;
2971 
-
2972 
-    /**
2973 
-     * @var boolean $show_ticket_details
2974 
-     */
2975 
-    public $show_ticket_details;
2976 
-
2977 
-    /**
2978 
-     * @var boolean $show_expired_tickets
2979 
-     */
2980 
-    public $show_expired_tickets;
2981 
-
2982 
-    /**
2983 
-     * whether or not to display a dropdown box populated with event datetimes
2984 
-     * that toggles which tickets are displayed for a ticket selector.
2985 
-     * uses one of the *_DATETIME_SELECTOR constants defined above
2986 
-     *
2987 
-     * @var string $show_datetime_selector
2988 
-     */
2989 
-    private $show_datetime_selector = 'no_datetime_selector';
2990 
-
2991 
-    /**
2992 
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
2993 
-     *
2994 
-     * @var int $datetime_selector_threshold
2995 
-     */
2996 
-    private $datetime_selector_threshold = 3;
2997 
-
2998 
-    /**
2999 
-     * determines the maximum number of "checked" dates in the date and time filter
3000 
-     *
3001 
-     * @var int $datetime_selector_checked
3002 
-     */
3003 
-    private $datetime_selector_max_checked = 10;
3004 
-
3005 
-
3006 
-    /**
3007 
-     *    class constructor
3008 
-     */
3009 
-    public function __construct()
3010 
-    {
3011 
-        $this->show_ticket_sale_columns = true;
3012 
-        $this->show_ticket_details = true;
3013 
-        $this->show_expired_tickets = true;
3014 
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3015 
-        $this->datetime_selector_threshold = 3;
3016 
-        $this->datetime_selector_max_checked = 10;
3017 
-    }
3018 
-
3019 
-
3020 
-    /**
3021 
-     * returns true if a datetime selector should be displayed
3022 
-     *
3023 
-     * @param array $datetimes
3024 
-     * @return bool
3025 
-     */
3026 
-    public function showDatetimeSelector(array $datetimes)
3027 
-    {
3028 
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
3029 
-        return ! (
3030 
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
3031 
-            || (
3032 
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
3033 
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
3034 
-            )
3035 
-        );
3036 
-    }
3037 
-
3038 
-
3039 
-    /**
3040 
-     * @return string
3041 
-     */
3042 
-    public function getShowDatetimeSelector()
3043 
-    {
3044 
-        return $this->show_datetime_selector;
3045 
-    }
3046 
-
3047 
-
3048 
-    /**
3049 
-     * @param bool $keys_only
3050 
-     * @return array
3051 
-     */
3052 
-    public function getShowDatetimeSelectorOptions($keys_only = true)
3053 
-    {
3054 
-        return $keys_only
3055 
-            ? array(
3056 
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
3057 
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
3058 
-            )
3059 
-            : array(
3060 
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
3061 
-                    'Do not show date & time filter',
3062 
-                    'event_espresso'
3063 
-                ),
3064 
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
3065 
-                    'Maybe show date & time filter',
3066 
-                    'event_espresso'
3067 
-                ),
3068 
-            );
3069 
-    }
3070 
-
3071 
-
3072 
-    /**
3073 
-     * @param string $show_datetime_selector
3074 
-     */
3075 
-    public function setShowDatetimeSelector($show_datetime_selector)
3076 
-    {
3077 
-        $this->show_datetime_selector = in_array(
3078 
-            $show_datetime_selector,
3079 
-            $this->getShowDatetimeSelectorOptions(),
3080 
-            true
3081 
-        )
3082 
-            ? $show_datetime_selector
3083 
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3084 
-    }
3085 
-
3086 
-
3087 
-    /**
3088 
-     * @return int
3089 
-     */
3090 
-    public function getDatetimeSelectorThreshold()
3091 
-    {
3092 
-        return $this->datetime_selector_threshold;
3093 
-    }
3094 
-
3095 
-
3096 
-    /**
3097 
-     * @param int $datetime_selector_threshold
3098 
-     */
3099 
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
3100 
-    {
3101 
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
3102 
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
3103 
-    }
3104 
-
3105 
-
3106 
-    /**
3107 
-     * @return int
3108 
-     */
3109 
-    public function getDatetimeSelectorMaxChecked()
3110 
-    {
3111 
-        return $this->datetime_selector_max_checked;
3112 
-    }
3113 
-
3114 
-
3115 
-    /**
3116 
-     * @param int $datetime_selector_max_checked
3117 
-     */
3118 
-    public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
3119 
-    {
3120 
-        $this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
3121 
-    }
2956 
+	/**
2957 
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
2958 
+	 */
2959 
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
2960 
+
2961 
+	/**
2962 
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
2963 
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
2964 
+	 */
2965 
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
2966 
+
2967 
+	/**
2968 
+	 * @var boolean $show_ticket_sale_columns
2969 
+	 */
2970 
+	public $show_ticket_sale_columns;
2971 
+
2972 
+	/**
2973 
+	 * @var boolean $show_ticket_details
2974 
+	 */
2975 
+	public $show_ticket_details;
2976 
+
2977 
+	/**
2978 
+	 * @var boolean $show_expired_tickets
2979 
+	 */
2980 
+	public $show_expired_tickets;
2981 
+
2982 
+	/**
2983 
+	 * whether or not to display a dropdown box populated with event datetimes
2984 
+	 * that toggles which tickets are displayed for a ticket selector.
2985 
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
2986 
+	 *
2987 
+	 * @var string $show_datetime_selector
2988 
+	 */
2989 
+	private $show_datetime_selector = 'no_datetime_selector';
2990 
+
2991 
+	/**
2992 
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
2993 
+	 *
2994 
+	 * @var int $datetime_selector_threshold
2995 
+	 */
2996 
+	private $datetime_selector_threshold = 3;
2997 
+
2998 
+	/**
2999 
+	 * determines the maximum number of "checked" dates in the date and time filter
3000 
+	 *
3001 
+	 * @var int $datetime_selector_checked
3002 
+	 */
3003 
+	private $datetime_selector_max_checked = 10;
3004 
+
3005 
+
3006 
+	/**
3007 
+	 *    class constructor
3008 
+	 */
3009 
+	public function __construct()
3010 
+	{
3011 
+		$this->show_ticket_sale_columns = true;
3012 
+		$this->show_ticket_details = true;
3013 
+		$this->show_expired_tickets = true;
3014 
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3015 
+		$this->datetime_selector_threshold = 3;
3016 
+		$this->datetime_selector_max_checked = 10;
3017 
+	}
3018 
+
3019 
+
3020 
+	/**
3021 
+	 * returns true if a datetime selector should be displayed
3022 
+	 *
3023 
+	 * @param array $datetimes
3024 
+	 * @return bool
3025 
+	 */
3026 
+	public function showDatetimeSelector(array $datetimes)
3027 
+	{
3028 
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
3029 
+		return ! (
3030 
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
3031 
+			|| (
3032 
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
3033 
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
3034 
+			)
3035 
+		);
3036 
+	}
3037 
+
3038 
+
3039 
+	/**
3040 
+	 * @return string
3041 
+	 */
3042 
+	public function getShowDatetimeSelector()
3043 
+	{
3044 
+		return $this->show_datetime_selector;
3045 
+	}
3046 
+
3047 
+
3048 
+	/**
3049 
+	 * @param bool $keys_only
3050 
+	 * @return array
3051 
+	 */
3052 
+	public function getShowDatetimeSelectorOptions($keys_only = true)
3053 
+	{
3054 
+		return $keys_only
3055 
+			? array(
3056 
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
3057 
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
3058 
+			)
3059 
+			: array(
3060 
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
3061 
+					'Do not show date & time filter',
3062 
+					'event_espresso'
3063 
+				),
3064 
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
3065 
+					'Maybe show date & time filter',
3066 
+					'event_espresso'
3067 
+				),
3068 
+			);
3069 
+	}
3070 
+
3071 
+
3072 
+	/**
3073 
+	 * @param string $show_datetime_selector
3074 
+	 */
3075 
+	public function setShowDatetimeSelector($show_datetime_selector)
3076 
+	{
3077 
+		$this->show_datetime_selector = in_array(
3078 
+			$show_datetime_selector,
3079 
+			$this->getShowDatetimeSelectorOptions(),
3080 
+			true
3081 
+		)
3082 
+			? $show_datetime_selector
3083 
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
3084 
+	}
3085 
+
3086 
+
3087 
+	/**
3088 
+	 * @return int
3089 
+	 */
3090 
+	public function getDatetimeSelectorThreshold()
3091 
+	{
3092 
+		return $this->datetime_selector_threshold;
3093 
+	}
3094 
+
3095 
+
3096 
+	/**
3097 
+	 * @param int $datetime_selector_threshold
3098 
+	 */
3099 
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
3100 
+	{
3101 
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
3102 
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
3103 
+	}
3104 
+
3105 
+
3106 
+	/**
3107 
+	 * @return int
3108 
+	 */
3109 
+	public function getDatetimeSelectorMaxChecked()
3110 
+	{
3111 
+		return $this->datetime_selector_max_checked;
3112 
+	}
3113 
+
3114 
+
3115 
+	/**
3116 
+	 * @param int $datetime_selector_max_checked
3117 
+	 */
3118 
+	public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
3119 
+	{
3120 
+		$this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
3121 
+	}
3122 3122 
 }
3123 3123
3124 3124 
 /**
 
@@ -3131,80 +3131,80 @@  discard block
 
 block discarded – undo
3131 3131 
 class EE_Environment_Config extends EE_Config_Base
3132 3132 
 {
3133 3133
3134 
-    /**
3135 
-     * Hold any php environment variables that we want to track.
3136 
-     *
3137 
-     * @var stdClass;
3138 
-     */
3139 
-    public $php;
3140 
-
3141 
-
3142 
-    /**
3143 
-     *    constructor
3144 
-     */
3145 
-    public function __construct()
3146 
-    {
3147 
-        $this->php = new stdClass();
3148 
-        $this->_set_php_values();
3149 
-    }
3150 
-
3151 
-
3152 
-    /**
3153 
-     * This sets the php environment variables.
3154 
-     *
3155 
-     * @since 4.4.0
3156 
-     * @return void
3157 
-     */
3158 
-    protected function _set_php_values()
3159 
-    {
3160 
-        $this->php->max_input_vars = ini_get('max_input_vars');
3161 
-        $this->php->version = phpversion();
3162 
-    }
3163 
-
3164 
-
3165 
-    /**
3166 
-     * helper method for determining whether input_count is
3167 
-     * reaching the potential maximum the server can handle
3168 
-     * according to max_input_vars
3169 
-     *
3170 
-     * @param int   $input_count the count of input vars.
3171 
-     * @return array {
3172 
-     *                           An array that represents whether available space and if no available space the error
3173 
-     *                           message.
3174 
-     * @type bool   $has_space   whether more inputs can be added.
3175 
-     * @type string $msg         Any message to be displayed.
3176 
-     *                           }
3177 
-     */
3178 
-    public function max_input_vars_limit_check($input_count = 0)
3179 
-    {
3180 
-        if (! empty($this->php->max_input_vars)
3181 
-            && ($input_count >= $this->php->max_input_vars)
3182 
-        ) {
3183 
-            return sprintf(
3184 
-                __(
3185 
-                    'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
3186 
-                    'event_espresso'
3187 
-                ),
3188 
-                '<br>',
3189 
-                $input_count,
3190 
-                $this->php->max_input_vars
3191 
-            );
3192 
-        } else {
3193 
-            return '';
3194 
-        }
3195 
-    }
3196 
-
3197 
-
3198 
-    /**
3199 
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
3200 
-     *
3201 
-     * @since 4.4.1
3202 
-     * @return void
3203 
-     */
3204 
-    public function recheck_values()
3205 
-    {
3206 
-        $this->_set_php_values();
3207 
-    }
3134 
+	/**
3135 
+	 * Hold any php environment variables that we want to track.
3136 
+	 *
3137 
+	 * @var stdClass;
3138 
+	 */
3139 
+	public $php;
3140 
+
3141 
+
3142 
+	/**
3143 
+	 *    constructor
3144 
+	 */
3145 
+	public function __construct()
3146 
+	{
3147 
+		$this->php = new stdClass();
3148 
+		$this->_set_php_values();
3149 
+	}
3150 
+
3151 
+
3152 
+	/**
3153 
+	 * This sets the php environment variables.
3154 
+	 *
3155 
+	 * @since 4.4.0
3156 
+	 * @return void
3157 
+	 */
3158 
+	protected function _set_php_values()
3159 
+	{
3160 
+		$this->php->max_input_vars = ini_get('max_input_vars');
3161 
+		$this->php->version = phpversion();
3162 
+	}
3163 
+
3164 
+
3165 
+	/**
3166 
+	 * helper method for determining whether input_count is
3167 
+	 * reaching the potential maximum the server can handle
3168 
+	 * according to max_input_vars
3169 
+	 *
3170 
+	 * @param int   $input_count the count of input vars.
3171 
+	 * @return array {
3172 
+	 *                           An array that represents whether available space and if no available space the error
3173 
+	 *                           message.
3174 
+	 * @type bool   $has_space   whether more inputs can be added.
3175 
+	 * @type string $msg         Any message to be displayed.
3176 
+	 *                           }
3177 
+	 */
3178 
+	public function max_input_vars_limit_check($input_count = 0)
3179 
+	{
3180 
+		if (! empty($this->php->max_input_vars)
3181 
+			&& ($input_count >= $this->php->max_input_vars)
3182 
+		) {
3183 
+			return sprintf(
3184 
+				__(
3185 
+					'The maximum number of inputs on this page has been exceeded.  You cannot add anymore items (i.e. tickets, datetimes, custom fields) on this page because of your servers PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.',
3186 
+					'event_espresso'
3187 
+				),
3188 
+				'<br>',
3189 
+				$input_count,
3190 
+				$this->php->max_input_vars
3191 
+			);
3192 
+		} else {
3193 
+			return '';
3194 
+		}
3195 
+	}
3196 
+
3197 
+
3198 
+	/**
3199 
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
3200 
+	 *
3201 
+	 * @since 4.4.1
3202 
+	 * @return void
3203 
+	 */
3204 
+	public function recheck_values()
3205 
+	{
3206 
+		$this->_set_php_values();
3207 
+	}
3208 3208 
 }
3209 3209
3210 3210 
 /**
 
@@ -3217,21 +3217,21 @@  discard block
 
 block discarded – undo
3217 3217 
 class EE_Tax_Config extends EE_Config_Base
3218 3218 
 {
3219 3219
3220 
-    /*
3220 
+	/*
3221 3221 
      * flag to indicate whether or not to display ticket prices with the taxes included
3222 3222 
      *
3223 3223 
      * @var boolean $prices_displayed_including_taxes
3224 3224 
      */
3225 
-    public $prices_displayed_including_taxes;
3225 
+	public $prices_displayed_including_taxes;
3226 3226
3227 3227
3228 
-    /**
3229 
-     *    class constructor
3230 
-     */
3231 
-    public function __construct()
3232 
-    {
3233 
-        $this->prices_displayed_including_taxes = true;
3234 
-    }
3228 
+	/**
3229 
+	 *    class constructor
3230 
+	 */
3231 
+	public function __construct()
3232 
+	{
3233 
+		$this->prices_displayed_including_taxes = true;
3234 
+	}
3235 3235 
 }
3236 3236
3237 3237 
 /**
 
@@ -3245,19 +3245,19 @@  discard block
 
 block discarded – undo
3245 3245 
 class EE_Messages_Config extends EE_Config_Base
3246 3246 
 {
3247 3247
3248 
-    /**
3249 
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
3250 
-     * A value of 0 represents never deleting.  Default is 0.
3251 
-     *
3252 
-     * @var integer
3253 
-     */
3254 
-    public $delete_threshold;
3248 
+	/**
3249 
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
3250 
+	 * A value of 0 represents never deleting.  Default is 0.
3251 
+	 *
3252 
+	 * @var integer
3253 
+	 */
3254 
+	public $delete_threshold;
3255 3255
3256 3256
3257 
-    public function __construct()
3258 
-    {
3259 
-        $this->delete_threshold = 0;
3260 
-    }
3257 
+	public function __construct()
3258 
+	{
3259 
+		$this->delete_threshold = 0;
3260 
+	}
3261 3261 
 }
3262 3262
3263 3263 
 /**
 
@@ -3268,31 +3268,31 @@  discard block
 
 block discarded – undo
3268 3268 
 class EE_Gateway_Config extends EE_Config_Base
3269 3269 
 {
3270 3270
3271 
-    /**
3272 
-     * Array with keys that are payment gateways slugs, and values are arrays
3273 
-     * with any config info the gateway wants to store
3274 
-     *
3275 
-     * @var array
3276 
-     */
3277 
-    public $payment_settings;
3278 
-
3279 
-    /**
3280 
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
3281 
-     * the gateway is stored in the uploads directory
3282 
-     *
3283 
-     * @var array
3284 
-     */
3285 
-    public $active_gateways;
3286 
-
3287 
-
3288 
-    /**
3289 
-     *    class constructor
3290 
-     *
3291 
-     * @deprecated
3292 
-     */
3293 
-    public function __construct()
3294 
-    {
3295 
-        $this->payment_settings = array();
3296 
-        $this->active_gateways = array('Invoice' => false);
3297 
-    }
3271 
+	/**
3272 
+	 * Array with keys that are payment gateways slugs, and values are arrays
3273 
+	 * with any config info the gateway wants to store
3274 
+	 *
3275 
+	 * @var array
3276 
+	 */
3277 
+	public $payment_settings;
3278 
+
3279 
+	/**
3280 
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
3281 
+	 * the gateway is stored in the uploads directory
3282 
+	 *
3283 
+	 * @var array
3284 
+	 */
3285 
+	public $active_gateways;
3286 
+
3287 
+
3288 
+	/**
3289 
+	 *    class constructor
3290 
+	 *
3291 
+	 * @deprecated
3292 
+	 */
3293 
+	public function __construct()
3294 
+	{
3295 
+		$this->payment_settings = array();
3296 
+		$this->active_gateways = array('Invoice' => false);
3297 
+	}
3298 3298 
 }
Please login to merge, or discard this patch.
Spacing   +122 added lines, -122 removed lines patch added patch discarded remove patch 
@@ -145,7 +145,7 @@  discard block
 
 block discarded – undo
145 145 
     public static function instance()
146 146 
     {
147 147 
         // check if class object is instantiated, and instantiated properly
148 
-        if (! self::$_instance instanceof EE_Config) {
148 
+        if ( ! self::$_instance instanceof EE_Config) {
149 149 
             self::$_instance = new self();
150 150 
         }
151 151 
         return self::$_instance;
 
@@ -283,7 +283,7 @@  discard block
 
 block discarded – undo
283 283 
                 $this
284 284 
             );
285 285 
             if (is_object($settings) && property_exists($this, $config)) {
286 
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
286 
+                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings);
287 287 
                 // call configs populate method to ensure any defaults are set for empty values.
288 288 
                 if (method_exists($settings, 'populate')) {
289 289 
                     $this->{$config}->populate();
 
@@ -556,7 +556,7 @@  discard block
 
 block discarded – undo
556 556 
                         break;
557 557 
                     // TEST #2 : check that settings section exists
558 558 
                     case 2:
559 
-                        if (! isset($this->{$section})) {
559 
+                        if ( ! isset($this->{$section})) {
560 560 
                             if ($display_errors) {
561 561 
                                 throw new EE_Error(
562 562 
                                     sprintf(
 
@@ -570,7 +570,7 @@  discard block
 
 block discarded – undo
570 570 
                         break;
571 571 
                     // TEST #3 : check that section is the proper format
572 572 
                     case 3:
573 
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
573 
+                        if ( ! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
574 574 
                         ) {
575 575 
                             if ($display_errors) {
576 576 
                                 throw new EE_Error(
 
@@ -616,7 +616,7 @@  discard block
 
 block discarded – undo
616 616 
                         break;
617 617 
                     // TEST #6 : verify config class is accessible
618 618 
                     case 6:
619 
-                        if (! class_exists($config_class)) {
619 
+                        if ( ! class_exists($config_class)) {
620 620 
                             if ($display_errors) {
621 621 
                                 throw new EE_Error(
622 622 
                                     sprintf(
 
@@ -633,7 +633,7 @@  discard block
 
 block discarded – undo
633 633 
                         break;
634 634 
                     // TEST #7 : check that config has even been set
635 635 
                     case 7:
636 
-                        if (! isset($this->{$section}->{$name})) {
636 
+                        if ( ! isset($this->{$section}->{$name})) {
637 637 
                             if ($display_errors) {
638 638 
                                 throw new EE_Error(
639 639 
                                     sprintf(
 
@@ -651,7 +651,7 @@  discard block
 
 block discarded – undo
651 651 
                         break;
652 652 
                     // TEST #8 : check that config is the requested type
653 653 
                     case 8:
654 
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
654 
+                        if ( ! $this->{$section}->{$name} instanceof $config_class) {
655 655 
                             if ($display_errors) {
656 656 
                                 throw new EE_Error(
657 657 
                                     sprintf(
 
@@ -670,7 +670,7 @@  discard block
 
 block discarded – undo
670 670 
                         break;
671 671 
                     // TEST #9 : verify config object
672 672 
                     case 9:
673 
-                        if (! $config_obj instanceof EE_Config_Base) {
673 
+                        if ( ! $config_obj instanceof EE_Config_Base) {
674 674 
                             if ($display_errors) {
675 675 
                                 throw new EE_Error(
676 676 
                                     sprintf(
 
@@ -702,7 +702,7 @@  discard block
 
 block discarded – undo
702 702 
      */
703 703 
     private function _generate_config_option_name($section = '', $name = '')
704 704 
     {
705 
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
705 
+        return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name));
706 706 
     }
707 707
708 708 
 
@@ -719,7 +719,7 @@  discard block
 
 block discarded – undo
719 719 
     {
720 720 
         return ! empty($config_class)
721 721 
             ? $config_class
722 
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
722 
+            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config';
723 723 
     }
724 724
725 725 
 
@@ -738,17 +738,17 @@  discard block
 
 block discarded – undo
738 738 
         // ensure config class is set to something
739 739 
         $config_class = $this->_set_config_class($config_class, $name);
740 740 
         // run tests 1-4, 6, and 7 to verify all config params are set and valid
741 
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
741 
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
742 742 
             return null;
743 743 
         }
744 744 
         $config_option_name = $this->_generate_config_option_name($section, $name);
745 745 
         // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
746 
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
747 
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
746 
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
747 
+            $this->_addon_option_names[$config_option_name] = $config_class;
748 748 
             $this->update_addon_option_names();
749 749 
         }
750 750 
         // verify the incoming config object but suppress errors
751 
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
751 
+        if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
752 752 
             $config_obj = new $config_class();
753 753 
         }
754 754 
         if (get_option($config_option_name)) {
 
@@ -795,7 +795,7 @@  discard block
 
 block discarded – undo
795 795 
         // get class name of the incoming object
796 796 
         $config_class = get_class($config_obj);
797 797 
         // run tests 1-5 and 9 to verify config
798 
-        if (! $this->_verify_config_params(
798 
+        if ( ! $this->_verify_config_params(
799 799 
             $section,
800 800 
             $name,
801 801 
             $config_class,
 
@@ -807,7 +807,7 @@  discard block
 
 block discarded – undo
807 807 
         }
808 808 
         $config_option_name = $this->_generate_config_option_name($section, $name);
809 809 
         // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
810 
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
810 
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
811 811 
             // save new config to db
812 812 
             if ($this->set_config($section, $name, $config_class, $config_obj)) {
813 813 
                 return true;
 
@@ -833,7 +833,7 @@  discard block
 
 block discarded – undo
833 833 
                             'event_espresso'
834 834 
                         ),
835 835 
                         $config_class,
836 
-                        'EE_Config->' . $section . '->' . $name
836 
+                        'EE_Config->'.$section.'->'.$name
837 837 
                     ),
838 838 
                     __FILE__,
839 839 
                     __FUNCTION__,
 
@@ -859,7 +859,7 @@  discard block
 
 block discarded – undo
859 859 
         // ensure config class is set to something
860 860 
         $config_class = $this->_set_config_class($config_class, $name);
861 861 
         // run tests 1-4, 6 and 7 to verify that all params have been set
862 
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
862 
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
863 863 
             return null;
864 864 
         }
865 865 
         // now test if the requested config object exists, but suppress errors
 
@@ -904,7 +904,7 @@  discard block
 
 block discarded – undo
904 904 
         // retrieve the wp-option for this config class.
905 905 
         $config_option = maybe_unserialize(get_option($config_option_name, array()));
906 906 
         if (empty($config_option)) {
907 
-            EE_Config::log($config_option_name . '-NOT-FOUND');
907 
+            EE_Config::log($config_option_name.'-NOT-FOUND');
908 908 
         }
909 909 
         return $config_option;
910 910 
     }
 
@@ -922,7 +922,7 @@  discard block
 
 block discarded – undo
922 922 
             // copy incoming $_REQUEST and sanitize it so we can save it
923 923 
             $_request = $_REQUEST;
924 924 
             array_walk_recursive($_request, 'sanitize_text_field');
925 
-            $config_log[ (string) microtime(true) ] = array(
925 
+            $config_log[(string) microtime(true)] = array(
926 926 
                 'config_name' => $config_option_name,
927 927 
                 'request'     => $_request,
928 928 
             );
 
@@ -937,7 +937,7 @@  discard block
 
 block discarded – undo
937 937 
      */
938 938 
     public static function trim_log()
939 939 
     {
940 
-        if (! EE_Config::logging_enabled()) {
940 
+        if ( ! EE_Config::logging_enabled()) {
941 941 
             return;
942 942 
         }
943 943 
         $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
 
@@ -961,7 +961,7 @@  discard block
 
 block discarded – undo
961 961 
     public static function get_page_for_posts()
962 962 
     {
963 963 
         $page_for_posts = get_option('page_for_posts');
964 
-        if (! $page_for_posts) {
964 
+        if ( ! $page_for_posts) {
965 965 
             return 'posts';
966 966 
         }
967 967 
         /** @type WPDB $wpdb */
 
@@ -1011,20 +1011,20 @@  discard block
 
 block discarded – undo
1011 1011 
     {
1012 1012 
         // only init widgets on admin pages when not in complete maintenance, and
1013 1013 
         // on frontend when not in any maintenance mode
1014 
-        if (! EE_Maintenance_Mode::instance()->level()
1014 
+        if ( ! EE_Maintenance_Mode::instance()->level()
1015 1015 
             || (
1016 1016 
                 is_admin()
1017 1017 
                 && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
1018 1018 
             )
1019 1019 
         ) {
1020 1020 
             // grab list of installed widgets
1021 
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
1021 
+            $widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR);
1022 1022 
             // filter list of modules to register
1023 1023 
             $widgets_to_register = apply_filters(
1024 1024 
                 'FHEE__EE_Config__register_widgets__widgets_to_register',
1025 1025 
                 $widgets_to_register
1026 1026 
             );
1027 
-            if (! empty($widgets_to_register)) {
1027 
+            if ( ! empty($widgets_to_register)) {
1028 1028 
                 // cycle thru widget folders
1029 1029 
                 foreach ($widgets_to_register as $widget_path) {
1030 1030 
                     // add to list of installed widget modules
 
@@ -1074,31 +1074,31 @@  discard block
 
 block discarded – undo
1074 1074 
         // create classname from widget directory name
1075 1075 
         $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
1076 1076 
         // add class prefix
1077 
-        $widget_class = 'EEW_' . $widget;
1077 
+        $widget_class = 'EEW_'.$widget;
1078 1078 
         // does the widget exist ?
1079 
-        if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) {
1079 
+        if ( ! is_readable($widget_path.DS.$widget_class.$widget_ext)) {
1080 1080 
             $msg = sprintf(
1081 1081 
                 __(
1082 1082 
                     'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
1083 1083 
                     'event_espresso'
1084 1084 
                 ),
1085 1085 
                 $widget_class,
1086 
-                $widget_path . DS . $widget_class . $widget_ext
1086 
+                $widget_path.DS.$widget_class.$widget_ext
1087 1087 
             );
1088 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1088 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1089 1089 
             return;
1090 1090 
         }
1091 1091 
         // load the widget class file
1092 
-        require_once($widget_path . DS . $widget_class . $widget_ext);
1092 
+        require_once($widget_path.DS.$widget_class.$widget_ext);
1093 1093 
         // verify that class exists
1094 
-        if (! class_exists($widget_class)) {
1094 
+        if ( ! class_exists($widget_class)) {
1095 1095 
             $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
1096 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1096 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1097 1097 
             return;
1098 1098 
         }
1099 1099 
         register_widget($widget_class);
1100 1100 
         // add to array of registered widgets
1101 
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext;
1101 
+        EE_Registry::instance()->widgets->{$widget_class} = $widget_path.DS.$widget_class.$widget_ext;
1102 1102 
     }
1103 1103
1104 1104 
 
@@ -1111,18 +1111,18 @@  discard block
 
 block discarded – undo
1111 1111 
     private function _register_modules()
1112 1112 
     {
1113 1113 
         // grab list of installed modules
1114 
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
1114 
+        $modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR);
1115 1115 
         // filter list of modules to register
1116 1116 
         $modules_to_register = apply_filters(
1117 1117 
             'FHEE__EE_Config__register_modules__modules_to_register',
1118 1118 
             $modules_to_register
1119 1119 
         );
1120 
-        if (! empty($modules_to_register)) {
1120 
+        if ( ! empty($modules_to_register)) {
1121 1121 
             // loop through folders
1122 1122 
             foreach ($modules_to_register as $module_path) {
1123 1123 
                 /**TEMPORARILY EXCLUDE gateways from modules for time being**/
1124 
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
1125 
-                    && $module_path !== EE_MODULES . 'gateways'
1124 
+                if ($module_path !== EE_MODULES.'zzz-copy-this-module-template'
1125 
+                    && $module_path !== EE_MODULES.'gateways'
1126 1126 
                 ) {
1127 1127 
                     // add to list of installed modules
1128 1128 
                     EE_Config::register_module($module_path);
 
@@ -1159,25 +1159,25 @@  discard block
 
 block discarded – undo
1159 1159 
             // remove last segment
1160 1160 
             array_pop($module_path);
1161 1161 
             // glue it back together
1162 
-            $module_path = implode(DS, $module_path) . DS;
1162 
+            $module_path = implode(DS, $module_path).DS;
1163 1163 
             // take first segment from file name pieces and sanitize it
1164 1164 
             $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
1165 1165 
             // ensure class prefix is added
1166 
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
1166 
+            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module;
1167 1167 
         } else {
1168 1168 
             // we need to generate the filename based off of the folder name
1169 1169 
             // grab and sanitize module name
1170 1170 
             $module = strtolower(basename($module_path));
1171 1171 
             $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
1172 1172 
             // like trailingslashit()
1173 
-            $module_path = rtrim($module_path, DS) . DS;
1173 
+            $module_path = rtrim($module_path, DS).DS;
1174 1174 
             // create classname from module directory name
1175 1175 
             $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
1176 1176 
             // add class prefix
1177 
-            $module_class = 'EED_' . $module;
1177 
+            $module_class = 'EED_'.$module;
1178 1178 
         }
1179 1179 
         // does the module exist ?
1180 
-        if (! is_readable($module_path . DS . $module_class . $module_ext)) {
1180 
+        if ( ! is_readable($module_path.DS.$module_class.$module_ext)) {
1181 1181 
             $msg = sprintf(
1182 1182 
                 __(
1183 1183 
                     'The requested %s module file could not be found or is not readable due to file permissions.',
 
@@ -1185,19 +1185,19 @@  discard block
 
 block discarded – undo
1185 1185 
                 ),
1186 1186 
                 $module
1187 1187 
             );
1188 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1188 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1189 1189 
             return false;
1190 1190 
         }
1191 1191 
         // load the module class file
1192 
-        require_once($module_path . $module_class . $module_ext);
1192 
+        require_once($module_path.$module_class.$module_ext);
1193 1193 
         // verify that class exists
1194 
-        if (! class_exists($module_class)) {
1194 
+        if ( ! class_exists($module_class)) {
1195 1195 
             $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
1196 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1196 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1197 1197 
             return false;
1198 1198 
         }
1199 1199 
         // add to array of registered modules
1200 
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
1200 
+        EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext;
1201 1201 
         do_action(
1202 1202 
             'AHEE__EE_Config__register_module__complete',
1203 1203 
             $module_class,
 
@@ -1248,26 +1248,26 @@  discard block
 
 block discarded – undo
1248 1248 
     {
1249 1249 
         do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
1250 1250 
         $module = str_replace('EED_', '', $module);
1251 
-        $module_class = 'EED_' . $module;
1252 
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
1251 
+        $module_class = 'EED_'.$module;
1252 
+        if ( ! isset(EE_Registry::instance()->modules->{$module_class})) {
1253 1253 
             $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
1254 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1254 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1255 1255 
             return false;
1256 1256 
         }
1257 1257 
         if (empty($route)) {
1258 1258 
             $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
1259 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1259 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1260 1260 
             return false;
1261 1261 
         }
1262 
-        if (! method_exists('EED_' . $module, $method_name)) {
1262 
+        if ( ! method_exists('EED_'.$module, $method_name)) {
1263 1263 
             $msg = sprintf(
1264 1264 
                 __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
1265 1265 
                 $route
1266 1266 
             );
1267 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1267 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1268 1268 
             return false;
1269 1269 
         }
1270 
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
1270 
+        EE_Config::$_module_route_map[(string) $key][(string) $route] = array('EED_'.$module, $method_name);
1271 1271 
         return true;
1272 1272 
     }
1273 1273 
 
@@ -1284,8 +1284,8 @@  discard block
 
 block discarded – undo
1284 1284 
     {
1285 1285 
         do_action('AHEE__EE_Config__get_route__begin', $route);
1286 1286 
         $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
1287 
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
1288 
-            return EE_Config::$_module_route_map[ $key ][ $route ];
1287 
+        if (isset(EE_Config::$_module_route_map[$key][$route])) {
1288 
+            return EE_Config::$_module_route_map[$key][$route];
1289 1289 
         }
1290 1290 
         return null;
1291 1291 
     }
 
@@ -1317,47 +1317,47 @@  discard block
 
 block discarded – undo
1317 1317 
     public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
1318 1318 
     {
1319 1319 
         do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
1320 
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1320 
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
1321 1321 
             $msg = sprintf(
1322 1322 
                 __('The module route %s for this forward has not been registered.', 'event_espresso'),
1323 1323 
                 $route
1324 1324 
             );
1325 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1325 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1326 1326 
             return false;
1327 1327 
         }
1328 1328 
         if (empty($forward)) {
1329 1329 
             $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
1330 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1330 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1331 1331 
             return false;
1332 1332 
         }
1333 1333 
         if (is_array($forward)) {
1334 
-            if (! isset($forward[1])) {
1334 
+            if ( ! isset($forward[1])) {
1335 1335 
                 $msg = sprintf(
1336 1336 
                     __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
1337 1337 
                     $route
1338 1338 
                 );
1339 
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1339 
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1340 1340 
                 return false;
1341 1341 
             }
1342 
-            if (! method_exists($forward[0], $forward[1])) {
1342 
+            if ( ! method_exists($forward[0], $forward[1])) {
1343 1343 
                 $msg = sprintf(
1344 1344 
                     __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
1345 1345 
                     $forward[1],
1346 1346 
                     $route
1347 1347 
                 );
1348 
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1348 
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1349 1349 
                 return false;
1350 1350 
             }
1351 
-        } elseif (! function_exists($forward)) {
1351 
+        } elseif ( ! function_exists($forward)) {
1352 1352 
             $msg = sprintf(
1353 1353 
                 __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
1354 1354 
                 $forward,
1355 1355 
                 $route
1356 1356 
             );
1357 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1357 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1358 1358 
             return false;
1359 1359 
         }
1360 
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
1360 
+        EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward;
1361 1361 
         return true;
1362 1362 
     }
1363 1363 
 
@@ -1375,10 +1375,10 @@  discard block
 
 block discarded – undo
1375 1375 
     public static function get_forward($route = null, $status = 0, $key = 'ee')
1376 1376 
     {
1377 1377 
         do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
1378 
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
1378 
+        if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) {
1379 1379 
             return apply_filters(
1380 1380 
                 'FHEE__EE_Config__get_forward',
1381 
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
1381 
+                EE_Config::$_module_forward_map[$key][$route][$status],
1382 1382 
                 $route,
1383 1383 
                 $status
1384 1384 
             );
 
@@ -1402,15 +1402,15 @@  discard block
 
 block discarded – undo
1402 1402 
     public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
1403 1403 
     {
1404 1404 
         do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
1405 
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
1405 
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
1406 1406 
             $msg = sprintf(
1407 1407 
                 __('The module route %s for this view has not been registered.', 'event_espresso'),
1408 1408 
                 $route
1409 1409 
             );
1410 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1410 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1411 1411 
             return false;
1412 1412 
         }
1413 
-        if (! is_readable($view)) {
1413 
+        if ( ! is_readable($view)) {
1414 1414 
             $msg = sprintf(
1415 1415 
                 __(
1416 1416 
                     'The %s view file could not be found or is not readable due to file permissions.',
 
@@ -1418,10 +1418,10 @@  discard block
 
 block discarded – undo
1418 1418 
                 ),
1419 1419 
                 $view
1420 1420 
             );
1421 
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
1421 
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
1422 1422 
             return false;
1423 1423 
         }
1424 
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
1424 
+        EE_Config::$_module_view_map[$key][$route][absint($status)] = $view;
1425 1425 
         return true;
1426 1426 
     }
1427 1427 
 
@@ -1439,10 +1439,10 @@  discard block
 
 block discarded – undo
1439 1439 
     public static function get_view($route = null, $status = 0, $key = 'ee')
1440 1440 
     {
1441 1441 
         do_action('AHEE__EE_Config__get_view__begin', $route, $status);
1442 
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
1442 
+        if (isset(EE_Config::$_module_view_map[$key][$route][$status])) {
1443 1443 
             return apply_filters(
1444 1444 
                 'FHEE__EE_Config__get_view',
1445 
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
1445 
+                EE_Config::$_module_view_map[$key][$route][$status],
1446 1446 
                 $route,
1447 1447 
                 $status
1448 1448 
             );
 
@@ -1469,7 +1469,7 @@  discard block
 
 block discarded – undo
1469 1469 
     public static function getLegacyShortcodesManager()
1470 1470 
     {
1471 1471
1472 
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1472 
+        if ( ! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
1473 1473 
             EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
1474 1474 
                 EE_Registry::instance()
1475 1475 
             );
 
@@ -1516,7 +1516,7 @@  discard block
 
 block discarded – undo
1516 1516 
      */
1517 1517 
     public function get_pretty($property)
1518 1518 
     {
1519 
-        if (! property_exists($this, $property)) {
1519 
+        if ( ! property_exists($this, $property)) {
1520 1520 
             throw new EE_Error(
1521 1521 
                 sprintf(
1522 1522 
                     __(
 
@@ -1745,11 +1745,11 @@  discard block
 
 block discarded – undo
1745 1745 
      */
1746 1746 
     public function reg_page_url()
1747 1747 
     {
1748 
-        if (! $this->reg_page_url) {
1748 
+        if ( ! $this->reg_page_url) {
1749 1749 
             $this->reg_page_url = add_query_arg(
1750 1750 
                 array('uts' => time()),
1751 1751 
                 get_permalink($this->reg_page_id)
1752 
-            ) . '#checkout';
1752 
+            ).'#checkout';
1753 1753 
         }
1754 1754 
         return $this->reg_page_url;
1755 1755 
     }
 
@@ -1765,7 +1765,7 @@  discard block
 
 block discarded – undo
1765 1765 
      */
1766 1766 
     public function txn_page_url($query_args = array())
1767 1767 
     {
1768 
-        if (! $this->txn_page_url) {
1768 
+        if ( ! $this->txn_page_url) {
1769 1769 
             $this->txn_page_url = get_permalink($this->txn_page_id);
1770 1770 
         }
1771 1771 
         if ($query_args) {
 
@@ -1786,7 +1786,7 @@  discard block
 
 block discarded – undo
1786 1786 
      */
1787 1787 
     public function thank_you_page_url($query_args = array())
1788 1788 
     {
1789 
-        if (! $this->thank_you_page_url) {
1789 
+        if ( ! $this->thank_you_page_url) {
1790 1790 
             $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
1791 1791 
         }
1792 1792 
         if ($query_args) {
 
@@ -1805,7 +1805,7 @@  discard block
 
 block discarded – undo
1805 1805 
      */
1806 1806 
     public function cancel_page_url()
1807 1807 
     {
1808 
-        if (! $this->cancel_page_url) {
1808 
+        if ( ! $this->cancel_page_url) {
1809 1809 
             $this->cancel_page_url = get_permalink($this->cancel_page_id);
1810 1810 
         }
1811 1811 
         return $this->cancel_page_url;
 
@@ -1848,13 +1848,13 @@  discard block
 
 block discarded – undo
1848 1848 
         $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
1849 1849 
         $option = self::OPTION_NAME_UXIP;
1850 1850 
         // set correct table for query
1851 
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
1851 
+        $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
1852 1852 
         // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
1853 1853 
         // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
1854 1854 
         // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
1855 1855 
         // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
1856 1856 
         // for the purpose of caching.
1857 
-        $pre = apply_filters('pre_option_' . $option, false, $option);
1857 
+        $pre = apply_filters('pre_option_'.$option, false, $option);
1858 1858 
         if (false !== $pre) {
1859 1859 
             EE_Core_Config::$ee_ueip_option = $pre;
1860 1860 
             return EE_Core_Config::$ee_ueip_option;
 
@@ -1868,10 +1868,10 @@  discard block
 
 block discarded – undo
1868 1868 
         if (is_object($row)) {
1869 1869 
             $value = $row->option_value;
1870 1870 
         } else { // option does not exist so use default.
1871 
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
1871 
+            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option);
1872 1872 
             return EE_Core_Config::$ee_ueip_option;
1873 1873 
         }
1874 
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
1874 
+        EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
1875 1875 
         return EE_Core_Config::$ee_ueip_option;
1876 1876 
     }
1877 1877 
 
@@ -2125,37 +2125,37 @@  discard block
 
 block discarded – undo
2125 2125 
         // but override if requested
2126 2126 
         $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
2127 2127 
         // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
2128 
-        if (! empty($CNT_ISO)
2128 
+        if ( ! empty($CNT_ISO)
2129 2129 
             && EE_Maintenance_Mode::instance()->models_can_query()
2130 2130 
             && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
2131 2131 
         ) {
2132 2132 
             // retrieve the country settings from the db, just in case they have been customized
2133 2133 
             $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
2134 2134 
             if ($country instanceof EE_Country) {
2135 
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
2136 
-                $this->name = $country->currency_name_single();    // Dollar
2137 
-                $this->plural = $country->currency_name_plural();    // Dollars
2138 
-                $this->sign = $country->currency_sign();            // currency sign: $
2135 
+                $this->code = $country->currency_code(); // currency code: USD, CAD, EUR
2136 
+                $this->name = $country->currency_name_single(); // Dollar
2137 
+                $this->plural = $country->currency_name_plural(); // Dollars
2138 
+                $this->sign = $country->currency_sign(); // currency sign: $
2139 2139 
                 $this->sign_b4 = $country->currency_sign_before(
2140 
-                );        // currency sign before or after: $TRUE  or  FALSE$
2141 
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
2140 
+                ); // currency sign before or after: $TRUE  or  FALSE$
2141 
+                $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00  3 = 0.000
2142 2142 
                 $this->dec_mrk = $country->currency_decimal_mark(
2143 
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2143 
+                ); // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2144 2144 
                 $this->thsnds = $country->currency_thousands_separator(
2145 
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2145 
+                ); // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2146 2146 
             }
2147 2147 
         }
2148 2148 
         // fallback to hardcoded defaults, in case the above failed
2149 2149 
         if (empty($this->code)) {
2150 2150 
             // set default currency settings
2151 
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
2152 
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
2153 
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
2154 
-            $this->sign = '$';    // currency sign: $
2155 
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
2156 
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
2157 
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2158 
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2151 
+            $this->code = 'USD'; // currency code: USD, CAD, EUR
2152 
+            $this->name = __('Dollar', 'event_espresso'); // Dollar
2153 
+            $this->plural = __('Dollars', 'event_espresso'); // Dollars
2154 
+            $this->sign = '$'; // currency sign: $
2155 
+            $this->sign_b4 = true; // currency sign before or after: $TRUE  or  FALSE$
2156 
+            $this->dec_plc = 2; // decimal places: 2 = 0.00  3 = 0.000
2157 
+            $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
2158 
+            $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
2159 2159 
         }
2160 2160 
     }
2161 2161 
 }
 
@@ -2414,8 +2414,8 @@  discard block
 
 block discarded – undo
2414 2414 
             $closing_a_tag = '';
2415 2415 
             if (function_exists('get_privacy_policy_url')) {
2416 2416 
                 $privacy_page_url = get_privacy_policy_url();
2417 
-                if (! empty($privacy_page_url)) {
2418 
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
2417 
+                if ( ! empty($privacy_page_url)) {
2418 
+                    $opening_a_tag = '<a href="'.$privacy_page_url.'" target="_blank">';
2419 2419 
                     $closing_a_tag = '</a>';
2420 2420 
                 }
2421 2421 
             }
 
@@ -2627,7 +2627,7 @@  discard block
 
 block discarded – undo
2627 2627 
     public function log_file_name($reset = false)
2628 2628 
     {
2629 2629 
         if (empty($this->log_file_name) || $reset) {
2630 
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
2630 
+            $this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt';
2631 2631 
             EE_Config::instance()->update_espresso_config(false, false);
2632 2632 
         }
2633 2633 
         return $this->log_file_name;
 
@@ -2641,7 +2641,7 @@  discard block
 
 block discarded – undo
2641 2641 
     public function debug_file_name($reset = false)
2642 2642 
     {
2643 2643 
         if (empty($this->debug_file_name) || $reset) {
2644 
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
2644 
+            $this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt';
2645 2645 
             EE_Config::instance()->update_espresso_config(false, false);
2646 2646 
         }
2647 2647 
         return $this->debug_file_name;
 
@@ -2845,21 +2845,21 @@  discard block
 
 block discarded – undo
2845 2845 
         $this->use_google_maps = true;
2846 2846 
         $this->google_map_api_key = '';
2847 2847 
         // for event details pages (reg page)
2848 
-        $this->event_details_map_width = 585;            // ee_map_width_single
2849 
-        $this->event_details_map_height = 362;            // ee_map_height_single
2850 
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
2851 
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
2852 
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
2853 
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
2854 
-        $this->event_details_map_align = 'center';            // ee_map_align_single
2848 
+        $this->event_details_map_width = 585; // ee_map_width_single
2849 
+        $this->event_details_map_height = 362; // ee_map_height_single
2850 
+        $this->event_details_map_zoom = 14; // ee_map_zoom_single
2851 
+        $this->event_details_display_nav = true; // ee_map_nav_display_single
2852 
+        $this->event_details_nav_size = false; // ee_map_nav_size_single
2853 
+        $this->event_details_control_type = 'default'; // ee_map_type_control_single
2854 
+        $this->event_details_map_align = 'center'; // ee_map_align_single
2855 2855 
         // for event list pages
2856 
-        $this->event_list_map_width = 300;            // ee_map_width
2857 
-        $this->event_list_map_height = 185;        // ee_map_height
2858 
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
2859 
-        $this->event_list_display_nav = false;        // ee_map_nav_display
2860 
-        $this->event_list_nav_size = true;            // ee_map_nav_size
2861 
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
2862 
-        $this->event_list_map_align = 'center';            // ee_map_align
2856 
+        $this->event_list_map_width = 300; // ee_map_width
2857 
+        $this->event_list_map_height = 185; // ee_map_height
2858 
+        $this->event_list_map_zoom = 12; // ee_map_zoom
2859 
+        $this->event_list_display_nav = false; // ee_map_nav_display
2860 
+        $this->event_list_nav_size = true; // ee_map_nav_size
2861 
+        $this->event_list_control_type = 'dropdown'; // ee_map_type_control
2862 
+        $this->event_list_map_align = 'center'; // ee_map_align
2863 2863 
     }
2864 2864 
 }
2865 2865 
 
@@ -3177,7 +3177,7 @@  discard block
 
 block discarded – undo
3177 3177 
      */
3178 3178 
     public function max_input_vars_limit_check($input_count = 0)
3179 3179 
     {
3180 
-        if (! empty($this->php->max_input_vars)
3180 
+        if ( ! empty($this->php->max_input_vars)
3181 3181 
             && ($input_count >= $this->php->max_input_vars)
3182 3182 
         ) {
3183 3183 
             return sprintf(
Please login to merge, or discard this patch.
core/services/request/Request.php 1 patch
Indentation   +602 added lines, -602 removed lines patch added patch discarded remove patch 
@@ -17,606 +17,606 @@
 
 block discarded – undo
17 17 
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
18 18 
 {
19 19
20 
-    /**
21 
-     * $_GET parameters
22 
-     *
23 
-     * @var array $get
24 
-     */
25 
-    private $get;
26 
-
27 
-    /**
28 
-     * $_POST parameters
29 
-     *
30 
-     * @var array $post
31 
-     */
32 
-    private $post;
33 
-
34 
-    /**
35 
-     * $_COOKIE parameters
36 
-     *
37 
-     * @var array $cookie
38 
-     */
39 
-    private $cookie;
40 
-
41 
-    /**
42 
-     * $_SERVER parameters
43 
-     *
44 
-     * @var array $server
45 
-     */
46 
-    private $server;
47 
-
48 
-    /**
49 
-     * $_REQUEST parameters
50 
-     *
51 
-     * @var array $request
52 
-     */
53 
-    private $request;
54 
-
55 
-    /**
56 
-     * @var RequestTypeContextCheckerInterface
57 
-     */
58 
-    private $request_type;
59 
-
60 
-    /**
61 
-     * IP address for request
62 
-     *
63 
-     * @var string $ip_address
64 
-     */
65 
-    private $ip_address;
66 
-
67 
-    /**
68 
-     * @var string $user_agent
69 
-     */
70 
-    private $user_agent;
71 
-
72 
-    /**
73 
-     * true if current user appears to be some kind of bot
74 
-     *
75 
-     * @var bool $is_bot
76 
-     */
77 
-    private $is_bot;
78 
-
79 
-
80 
-    /**
81 
-     * @param array $get
82 
-     * @param array $post
83 
-     * @param array $cookie
84 
-     * @param array $server
85 
-     */
86 
-    public function __construct(array $get, array $post, array $cookie, array $server)
87 
-    {
88 
-        // grab request vars
89 
-        $this->get = $get;
90 
-        $this->post = $post;
91 
-        $this->cookie = $cookie;
92 
-        $this->server = $server;
93 
-        $this->request = array_merge($this->get, $this->post);
94 
-        $this->ip_address = $this->visitorIp();
95 
-    }
96 
-
97 
-
98 
-    /**
99 
-     * @param RequestTypeContextCheckerInterface $type
100 
-     */
101 
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
102 
-    {
103 
-        $this->request_type = $type;
104 
-    }
105 
-
106 
-
107 
-    /**
108 
-     * @return array
109 
-     */
110 
-    public function getParams()
111 
-    {
112 
-        return $this->get;
113 
-    }
114 
-
115 
-
116 
-    /**
117 
-     * @return array
118 
-     */
119 
-    public function postParams()
120 
-    {
121 
-        return $this->post;
122 
-    }
123 
-
124 
-
125 
-    /**
126 
-     * @return array
127 
-     */
128 
-    public function cookieParams()
129 
-    {
130 
-        return $this->cookie;
131 
-    }
132 
-
133 
-
134 
-    /**
135 
-     * @return array
136 
-     */
137 
-    public function serverParams()
138 
-    {
139 
-        return $this->server;
140 
-    }
141 
-
142 
-
143 
-    /**
144 
-     * returns contents of $_REQUEST
145 
-     *
146 
-     * @return array
147 
-     */
148 
-    public function requestParams()
149 
-    {
150 
-        return $this->request;
151 
-    }
152 
-
153 
-
154 
-    /**
155 
-     * @param      $key
156 
-     * @param      $value
157 
-     * @param bool $override_ee
158 
-     * @return    void
159 
-     */
160 
-    public function setRequestParam($key, $value, $override_ee = false)
161 
-    {
162 
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
163 
-        if ($key !== 'ee'
164 
-            || ($key === 'ee' && empty($this->request['ee']))
165 
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
166 
-        ) {
167 
-            $this->request[ $key ] = $value;
168 
-        }
169 
-    }
170 
-
171 
-
172 
-    /**
173 
-     * returns   the value for a request param if the given key exists
174 
-     *
175 
-     * @param       $key
176 
-     * @param null  $default
177 
-     * @return mixed
178 
-     */
179 
-    public function getRequestParam($key, $default = null)
180 
-    {
181 
-        return $this->requestParameterDrillDown($key, $default, 'get');
182 
-    }
183 
-
184 
-
185 
-    /**
186 
-     * check if param exists
187 
-     *
188 
-     * @param       $key
189 
-     * @return bool
190 
-     */
191 
-    public function requestParamIsSet($key)
192 
-    {
193 
-        return $this->requestParameterDrillDown($key);
194 
-    }
195 
-
196 
-
197 
-    /**
198 
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
199 
-     * and return the value for the first match found
200 
-     * wildcards can be either of the following:
201 
-     *      ? to represent a single character of any type
202 
-     *      * to represent one or more characters of any type
203 
-     *
204 
-     * @param string     $pattern
205 
-     * @param null|mixed $default
206 
-     * @return mixed
207 
-     */
208 
-    public function getMatch($pattern, $default = null)
209 
-    {
210 
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
211 
-    }
212 
-
213 
-
214 
-    /**
215 
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
216 
-     * wildcards can be either of the following:
217 
-     *      ? to represent a single character of any type
218 
-     *      * to represent one or more characters of any type
219 
-     * returns true if a match is found or false if not
220 
-     *
221 
-     * @param string $pattern
222 
-     * @return bool
223 
-     */
224 
-    public function matches($pattern)
225 
-    {
226 
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
227 
-    }
228 
-
229 
-
230 
-    /**
231 
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
232 
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
233 
-     *                                      and used to search through the current request's parameter keys
234 
-     * @param array  $request_params        The array of request parameters to search through
235 
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
236 
-     *                                      Default is null
237 
-     * @param string $return                [optional] Controls what kind of value is returned.
238 
-     *                                      Options are:
239 
-     *                                      'bool' will return true or false if match is found or not
240 
-     *                                      'key' will return the first key found that matches the supplied pattern
241 
-     *                                      'value' will return the value for the first request parameter
242 
-     *                                      whose key matches the supplied pattern
243 
-     *                                      Default is 'value'
244 
-     * @return boolean|string
245 
-     */
246 
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
247 
-    {
248 
-        $return = in_array($return, array('bool', 'key', 'value'), true)
249 
-            ? $return
250 
-            : 'is_set';
251 
-        // replace wildcard chars with regex chars
252 
-        $pattern = str_replace(
253 
-            array("\*", "\?"),
254 
-            array('.*', '.'),
255 
-            preg_quote($pattern, '/')
256 
-        );
257 
-        foreach ($request_params as $key => $request_param) {
258 
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
259 
-                // return value for request param
260 
-                if ($return === 'value') {
261 
-                    return $request_params[ $key ];
262 
-                }
263 
-                // or actual key or true just to indicate it was found
264 
-                return $return === 'key' ? $key : true;
265 
-            }
266 
-        }
267 
-        // match not found so return default value or false
268 
-        return $return === 'value' ? $default : false;
269 
-    }
270 
-
271 
-
272 
-    /**
273 
-     * the supplied key can be a simple string to represent a "top-level" request parameter
274 
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
275 
-     * by using square brackets to surround keys for deeper array elements.
276 
-     * For example :
277 
-     * if the supplied $key was: "first[second][third]"
278 
-     * then this will attempt to drill down into the request parameter array to find a value.
279 
-     * Given the following request parameters:
280 
-     *  array(
281 
-     *      'first' => array(
282 
-     *          'second' => array(
283 
-     *              'third' => 'has a value'
284 
-     *          )
285 
-     *      )
286 
-     *  )
287 
-     * would return true if default parameters were set
288 
-     *
289 
-     * @param string $callback
290 
-     * @param        $key
291 
-     * @param null   $default
292 
-     * @param array  $request_params
293 
-     * @return bool|mixed|null
294 
-     */
295 
-    private function requestParameterDrillDown(
296 
-        $key,
297 
-        $default = null,
298 
-        $callback = 'is_set',
299 
-        array $request_params = array()
300 
-    ) {
301 
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
302 
-            ? $callback
303 
-            : 'is_set';
304 
-        $request_params = ! empty($request_params)
305 
-            ? $request_params
306 
-            : $this->request;
307 
-        // does incoming key represent an array like 'first[second][third]'  ?
308 
-        if (strpos($key, '[') !== false) {
309 
-            // turn it into an actual array
310 
-            $key = str_replace(']', '', $key);
311 
-            $keys = explode('[', $key);
312 
-            $key = array_shift($keys);
313 
-            if ($callback === 'match') {
314 
-                $real_key = $this->match($key, $request_params, $default, 'key');
315 
-                $key = $real_key ? $real_key : $key;
316 
-            }
317 
-            // check if top level key exists
318 
-            if (isset($request_params[ $key ])) {
319 
-                // build a new key to pass along like: 'second[third]'
320 
-                // or just 'second' depending on depth of keys
321 
-                $key_string = array_shift($keys);
322 
-                if (! empty($keys)) {
323 
-                    $key_string .= '[' . implode('][', $keys) . ']';
324 
-                }
325 
-                return $this->requestParameterDrillDown(
326 
-                    $key_string,
327 
-                    $default,
328 
-                    $callback,
329 
-                    $request_params[ $key ]
330 
-                );
331 
-            }
332 
-        }
333 
-        if ($callback === 'is_set') {
334 
-            return isset($request_params[ $key ]);
335 
-        }
336 
-        if ($callback === 'match') {
337 
-            return $this->match($key, $request_params, $default);
338 
-        }
339 
-        return isset($request_params[ $key ])
340 
-            ? $request_params[ $key ]
341 
-            : $default;
342 
-    }
343 
-
344 
-
345 
-    /**
346 
-     * remove param
347 
-     *
348 
-     * @param      $key
349 
-     * @param bool $unset_from_global_too
350 
-     */
351 
-    public function unSetRequestParam($key, $unset_from_global_too = false)
352 
-    {
353 
-        unset($this->request[ $key ]);
354 
-        if ($unset_from_global_too) {
355 
-            unset($_REQUEST[ $key ]);
356 
-        }
357 
-    }
358 
-
359 
-
360 
-    /**
361 
-     * @return string
362 
-     */
363 
-    public function ipAddress()
364 
-    {
365 
-        return $this->ip_address;
366 
-    }
367 
-
368 
-
369 
-    /**
370 
-     * attempt to get IP address of current visitor from server
371 
-     * plz see: http://stackoverflow.com/a/2031935/1475279
372 
-     *
373 
-     * @access public
374 
-     * @return string
375 
-     */
376 
-    private function visitorIp()
377 
-    {
378 
-        $visitor_ip = '0.0.0.0';
379 
-        $server_keys = array(
380 
-            'HTTP_CLIENT_IP',
381 
-            'HTTP_X_FORWARDED_FOR',
382 
-            'HTTP_X_FORWARDED',
383 
-            'HTTP_X_CLUSTER_CLIENT_IP',
384 
-            'HTTP_FORWARDED_FOR',
385 
-            'HTTP_FORWARDED',
386 
-            'REMOTE_ADDR',
387 
-        );
388 
-        foreach ($server_keys as $key) {
389 
-            if (isset($this->server[ $key ])) {
390 
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
391 
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
392 
-                        $visitor_ip = $ip;
393 
-                    }
394 
-                }
395 
-            }
396 
-        }
397 
-        return $visitor_ip;
398 
-    }
399 
-
400 
-
401 
-    /**
402 
-     * @return string
403 
-     */
404 
-    public function requestUri()
405 
-    {
406 
-        $request_uri = filter_input(
407 
-            INPUT_SERVER,
408 
-            'REQUEST_URI',
409 
-            FILTER_SANITIZE_URL,
410 
-            FILTER_NULL_ON_FAILURE
411 
-        );
412 
-        if (empty($request_uri)) {
413 
-            // fallback sanitization if the above fails
414 
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
415 
-        }
416 
-        return $request_uri;
417 
-    }
418 
-
419 
-
420 
-    /**
421 
-     * @return string
422 
-     */
423 
-    public function userAgent()
424 
-    {
425 
-        return $this->user_agent;
426 
-    }
427 
-
428 
-
429 
-    /**
430 
-     * @param string $user_agent
431 
-     */
432 
-    public function setUserAgent($user_agent = '')
433 
-    {
434 
-        if ($user_agent === '' || ! is_string($user_agent)) {
435 
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
436 
-        }
437 
-        $this->user_agent = $user_agent;
438 
-    }
439 
-
440 
-
441 
-    /**
442 
-     * @return bool
443 
-     */
444 
-    public function isBot()
445 
-    {
446 
-        return $this->is_bot;
447 
-    }
448 
-
449 
-
450 
-    /**
451 
-     * @param bool $is_bot
452 
-     */
453 
-    public function setIsBot($is_bot)
454 
-    {
455 
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
456 
-    }
457 
-
458 
-
459 
-    /**
460 
-     * @return bool
461 
-     */
462 
-    public function isActivation()
463 
-    {
464 
-        return $this->request_type->isActivation();
465 
-    }
466 
-
467 
-
468 
-    /**
469 
-     * @param $is_activation
470 
-     * @return bool
471 
-     */
472 
-    public function setIsActivation($is_activation)
473 
-    {
474 
-        return $this->request_type->setIsActivation($is_activation);
475 
-    }
476 
-
477 
-
478 
-    /**
479 
-     * @return bool
480 
-     */
481 
-    public function isAdmin()
482 
-    {
483 
-        return $this->request_type->isAdmin();
484 
-    }
485 
-
486 
-
487 
-    /**
488 
-     * @return bool
489 
-     */
490 
-    public function isAdminAjax()
491 
-    {
492 
-        return $this->request_type->isAdminAjax();
493 
-    }
494 
-
495 
-
496 
-    /**
497 
-     * @return bool
498 
-     */
499 
-    public function isAjax()
500 
-    {
501 
-        return $this->request_type->isAjax();
502 
-    }
503 
-
504 
-
505 
-    /**
506 
-     * @return bool
507 
-     */
508 
-    public function isEeAjax()
509 
-    {
510 
-        return $this->request_type->isEeAjax();
511 
-    }
512 
-
513 
-
514 
-    /**
515 
-     * @return bool
516 
-     */
517 
-    public function isOtherAjax()
518 
-    {
519 
-        return $this->request_type->isOtherAjax();
520 
-    }
521 
-
522 
-
523 
-    /**
524 
-     * @return bool
525 
-     */
526 
-    public function isApi()
527 
-    {
528 
-        return $this->request_type->isApi();
529 
-    }
530 
-
531 
-
532 
-    /**
533 
-     * @return bool
534 
-     */
535 
-    public function isCli()
536 
-    {
537 
-        return $this->request_type->isCli();
538 
-    }
539 
-
540 
-
541 
-    /**
542 
-     * @return bool
543 
-     */
544 
-    public function isCron()
545 
-    {
546 
-        return $this->request_type->isCron();
547 
-    }
548 
-
549 
-
550 
-    /**
551 
-     * @return bool
552 
-     */
553 
-    public function isFeed()
554 
-    {
555 
-        return $this->request_type->isFeed();
556 
-    }
557 
-
558 
-
559 
-    /**
560 
-     * @return bool
561 
-     */
562 
-    public function isFrontend()
563 
-    {
564 
-        return $this->request_type->isFrontend();
565 
-    }
566 
-
567 
-
568 
-    /**
569 
-     * @return bool
570 
-     */
571 
-    public function isFrontAjax()
572 
-    {
573 
-        return $this->request_type->isFrontAjax();
574 
-    }
575 
-
576 
-
577 
-    /**
578 
-     * @return bool
579 
-     */
580 
-    public function isIframe()
581 
-    {
582 
-        return $this->request_type->isIframe();
583 
-    }
584 
-
585 
-
586 
-    /**
587 
-     * @return bool
588 
-     */
589 
-    public function isWordPressApi()
590 
-    {
591 
-        return $this->request_type->isWordPressApi();
592 
-    }
593 
-
594 
-
595 
-
596 
-    /**
597 
-     * @return bool
598 
-     */
599 
-    public function isWordPressHeartbeat()
600 
-    {
601 
-        return $this->request_type->isWordPressHeartbeat();
602 
-    }
603 
-
604 
-
605 
-
606 
-    /**
607 
-     * @return bool
608 
-     */
609 
-    public function isWordPressScrape()
610 
-    {
611 
-        return $this->request_type->isWordPressScrape();
612 
-    }
613 
-
614 
-
615 
-    /**
616 
-     * @return string
617 
-     */
618 
-    public function slug()
619 
-    {
620 
-        return $this->request_type->slug();
621 
-    }
20 
+	/**
21 
+	 * $_GET parameters
22 
+	 *
23 
+	 * @var array $get
24 
+	 */
25 
+	private $get;
26 
+
27 
+	/**
28 
+	 * $_POST parameters
29 
+	 *
30 
+	 * @var array $post
31 
+	 */
32 
+	private $post;
33 
+
34 
+	/**
35 
+	 * $_COOKIE parameters
36 
+	 *
37 
+	 * @var array $cookie
38 
+	 */
39 
+	private $cookie;
40 
+
41 
+	/**
42 
+	 * $_SERVER parameters
43 
+	 *
44 
+	 * @var array $server
45 
+	 */
46 
+	private $server;
47 
+
48 
+	/**
49 
+	 * $_REQUEST parameters
50 
+	 *
51 
+	 * @var array $request
52 
+	 */
53 
+	private $request;
54 
+
55 
+	/**
56 
+	 * @var RequestTypeContextCheckerInterface
57 
+	 */
58 
+	private $request_type;
59 
+
60 
+	/**
61 
+	 * IP address for request
62 
+	 *
63 
+	 * @var string $ip_address
64 
+	 */
65 
+	private $ip_address;
66 
+
67 
+	/**
68 
+	 * @var string $user_agent
69 
+	 */
70 
+	private $user_agent;
71 
+
72 
+	/**
73 
+	 * true if current user appears to be some kind of bot
74 
+	 *
75 
+	 * @var bool $is_bot
76 
+	 */
77 
+	private $is_bot;
78 
+
79 
+
80 
+	/**
81 
+	 * @param array $get
82 
+	 * @param array $post
83 
+	 * @param array $cookie
84 
+	 * @param array $server
85 
+	 */
86 
+	public function __construct(array $get, array $post, array $cookie, array $server)
87 
+	{
88 
+		// grab request vars
89 
+		$this->get = $get;
90 
+		$this->post = $post;
91 
+		$this->cookie = $cookie;
92 
+		$this->server = $server;
93 
+		$this->request = array_merge($this->get, $this->post);
94 
+		$this->ip_address = $this->visitorIp();
95 
+	}
96 
+
97 
+
98 
+	/**
99 
+	 * @param RequestTypeContextCheckerInterface $type
100 
+	 */
101 
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
102 
+	{
103 
+		$this->request_type = $type;
104 
+	}
105 
+
106 
+
107 
+	/**
108 
+	 * @return array
109 
+	 */
110 
+	public function getParams()
111 
+	{
112 
+		return $this->get;
113 
+	}
114 
+
115 
+
116 
+	/**
117 
+	 * @return array
118 
+	 */
119 
+	public function postParams()
120 
+	{
121 
+		return $this->post;
122 
+	}
123 
+
124 
+
125 
+	/**
126 
+	 * @return array
127 
+	 */
128 
+	public function cookieParams()
129 
+	{
130 
+		return $this->cookie;
131 
+	}
132 
+
133 
+
134 
+	/**
135 
+	 * @return array
136 
+	 */
137 
+	public function serverParams()
138 
+	{
139 
+		return $this->server;
140 
+	}
141 
+
142 
+
143 
+	/**
144 
+	 * returns contents of $_REQUEST
145 
+	 *
146 
+	 * @return array
147 
+	 */
148 
+	public function requestParams()
149 
+	{
150 
+		return $this->request;
151 
+	}
152 
+
153 
+
154 
+	/**
155 
+	 * @param      $key
156 
+	 * @param      $value
157 
+	 * @param bool $override_ee
158 
+	 * @return    void
159 
+	 */
160 
+	public function setRequestParam($key, $value, $override_ee = false)
161 
+	{
162 
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
163 
+		if ($key !== 'ee'
164 
+			|| ($key === 'ee' && empty($this->request['ee']))
165 
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
166 
+		) {
167 
+			$this->request[ $key ] = $value;
168 
+		}
169 
+	}
170 
+
171 
+
172 
+	/**
173 
+	 * returns   the value for a request param if the given key exists
174 
+	 *
175 
+	 * @param       $key
176 
+	 * @param null  $default
177 
+	 * @return mixed
178 
+	 */
179 
+	public function getRequestParam($key, $default = null)
180 
+	{
181 
+		return $this->requestParameterDrillDown($key, $default, 'get');
182 
+	}
183 
+
184 
+
185 
+	/**
186 
+	 * check if param exists
187 
+	 *
188 
+	 * @param       $key
189 
+	 * @return bool
190 
+	 */
191 
+	public function requestParamIsSet($key)
192 
+	{
193 
+		return $this->requestParameterDrillDown($key);
194 
+	}
195 
+
196 
+
197 
+	/**
198 
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
199 
+	 * and return the value for the first match found
200 
+	 * wildcards can be either of the following:
201 
+	 *      ? to represent a single character of any type
202 
+	 *      * to represent one or more characters of any type
203 
+	 *
204 
+	 * @param string     $pattern
205 
+	 * @param null|mixed $default
206 
+	 * @return mixed
207 
+	 */
208 
+	public function getMatch($pattern, $default = null)
209 
+	{
210 
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
211 
+	}
212 
+
213 
+
214 
+	/**
215 
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
216 
+	 * wildcards can be either of the following:
217 
+	 *      ? to represent a single character of any type
218 
+	 *      * to represent one or more characters of any type
219 
+	 * returns true if a match is found or false if not
220 
+	 *
221 
+	 * @param string $pattern
222 
+	 * @return bool
223 
+	 */
224 
+	public function matches($pattern)
225 
+	{
226 
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
227 
+	}
228 
+
229 
+
230 
+	/**
231 
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
232 
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
233 
+	 *                                      and used to search through the current request's parameter keys
234 
+	 * @param array  $request_params        The array of request parameters to search through
235 
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
236 
+	 *                                      Default is null
237 
+	 * @param string $return                [optional] Controls what kind of value is returned.
238 
+	 *                                      Options are:
239 
+	 *                                      'bool' will return true or false if match is found or not
240 
+	 *                                      'key' will return the first key found that matches the supplied pattern
241 
+	 *                                      'value' will return the value for the first request parameter
242 
+	 *                                      whose key matches the supplied pattern
243 
+	 *                                      Default is 'value'
244 
+	 * @return boolean|string
245 
+	 */
246 
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
247 
+	{
248 
+		$return = in_array($return, array('bool', 'key', 'value'), true)
249 
+			? $return
250 
+			: 'is_set';
251 
+		// replace wildcard chars with regex chars
252 
+		$pattern = str_replace(
253 
+			array("\*", "\?"),
254 
+			array('.*', '.'),
255 
+			preg_quote($pattern, '/')
256 
+		);
257 
+		foreach ($request_params as $key => $request_param) {
258 
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
259 
+				// return value for request param
260 
+				if ($return === 'value') {
261 
+					return $request_params[ $key ];
262 
+				}
263 
+				// or actual key or true just to indicate it was found
264 
+				return $return === 'key' ? $key : true;
265 
+			}
266 
+		}
267 
+		// match not found so return default value or false
268 
+		return $return === 'value' ? $default : false;
269 
+	}
270 
+
271 
+
272 
+	/**
273 
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
274 
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
275 
+	 * by using square brackets to surround keys for deeper array elements.
276 
+	 * For example :
277 
+	 * if the supplied $key was: "first[second][third]"
278 
+	 * then this will attempt to drill down into the request parameter array to find a value.
279 
+	 * Given the following request parameters:
280 
+	 *  array(
281 
+	 *      'first' => array(
282 
+	 *          'second' => array(
283 
+	 *              'third' => 'has a value'
284 
+	 *          )
285 
+	 *      )
286 
+	 *  )
287 
+	 * would return true if default parameters were set
288 
+	 *
289 
+	 * @param string $callback
290 
+	 * @param        $key
291 
+	 * @param null   $default
292 
+	 * @param array  $request_params
293 
+	 * @return bool|mixed|null
294 
+	 */
295 
+	private function requestParameterDrillDown(
296 
+		$key,
297 
+		$default = null,
298 
+		$callback = 'is_set',
299 
+		array $request_params = array()
300 
+	) {
301 
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
302 
+			? $callback
303 
+			: 'is_set';
304 
+		$request_params = ! empty($request_params)
305 
+			? $request_params
306 
+			: $this->request;
307 
+		// does incoming key represent an array like 'first[second][third]'  ?
308 
+		if (strpos($key, '[') !== false) {
309 
+			// turn it into an actual array
310 
+			$key = str_replace(']', '', $key);
311 
+			$keys = explode('[', $key);
312 
+			$key = array_shift($keys);
313 
+			if ($callback === 'match') {
314 
+				$real_key = $this->match($key, $request_params, $default, 'key');
315 
+				$key = $real_key ? $real_key : $key;
316 
+			}
317 
+			// check if top level key exists
318 
+			if (isset($request_params[ $key ])) {
319 
+				// build a new key to pass along like: 'second[third]'
320 
+				// or just 'second' depending on depth of keys
321 
+				$key_string = array_shift($keys);
322 
+				if (! empty($keys)) {
323 
+					$key_string .= '[' . implode('][', $keys) . ']';
324 
+				}
325 
+				return $this->requestParameterDrillDown(
326 
+					$key_string,
327 
+					$default,
328 
+					$callback,
329 
+					$request_params[ $key ]
330 
+				);
331 
+			}
332 
+		}
333 
+		if ($callback === 'is_set') {
334 
+			return isset($request_params[ $key ]);
335 
+		}
336 
+		if ($callback === 'match') {
337 
+			return $this->match($key, $request_params, $default);
338 
+		}
339 
+		return isset($request_params[ $key ])
340 
+			? $request_params[ $key ]
341 
+			: $default;
342 
+	}
343 
+
344 
+
345 
+	/**
346 
+	 * remove param
347 
+	 *
348 
+	 * @param      $key
349 
+	 * @param bool $unset_from_global_too
350 
+	 */
351 
+	public function unSetRequestParam($key, $unset_from_global_too = false)
352 
+	{
353 
+		unset($this->request[ $key ]);
354 
+		if ($unset_from_global_too) {
355 
+			unset($_REQUEST[ $key ]);
356 
+		}
357 
+	}
358 
+
359 
+
360 
+	/**
361 
+	 * @return string
362 
+	 */
363 
+	public function ipAddress()
364 
+	{
365 
+		return $this->ip_address;
366 
+	}
367 
+
368 
+
369 
+	/**
370 
+	 * attempt to get IP address of current visitor from server
371 
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
372 
+	 *
373 
+	 * @access public
374 
+	 * @return string
375 
+	 */
376 
+	private function visitorIp()
377 
+	{
378 
+		$visitor_ip = '0.0.0.0';
379 
+		$server_keys = array(
380 
+			'HTTP_CLIENT_IP',
381 
+			'HTTP_X_FORWARDED_FOR',
382 
+			'HTTP_X_FORWARDED',
383 
+			'HTTP_X_CLUSTER_CLIENT_IP',
384 
+			'HTTP_FORWARDED_FOR',
385 
+			'HTTP_FORWARDED',
386 
+			'REMOTE_ADDR',
387 
+		);
388 
+		foreach ($server_keys as $key) {
389 
+			if (isset($this->server[ $key ])) {
390 
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
391 
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
392 
+						$visitor_ip = $ip;
393 
+					}
394 
+				}
395 
+			}
396 
+		}
397 
+		return $visitor_ip;
398 
+	}
399 
+
400 
+
401 
+	/**
402 
+	 * @return string
403 
+	 */
404 
+	public function requestUri()
405 
+	{
406 
+		$request_uri = filter_input(
407 
+			INPUT_SERVER,
408 
+			'REQUEST_URI',
409 
+			FILTER_SANITIZE_URL,
410 
+			FILTER_NULL_ON_FAILURE
411 
+		);
412 
+		if (empty($request_uri)) {
413 
+			// fallback sanitization if the above fails
414 
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
415 
+		}
416 
+		return $request_uri;
417 
+	}
418 
+
419 
+
420 
+	/**
421 
+	 * @return string
422 
+	 */
423 
+	public function userAgent()
424 
+	{
425 
+		return $this->user_agent;
426 
+	}
427 
+
428 
+
429 
+	/**
430 
+	 * @param string $user_agent
431 
+	 */
432 
+	public function setUserAgent($user_agent = '')
433 
+	{
434 
+		if ($user_agent === '' || ! is_string($user_agent)) {
435 
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
436 
+		}
437 
+		$this->user_agent = $user_agent;
438 
+	}
439 
+
440 
+
441 
+	/**
442 
+	 * @return bool
443 
+	 */
444 
+	public function isBot()
445 
+	{
446 
+		return $this->is_bot;
447 
+	}
448 
+
449 
+
450 
+	/**
451 
+	 * @param bool $is_bot
452 
+	 */
453 
+	public function setIsBot($is_bot)
454 
+	{
455 
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
456 
+	}
457 
+
458 
+
459 
+	/**
460 
+	 * @return bool
461 
+	 */
462 
+	public function isActivation()
463 
+	{
464 
+		return $this->request_type->isActivation();
465 
+	}
466 
+
467 
+
468 
+	/**
469 
+	 * @param $is_activation
470 
+	 * @return bool
471 
+	 */
472 
+	public function setIsActivation($is_activation)
473 
+	{
474 
+		return $this->request_type->setIsActivation($is_activation);
475 
+	}
476 
+
477 
+
478 
+	/**
479 
+	 * @return bool
480 
+	 */
481 
+	public function isAdmin()
482 
+	{
483 
+		return $this->request_type->isAdmin();
484 
+	}
485 
+
486 
+
487 
+	/**
488 
+	 * @return bool
489 
+	 */
490 
+	public function isAdminAjax()
491 
+	{
492 
+		return $this->request_type->isAdminAjax();
493 
+	}
494 
+
495 
+
496 
+	/**
497 
+	 * @return bool
498 
+	 */
499 
+	public function isAjax()
500 
+	{
501 
+		return $this->request_type->isAjax();
502 
+	}
503 
+
504 
+
505 
+	/**
506 
+	 * @return bool
507 
+	 */
508 
+	public function isEeAjax()
509 
+	{
510 
+		return $this->request_type->isEeAjax();
511 
+	}
512 
+
513 
+
514 
+	/**
515 
+	 * @return bool
516 
+	 */
517 
+	public function isOtherAjax()
518 
+	{
519 
+		return $this->request_type->isOtherAjax();
520 
+	}
521 
+
522 
+
523 
+	/**
524 
+	 * @return bool
525 
+	 */
526 
+	public function isApi()
527 
+	{
528 
+		return $this->request_type->isApi();
529 
+	}
530 
+
531 
+
532 
+	/**
533 
+	 * @return bool
534 
+	 */
535 
+	public function isCli()
536 
+	{
537 
+		return $this->request_type->isCli();
538 
+	}
539 
+
540 
+
541 
+	/**
542 
+	 * @return bool
543 
+	 */
544 
+	public function isCron()
545 
+	{
546 
+		return $this->request_type->isCron();
547 
+	}
548 
+
549 
+
550 
+	/**
551 
+	 * @return bool
552 
+	 */
553 
+	public function isFeed()
554 
+	{
555 
+		return $this->request_type->isFeed();
556 
+	}
557 
+
558 
+
559 
+	/**
560 
+	 * @return bool
561 
+	 */
562 
+	public function isFrontend()
563 
+	{
564 
+		return $this->request_type->isFrontend();
565 
+	}
566 
+
567 
+
568 
+	/**
569 
+	 * @return bool
570 
+	 */
571 
+	public function isFrontAjax()
572 
+	{
573 
+		return $this->request_type->isFrontAjax();
574 
+	}
575 
+
576 
+
577 
+	/**
578 
+	 * @return bool
579 
+	 */
580 
+	public function isIframe()
581 
+	{
582 
+		return $this->request_type->isIframe();
583 
+	}
584 
+
585 
+
586 
+	/**
587 
+	 * @return bool
588 
+	 */
589 
+	public function isWordPressApi()
590 
+	{
591 
+		return $this->request_type->isWordPressApi();
592 
+	}
593 
+
594 
+
595 
+
596 
+	/**
597 
+	 * @return bool
598 
+	 */
599 
+	public function isWordPressHeartbeat()
600 
+	{
601 
+		return $this->request_type->isWordPressHeartbeat();
602 
+	}
603 
+
604 
+
605 
+
606 
+	/**
607 
+	 * @return bool
608 
+	 */
609 
+	public function isWordPressScrape()
610 
+	{
611 
+		return $this->request_type->isWordPressScrape();
612 
+	}
613 
+
614 
+
615 
+	/**
616 
+	 * @return string
617 
+	 */
618 
+	public function slug()
619 
+	{
620 
+		return $this->request_type->slug();
621 
+	}
622 622 
 }
Please login to merge, or discard this patch.
modules/bot_trap/EED_Bot_Trap.module.php 2 patches
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch 
@@ -53,7 +53,7 @@  discard block
 
 block discarded – undo
53 53 
      */
54 54 
     public static function set_trap()
55 55 
     {
56 
-        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . DS);
56 
+        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__).DS);
57 57 
         add_action(
58 58 
             'AHEE__ticket_selector_chart__template__after_ticket_selector',
59 59 
             array('EED_Bot_Trap', 'generate_bot_trap'),
 
@@ -119,9 +119,9 @@  discard block
 
 block discarded – undo
119 119 
         $do_not_enter = esc_html__('please do not enter anything in this input', 'event_espresso');
120 120 
         $time = microtime(true);
121 121 
         $html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
122 
-        $html .= '<label for="tkt-slctr-request-processor-email-' . $time . '">' . $do_not_enter . '</label>';
122 
+        $html .= '<label for="tkt-slctr-request-processor-email-'.$time.'">'.$do_not_enter.'</label>';
123 123 
         $html .= '<input type="email" id="tkt-slctr-request-processor-email-';
124 
-        $html .= $time . '" name="tkt-slctr-request-processor-email" value=""/>';
124 
+        $html .= $time.'" name="tkt-slctr-request-processor-email" value=""/>';
125 125 
         $html .= '</div><!-- .tkt-slctr-request-processor-dv -->';
126 126 
         echo $html;
127 127 
     }
 
@@ -147,7 +147,7 @@  discard block
 
 block discarded – undo
147 147 
             return;
148 148 
         }
149 149 
         // check the given callback is valid first before executing
150 
-        if (! is_callable($triggered_trap_callback)) {
150 
+        if ( ! is_callable($triggered_trap_callback)) {
151 151 
             // invalid callback so lets just sub in our default.
152 152 
             $triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
153 153 
         }
Please login to merge, or discard this patch.
Indentation   +275 added lines, -275 removed lines patch added patch discarded remove patch 
@@ -16,304 +16,304 @@
 
 block discarded – undo
16 16 
 class EED_Bot_Trap extends EED_Module
17 17 
 {
18 18
19 
-    /**
20 
-     * @return EED_Bot_Trap|EED_Module
21 
-     */
22 
-    public static function instance()
23 
-    {
24 
-        return parent::get_instance(__CLASS__);
25 
-    }
19 
+	/**
20 
+	 * @return EED_Bot_Trap|EED_Module
21 
+	 */
22 
+	public static function instance()
23 
+	{
24 
+		return parent::get_instance(__CLASS__);
25 
+	}
26 26
27 27
28 
-    /**
29 
-     * set_hooks - for hooking into EE Core, other modules, etc
30 
-     *
31 
-     * @return void
32 
-     */
33 
-    public static function set_hooks()
34 
-    {
35 
-        if (apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true) &&
36 
-            EE_Registry::instance()->CFG->registration->use_bot_trap
37 
-        ) {
38 
-            EED_Bot_Trap::set_trap();
39 
-            // redirect bots to bogus success page
40 
-            EE_Config::register_route(
41 
-                'ticket_selection_received',
42 
-                'EED_Bot_Trap',
43 
-                'display_bot_trap_success'
44 
-            );
45 
-        }
46 
-    }
28 
+	/**
29 
+	 * set_hooks - for hooking into EE Core, other modules, etc
30 
+	 *
31 
+	 * @return void
32 
+	 */
33 
+	public static function set_hooks()
34 
+	{
35 
+		if (apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true) &&
36 
+			EE_Registry::instance()->CFG->registration->use_bot_trap
37 
+		) {
38 
+			EED_Bot_Trap::set_trap();
39 
+			// redirect bots to bogus success page
40 
+			EE_Config::register_route(
41 
+				'ticket_selection_received',
42 
+				'EED_Bot_Trap',
43 
+				'display_bot_trap_success'
44 
+			);
45 
+		}
46 
+	}
47 47
48 48
49 
-    /**
50 
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
51 
-     *
52 
-     * @return void
53 
-     */
54 
-    public static function set_trap()
55 
-    {
56 
-        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . DS);
57 
-        add_action(
58 
-            'AHEE__ticket_selector_chart__template__after_ticket_selector',
59 
-            array('EED_Bot_Trap', 'generate_bot_trap'),
60 
-            10,
61 
-            2
62 
-        );
63 
-        add_action(
64 
-            'EED_Ticket_Selector__process_ticket_selections__before',
65 
-            array('EED_Bot_Trap', 'process_bot_trap'),
66 
-            1,
67 
-            2
68 
-        );
69 
-    }
49 
+	/**
50 
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
51 
+	 *
52 
+	 * @return void
53 
+	 */
54 
+	public static function set_trap()
55 
+	{
56 
+		define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . DS);
57 
+		add_action(
58 
+			'AHEE__ticket_selector_chart__template__after_ticket_selector',
59 
+			array('EED_Bot_Trap', 'generate_bot_trap'),
60 
+			10,
61 
+			2
62 
+		);
63 
+		add_action(
64 
+			'EED_Ticket_Selector__process_ticket_selections__before',
65 
+			array('EED_Bot_Trap', 'process_bot_trap'),
66 
+			1,
67 
+			2
68 
+		);
69 
+	}
70 70
71 71
72 
-    /**
73 
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
74 
-     *
75 
-     * @return void
76 
-     */
77 
-    public static function set_hooks_admin()
78 
-    {
79 
-        if (defined('DOING_AJAX')
80 
-            && DOING_AJAX
81 
-            && apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true)
82 
-            && EE_Registry::instance()->CFG->registration->use_bot_trap
83 
-        ) {
84 
-            EED_Bot_Trap::set_trap();
85 
-        }
86 
-        add_action(
87 
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
88 
-            array('EED_Bot_Trap', 'bot_trap_settings_form'),
89 
-            5
90 
-        );
91 
-        add_filter(
92 
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
93 
-            array('EED_Bot_Trap', 'update_bot_trap_settings_form'),
94 
-            10,
95 
-            1
96 
-        );
97 
-    }
72 
+	/**
73 
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
74 
+	 *
75 
+	 * @return void
76 
+	 */
77 
+	public static function set_hooks_admin()
78 
+	{
79 
+		if (defined('DOING_AJAX')
80 
+			&& DOING_AJAX
81 
+			&& apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true)
82 
+			&& EE_Registry::instance()->CFG->registration->use_bot_trap
83 
+		) {
84 
+			EED_Bot_Trap::set_trap();
85 
+		}
86 
+		add_action(
87 
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
88 
+			array('EED_Bot_Trap', 'bot_trap_settings_form'),
89 
+			5
90 
+		);
91 
+		add_filter(
92 
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
93 
+			array('EED_Bot_Trap', 'update_bot_trap_settings_form'),
94 
+			10,
95 
+			1
96 
+		);
97 
+	}
98 98
99 99
100 
-    /**
101 
-     * run - initial module setup
102 
-     *
103 
-     * @param WP $WP
104 
-     * @return void
105 
-     */
106 
-    public function run($WP)
107 
-    {
108 
-    }
100 
+	/**
101 
+	 * run - initial module setup
102 
+	 *
103 
+	 * @param WP $WP
104 
+	 * @return void
105 
+	 */
106 
+	public function run($WP)
107 
+	{
108 
+	}
109 109
110 110
111 
-    /**
112 
-     * generate_bot_trap
113 
-     *
114 
-     * @return void
115 
-     * @throws RuntimeException
116 
-     */
117 
-    public static function generate_bot_trap()
118 
-    {
119 
-        $do_not_enter = esc_html__('please do not enter anything in this input', 'event_espresso');
120 
-        $time = microtime(true);
121 
-        $html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
122 
-        $html .= '<label for="tkt-slctr-request-processor-email-' . $time . '">' . $do_not_enter . '</label>';
123 
-        $html .= '<input type="email" id="tkt-slctr-request-processor-email-';
124 
-        $html .= $time . '" name="tkt-slctr-request-processor-email" value=""/>';
125 
-        $html .= '</div><!-- .tkt-slctr-request-processor-dv -->';
126 
-        echo $html;
127 
-    }
111 
+	/**
112 
+	 * generate_bot_trap
113 
+	 *
114 
+	 * @return void
115 
+	 * @throws RuntimeException
116 
+	 */
117 
+	public static function generate_bot_trap()
118 
+	{
119 
+		$do_not_enter = esc_html__('please do not enter anything in this input', 'event_espresso');
120 
+		$time = microtime(true);
121 
+		$html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
122 
+		$html .= '<label for="tkt-slctr-request-processor-email-' . $time . '">' . $do_not_enter . '</label>';
123 
+		$html .= '<input type="email" id="tkt-slctr-request-processor-email-';
124 
+		$html .= $time . '" name="tkt-slctr-request-processor-email" value=""/>';
125 
+		$html .= '</div><!-- .tkt-slctr-request-processor-dv -->';
126 
+		echo $html;
127 
+	}
128 128
129 129
130 
-    /**
131 
-     * process_bot_trap
132 
-     *
133 
-     * @param array|string $triggered_trap_callback Callback that will be executed for handling the
134 
-     *                                              response if the bot trap is triggered.
135 
-     *                                              It should receive one argument: a boolean indicating
136 
-     *                                              whether the trap was triggered by suspicious timing or not.
137 
-     * @throws RuntimeException
138 
-     */
139 
-    public static function process_bot_trap($triggered_trap_callback = array())
140 
-    {
141 
-        // what's your email address Mr. Bot ?
142 
-        $empty_trap = isset($_REQUEST['tkt-slctr-request-processor-email'])
143 
-                      && $_REQUEST['tkt-slctr-request-processor-email'] === '';
144 
-        // are we human ?
145 
-        if ($empty_trap) {
146 
-            do_action('AHEE__EED_Bot_Trap__process_bot_trap__trap_not_triggered');
147 
-            return;
148 
-        }
149 
-        // check the given callback is valid first before executing
150 
-        if (! is_callable($triggered_trap_callback)) {
151 
-            // invalid callback so lets just sub in our default.
152 
-            $triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
153 
-        }
154 
-        call_user_func($triggered_trap_callback);
155 
-    }
130 
+	/**
131 
+	 * process_bot_trap
132 
+	 *
133 
+	 * @param array|string $triggered_trap_callback Callback that will be executed for handling the
134 
+	 *                                              response if the bot trap is triggered.
135 
+	 *                                              It should receive one argument: a boolean indicating
136 
+	 *                                              whether the trap was triggered by suspicious timing or not.
137 
+	 * @throws RuntimeException
138 
+	 */
139 
+	public static function process_bot_trap($triggered_trap_callback = array())
140 
+	{
141 
+		// what's your email address Mr. Bot ?
142 
+		$empty_trap = isset($_REQUEST['tkt-slctr-request-processor-email'])
143 
+					  && $_REQUEST['tkt-slctr-request-processor-email'] === '';
144 
+		// are we human ?
145 
+		if ($empty_trap) {
146 
+			do_action('AHEE__EED_Bot_Trap__process_bot_trap__trap_not_triggered');
147 
+			return;
148 
+		}
149 
+		// check the given callback is valid first before executing
150 
+		if (! is_callable($triggered_trap_callback)) {
151 
+			// invalid callback so lets just sub in our default.
152 
+			$triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
153 
+		}
154 
+		call_user_func($triggered_trap_callback);
155 
+	}
156 156
157 157
158 
-    /**
159 
-     * This is the default callback executed by EED_Bot_Trap::process_bot_trap that handles the response.
160 
-     *
161 
-     * @throws InvalidArgumentException
162 
-     * @throws InvalidDataTypeException
163 
-     * @throws InvalidInterfaceException
164 
-     */
165 
-    public static function triggered_trap_response()
166 
-    {
167 
-        // UH OH...
168 
-        $redirect_url = apply_filters(
169 
-            'FHEE__EED_Bot_Trap__process_bot_trap__redirect_url',
170 
-            add_query_arg(
171 
-                array('ee' => 'ticket_selection_received'),
172 
-                EE_Registry::instance()->CFG->core->reg_page_url()
173 
-            )
174 
-        );
175 
-        // if AJAX, return the redirect URL
176 
-        if (defined('DOING_AJAX') && DOING_AJAX) {
177 
-            echo wp_json_encode(
178 
-                array_merge(
179 
-                    EE_Error::get_notices(false),
180 
-                    array(
181 
-                        'redirect_url' => $redirect_url,
182 
-                    )
183 
-                )
184 
-            );
185 
-            exit();
186 
-        }
187 
-        wp_safe_redirect($redirect_url);
188 
-        exit();
189 
-    }
158 
+	/**
159 
+	 * This is the default callback executed by EED_Bot_Trap::process_bot_trap that handles the response.
160 
+	 *
161 
+	 * @throws InvalidArgumentException
162 
+	 * @throws InvalidDataTypeException
163 
+	 * @throws InvalidInterfaceException
164 
+	 */
165 
+	public static function triggered_trap_response()
166 
+	{
167 
+		// UH OH...
168 
+		$redirect_url = apply_filters(
169 
+			'FHEE__EED_Bot_Trap__process_bot_trap__redirect_url',
170 
+			add_query_arg(
171 
+				array('ee' => 'ticket_selection_received'),
172 
+				EE_Registry::instance()->CFG->core->reg_page_url()
173 
+			)
174 
+		);
175 
+		// if AJAX, return the redirect URL
176 
+		if (defined('DOING_AJAX') && DOING_AJAX) {
177 
+			echo wp_json_encode(
178 
+				array_merge(
179 
+					EE_Error::get_notices(false),
180 
+					array(
181 
+						'redirect_url' => $redirect_url,
182 
+					)
183 
+				)
184 
+			);
185 
+			exit();
186 
+		}
187 
+		wp_safe_redirect($redirect_url);
188 
+		exit();
189 
+	}
190 190
191 191
192 
-    /**
193 
-     * display_bot_trap_success
194 
-     * shows a "success" screen to bots so that they (ie: the ppl managing them)
195 
-     * think the form was submitted successfully
196 
-     *
197 
-     * @return void
198 
-     */
199 
-    public static function display_bot_trap_success()
200 
-    {
201 
-        add_filter('FHEE__EED_Single_Page_Checkout__run', '__return_false');
202 
-        $bot_notice = esc_html__(
203 
-            'Thank you so much. Your ticket selections have been received for consideration.',
204 
-            'event_espresso'
205 
-        );
206 
-        $bot_notice = isset($_REQUEST['ee-notice']) && $_REQUEST['ee-notice'] !== ''
207 
-            ? sanitize_text_field(stripslashes($_REQUEST['ee-notice']))
208 
-            : $bot_notice;
209 
-        EE_Registry::instance()->REQ->add_output(EEH_HTML::div($bot_notice, '', 'ee-attention'));
210 
-    }
192 
+	/**
193 
+	 * display_bot_trap_success
194 
+	 * shows a "success" screen to bots so that they (ie: the ppl managing them)
195 
+	 * think the form was submitted successfully
196 
+	 *
197 
+	 * @return void
198 
+	 */
199 
+	public static function display_bot_trap_success()
200 
+	{
201 
+		add_filter('FHEE__EED_Single_Page_Checkout__run', '__return_false');
202 
+		$bot_notice = esc_html__(
203 
+			'Thank you so much. Your ticket selections have been received for consideration.',
204 
+			'event_espresso'
205 
+		);
206 
+		$bot_notice = isset($_REQUEST['ee-notice']) && $_REQUEST['ee-notice'] !== ''
207 
+			? sanitize_text_field(stripslashes($_REQUEST['ee-notice']))
208 
+			: $bot_notice;
209 
+		EE_Registry::instance()->REQ->add_output(EEH_HTML::div($bot_notice, '', 'ee-attention'));
210 
+	}
211 211
212 212
213 213
214 
-    /***********************************    ADMIN    **********************************/
214 
+	/***********************************    ADMIN    **********************************/
215 215
216 216
217 
-    /**
218 
-     * bot_trap_settings_form
219 
-     *
220 
-     * @return void
221 
-     * @throws EE_Error
222 
-     * @throws InvalidArgumentException
223 
-     * @throws InvalidDataTypeException
224 
-     * @throws InvalidInterfaceException
225 
-     */
226 
-    public static function bot_trap_settings_form()
227 
-    {
228 
-        EED_Bot_Trap::_bot_trap_settings_form()->enqueue_js();
229 
-        echo EED_Bot_Trap::_bot_trap_settings_form()->get_html();
230 
-    }
217 
+	/**
218 
+	 * bot_trap_settings_form
219 
+	 *
220 
+	 * @return void
221 
+	 * @throws EE_Error
222 
+	 * @throws InvalidArgumentException
223 
+	 * @throws InvalidDataTypeException
224 
+	 * @throws InvalidInterfaceException
225 
+	 */
226 
+	public static function bot_trap_settings_form()
227 
+	{
228 
+		EED_Bot_Trap::_bot_trap_settings_form()->enqueue_js();
229 
+		echo EED_Bot_Trap::_bot_trap_settings_form()->get_html();
230 
+	}
231 231
232 232
233 
-    /**
234 
-     * _bot_trap_settings_form
235 
-     *
236 
-     * @return EE_Form_Section_Proper
237 
-     * @throws EE_Error
238 
-     */
239 
-    protected static function _bot_trap_settings_form()
240 
-    {
241 
-        return new EE_Form_Section_Proper(
242 
-            array(
243 
-                'name'            => 'bot_trap_settings',
244 
-                'html_id'         => 'bot_trap_settings',
245 
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
246 
-                'subsections'     => array(
247 
-                    'bot_trap_hdr' => new EE_Form_Section_HTML(
248 
-                        EEH_HTML::h2(esc_html__('Bot Trap Settings', 'event_espresso'))
249 
-                    ),
250 
-                    'use_bot_trap' => new EE_Yes_No_Input(
251 
-                        array(
252 
-                            'html_label_text' => esc_html__('Enable Bot Trap', 'event_espresso'),
253 
-                            'html_help_text'  => esc_html__(
254 
-                                'The Event Espresso Bot Trap will insert a fake input into your Ticket Selector forms that is hidden from regular site visitors, but visible to spam bots. Because the input asks for an email address, it is irresistible to spam bots who will of course enter text into it. Since regular site visitors can not see this input, any value detected during form submission means a bot has been detected, which will then be blocked from submitting the form.',
255 
-                                'event_espresso'
256 
-                            ),
257 
-                            'default'         => EE_Registry::instance()->CFG->registration->use_bot_trap !== null
258 
-                                ? EE_Registry::instance()->CFG->registration->use_bot_trap
259 
-                                : true,
260 
-                            'required'        => false,
261 
-                        )
262 
-                    ),
263 
-                ),
264 
-            )
265 
-        );
266 
-    }
233 
+	/**
234 
+	 * _bot_trap_settings_form
235 
+	 *
236 
+	 * @return EE_Form_Section_Proper
237 
+	 * @throws EE_Error
238 
+	 */
239 
+	protected static function _bot_trap_settings_form()
240 
+	{
241 
+		return new EE_Form_Section_Proper(
242 
+			array(
243 
+				'name'            => 'bot_trap_settings',
244 
+				'html_id'         => 'bot_trap_settings',
245 
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
246 
+				'subsections'     => array(
247 
+					'bot_trap_hdr' => new EE_Form_Section_HTML(
248 
+						EEH_HTML::h2(esc_html__('Bot Trap Settings', 'event_espresso'))
249 
+					),
250 
+					'use_bot_trap' => new EE_Yes_No_Input(
251 
+						array(
252 
+							'html_label_text' => esc_html__('Enable Bot Trap', 'event_espresso'),
253 
+							'html_help_text'  => esc_html__(
254 
+								'The Event Espresso Bot Trap will insert a fake input into your Ticket Selector forms that is hidden from regular site visitors, but visible to spam bots. Because the input asks for an email address, it is irresistible to spam bots who will of course enter text into it. Since regular site visitors can not see this input, any value detected during form submission means a bot has been detected, which will then be blocked from submitting the form.',
255 
+								'event_espresso'
256 
+							),
257 
+							'default'         => EE_Registry::instance()->CFG->registration->use_bot_trap !== null
258 
+								? EE_Registry::instance()->CFG->registration->use_bot_trap
259 
+								: true,
260 
+							'required'        => false,
261 
+						)
262 
+					),
263 
+				),
264 
+			)
265 
+		);
266 
+	}
267 267
268 268
269 
-    /**
270 
-     * update_bot_trap_settings_form
271 
-     *
272 
-     * @param EE_Registration_Config $EE_Registration_Config
273 
-     * @return EE_Registration_Config
274 
-     * @throws EE_Error
275 
-     * @throws InvalidArgumentException
276 
-     * @throws ReflectionException
277 
-     * @throws InvalidDataTypeException
278 
-     * @throws InvalidInterfaceException
279 
-     */
280 
-    public static function update_bot_trap_settings_form(EE_Registration_Config $EE_Registration_Config)
281 
-    {
282 
-        try {
283 
-            $bot_trap_settings_form = EED_Bot_Trap::_bot_trap_settings_form();
284 
-            // if not displaying a form, then check for form submission
285 
-            if ($bot_trap_settings_form->was_submitted()) {
286 
-                // capture form data
287 
-                $bot_trap_settings_form->receive_form_submission();
288 
-                // validate form data
289 
-                if ($bot_trap_settings_form->is_valid()) {
290 
-                    // grab validated data from form
291 
-                    $valid_data = $bot_trap_settings_form->valid_data();
292 
-                    if (isset($valid_data['use_bot_trap'])) {
293 
-                        $EE_Registration_Config->use_bot_trap = $valid_data['use_bot_trap'];
294 
-                    } else {
295 
-                        EE_Error::add_error(
296 
-                            esc_html__(
297 
-                                'Invalid or missing Bot Trap settings. Please refresh the form and try again.',
298 
-                                'event_espresso'
299 
-                            ),
300 
-                            __FILE__,
301 
-                            __FUNCTION__,
302 
-                            __LINE__
303 
-                        );
304 
-                    }
305 
-                } elseif ($bot_trap_settings_form->submission_error_message() !== '') {
306 
-                    EE_Error::add_error(
307 
-                        $bot_trap_settings_form->submission_error_message(),
308 
-                        __FILE__,
309 
-                        __FUNCTION__,
310 
-                        __LINE__
311 
-                    );
312 
-                }
313 
-            }
314 
-        } catch (EE_Error $e) {
315 
-            $e->get_error();
316 
-        }
317 
-        return $EE_Registration_Config;
318 
-    }
269 
+	/**
270 
+	 * update_bot_trap_settings_form
271 
+	 *
272 
+	 * @param EE_Registration_Config $EE_Registration_Config
273 
+	 * @return EE_Registration_Config
274 
+	 * @throws EE_Error
275 
+	 * @throws InvalidArgumentException
276 
+	 * @throws ReflectionException
277 
+	 * @throws InvalidDataTypeException
278 
+	 * @throws InvalidInterfaceException
279 
+	 */
280 
+	public static function update_bot_trap_settings_form(EE_Registration_Config $EE_Registration_Config)
281 
+	{
282 
+		try {
283 
+			$bot_trap_settings_form = EED_Bot_Trap::_bot_trap_settings_form();
284 
+			// if not displaying a form, then check for form submission
285 
+			if ($bot_trap_settings_form->was_submitted()) {
286 
+				// capture form data
287 
+				$bot_trap_settings_form->receive_form_submission();
288 
+				// validate form data
289 
+				if ($bot_trap_settings_form->is_valid()) {
290 
+					// grab validated data from form
291 
+					$valid_data = $bot_trap_settings_form->valid_data();
292 
+					if (isset($valid_data['use_bot_trap'])) {
293 
+						$EE_Registration_Config->use_bot_trap = $valid_data['use_bot_trap'];
294 
+					} else {
295 
+						EE_Error::add_error(
296 
+							esc_html__(
297 
+								'Invalid or missing Bot Trap settings. Please refresh the form and try again.',
298 
+								'event_espresso'
299 
+							),
300 
+							__FILE__,
301 
+							__FUNCTION__,
302 
+							__LINE__
303 
+						);
304 
+					}
305 
+				} elseif ($bot_trap_settings_form->submission_error_message() !== '') {
306 
+					EE_Error::add_error(
307 
+						$bot_trap_settings_form->submission_error_message(),
308 
+						__FILE__,
309 
+						__FUNCTION__,
310 
+						__LINE__
311 
+					);
312 
+				}
313 
+			}
314 
+		} catch (EE_Error $e) {
315 
+			$e->get_error();
316 
+		}
317 
+		return $EE_Registration_Config;
318 
+	}
319 319 
 }
Please login to merge, or discard this patch.
reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php 1 patch
Indentation   +2885 added lines, -2885 removed lines patch added patch discarded remove patch 
@@ -12,2889 +12,2889 @@
 
 block discarded – undo
12 12 
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
13 13 
 {
14 14
15 
-    /**
16 
-     * @access protected
17 
-     * @var EE_Line_Item_Display $Line_Item_Display
18 
-     */
19 
-    protected $line_item_display;
20 
-
21 
-    /**
22 
-     * @access protected
23 
-     * @var boolean $handle_IPN_in_this_request
24 
-     */
25 
-    protected $handle_IPN_in_this_request = false;
26 
-
27 
-
28 
-    /**
29 
-     *    set_hooks - for hooking into EE Core, other modules, etc
30 
-     *
31 
-     * @access    public
32 
-     * @return    void
33 
-     */
34 
-    public static function set_hooks()
35 
-    {
36 
-        add_filter(
37 
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
38 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
39 
-        );
40 
-        add_action(
41 
-            'wp_ajax_switch_spco_billing_form',
42 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
43 
-        );
44 
-        add_action(
45 
-            'wp_ajax_nopriv_switch_spco_billing_form',
46 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
47 
-        );
48 
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
49 
-        add_action(
50 
-            'wp_ajax_nopriv_save_payer_details',
51 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
52 
-        );
53 
-        add_action(
54 
-            'wp_ajax_get_transaction_details_for_gateways',
55 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
56 
-        );
57 
-        add_action(
58 
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
59 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
60 
-        );
61 
-        add_filter(
62 
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
63 
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
64 
-            10,
65 
-            1
66 
-        );
67 
-    }
68 
-
69 
-
70 
-    /**
71 
-     *    ajax switch_spco_billing_form
72 
-     *
73 
-     * @throws \EE_Error
74 
-     */
75 
-    public static function switch_spco_billing_form()
76 
-    {
77 
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
78 
-    }
79 
-
80 
-
81 
-    /**
82 
-     *    ajax save_payer_details
83 
-     *
84 
-     * @throws \EE_Error
85 
-     */
86 
-    public static function save_payer_details()
87 
-    {
88 
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
89 
-    }
90 
-
91 
-
92 
-    /**
93 
-     *    ajax get_transaction_details
94 
-     *
95 
-     * @throws \EE_Error
96 
-     */
97 
-    public static function get_transaction_details()
98 
-    {
99 
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
100 
-    }
101 
-
102 
-
103 
-    /**
104 
-     * bypass_recaptcha_for_load_payment_method
105 
-     *
106 
-     * @access public
107 
-     * @return array
108 
-     * @throws InvalidArgumentException
109 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
110 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
111 
-     */
112 
-    public static function bypass_recaptcha_for_load_payment_method()
113 
-    {
114 
-        return array(
115 
-            'EESID'  => EE_Registry::instance()->SSN->id(),
116 
-            'step'   => 'payment_options',
117 
-            'action' => 'spco_billing_form',
118 
-        );
119 
-    }
120 
-
121 
-
122 
-    /**
123 
-     *    class constructor
124 
-     *
125 
-     * @access    public
126 
-     * @param    EE_Checkout $checkout
127 
-     */
128 
-    public function __construct(EE_Checkout $checkout)
129 
-    {
130 
-        $this->_slug = 'payment_options';
131 
-        $this->_name = esc_html__('Payment Options', 'event_espresso');
132 
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
133 
-        $this->checkout = $checkout;
134 
-        $this->_reset_success_message();
135 
-        $this->set_instructions(
136 
-            esc_html__(
137 
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
138 
-                'event_espresso'
139 
-            )
140 
-        );
141 
-    }
142 
-
143 
-
144 
-    /**
145 
-     * @return null
146 
-     */
147 
-    public function line_item_display()
148 
-    {
149 
-        return $this->line_item_display;
150 
-    }
151 
-
152 
-
153 
-    /**
154 
-     * @param null $line_item_display
155 
-     */
156 
-    public function set_line_item_display($line_item_display)
157 
-    {
158 
-        $this->line_item_display = $line_item_display;
159 
-    }
160 
-
161 
-
162 
-    /**
163 
-     * @return boolean
164 
-     */
165 
-    public function handle_IPN_in_this_request()
166 
-    {
167 
-        return $this->handle_IPN_in_this_request;
168 
-    }
169 
-
170 
-
171 
-    /**
172 
-     * @param boolean $handle_IPN_in_this_request
173 
-     */
174 
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
175 
-    {
176 
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
177 
-    }
178 
-
179 
-
180 
-    /**
181 
-     * translate_js_strings
182 
-     *
183 
-     * @return void
184 
-     */
185 
-    public function translate_js_strings()
186 
-    {
187 
-        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
188 
-            'Please select a method of payment in order to continue.',
189 
-            'event_espresso'
190 
-        );
191 
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
192 
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
193 
-            'event_espresso'
194 
-        );
195 
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
196 
-            'Forwarding to Secure Payment Provider.',
197 
-            'event_espresso'
198 
-        );
199 
-    }
200 
-
201 
-
202 
-    /**
203 
-     * enqueue_styles_and_scripts
204 
-     *
205 
-     * @return void
206 
-     * @throws EE_Error
207 
-     * @throws InvalidArgumentException
208 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
209 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
210 
-     */
211 
-    public function enqueue_styles_and_scripts()
212 
-    {
213 
-        $transaction = $this->checkout->transaction;
214 
-        // if the transaction isn't set or nothing is owed on it, don't enqueue any JS
215 
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
216 
-            return;
217 
-        }
218 
-        foreach (EEM_Payment_Method::instance()->get_all_for_transaction(
219 
-            $transaction,
220 
-            EEM_Payment_Method::scope_cart
221 
-        ) as $payment_method) {
222 
-            $type_obj = $payment_method->type_obj();
223 
-            if ($type_obj instanceof EE_PMT_Base) {
224 
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
225 
-                if ($billing_form instanceof EE_Form_Section_Proper) {
226 
-                    $billing_form->enqueue_js();
227 
-                }
228 
-            }
229 
-        }
230 
-    }
231 
-
232 
-
233 
-    /**
234 
-     * initialize_reg_step
235 
-     *
236 
-     * @return bool
237 
-     * @throws EE_Error
238 
-     * @throws InvalidArgumentException
239 
-     * @throws ReflectionException
240 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
241 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
242 
-     */
243 
-    public function initialize_reg_step()
244 
-    {
245 
-        // TODO: if /when we implement donations, then this will need overriding
246 
-        if (// don't need payment options for:
247 
-            // registrations made via the admin
248 
-            // completed transactions
249 
-            // overpaid transactions
250 
-            // $ 0.00 transactions(no payment required)
251 
-            ! $this->checkout->payment_required()
252 
-            // but do NOT remove if current action being called belongs to this reg step
253 
-            && ! is_callable(array($this, $this->checkout->action))
254 
-            && ! $this->completed()
255 
-        ) {
256 
-            // and if so, then we no longer need the Payment Options step
257 
-            if ($this->is_current_step()) {
258 
-                $this->checkout->generate_reg_form = false;
259 
-            }
260 
-            $this->checkout->remove_reg_step($this->_slug);
261 
-            // DEBUG LOG
262 
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
263 
-            return false;
264 
-        }
265 
-        // load EEM_Payment_Method
266 
-        EE_Registry::instance()->load_model('Payment_Method');
267 
-        // get all active payment methods
268 
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
269 
-            $this->checkout->transaction,
270 
-            EEM_Payment_Method::scope_cart
271 
-        );
272 
-        return true;
273 
-    }
274 
-
275 
-
276 
-    /**
277 
-     * @return EE_Form_Section_Proper
278 
-     * @throws EE_Error
279 
-     * @throws InvalidArgumentException
280 
-     * @throws ReflectionException
281 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
282 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
283 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
284 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
285 
-     */
286 
-    public function generate_reg_form()
287 
-    {
288 
-        // reset in case someone changes their mind
289 
-        $this->_reset_selected_method_of_payment();
290 
-        // set some defaults
291 
-        $this->checkout->selected_method_of_payment = 'payments_closed';
292 
-        $registrations_requiring_payment = array();
293 
-        $registrations_for_free_events = array();
294 
-        $registrations_requiring_pre_approval = array();
295 
-        $sold_out_events = array();
296 
-        $insufficient_spaces_available = array();
297 
-        $no_payment_required = true;
298 
-        // loop thru registrations to gather info
299 
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
300 
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
301 
-            $registrations,
302 
-            $this->checkout->revisit
303 
-        );
304 
-        foreach ($registrations as $REG_ID => $registration) {
305 
-            /** @var $registration EE_Registration */
306 
-            // has this registration lost it's space ?
307 
-            if (isset($ejected_registrations[ $REG_ID ])) {
308 
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
309 
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
310 
-                } else {
311 
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
312 
-                }
313 
-                continue;
314 
-            }
315 
-            // event requires admin approval
316 
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
317 
-                // add event to list of events with pre-approval reg status
318 
-                $registrations_requiring_pre_approval[ $REG_ID ] = $registration;
319 
-                do_action(
320 
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
321 
-                    $registration->event(),
322 
-                    $this
323 
-                );
324 
-                continue;
325 
-            }
326 
-            if ($this->checkout->revisit
327 
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
328 
-                && (
329 
-                    $registration->event()->is_sold_out()
330 
-                    || $registration->event()->is_sold_out(true)
331 
-                )
332 
-            ) {
333 
-                // add event to list of events that are sold out
334 
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
335 
-                do_action(
336 
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
337 
-                    $registration->event(),
338 
-                    $this
339 
-                );
340 
-                continue;
341 
-            }
342 
-            // are they allowed to pay now and is there monies owing?
343 
-            if ($registration->owes_monies_and_can_pay()) {
344 
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
345 
-                do_action(
346 
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
347 
-                    $registration->event(),
348 
-                    $this
349 
-                );
350 
-            } elseif (! $this->checkout->revisit
351 
-                      && $registration->status_ID() !== EEM_Registration::status_id_not_approved
352 
-                      && $registration->ticket()->is_free()
353 
-            ) {
354 
-                $registrations_for_free_events[ $registration->event()->ID() ] = $registration;
355 
-            }
356 
-        }
357 
-        $subsections = array();
358 
-        // now decide which template to load
359 
-        if (! empty($sold_out_events)) {
360 
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
361 
-        }
362 
-        if (! empty($insufficient_spaces_available)) {
363 
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
364 
-                $insufficient_spaces_available
365 
-            );
366 
-        }
367 
-        if (! empty($registrations_requiring_pre_approval)) {
368 
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
369 
-                $registrations_requiring_pre_approval
370 
-            );
371 
-        }
372 
-        if (! empty($registrations_for_free_events)) {
373 
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
374 
-        }
375 
-        if (! empty($registrations_requiring_payment)) {
376 
-            if ($this->checkout->amount_owing > 0) {
377 
-                // autoload Line_Item_Display classes
378 
-                EEH_Autoloader::register_line_item_filter_autoloaders();
379 
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
380 
-                    apply_filters(
381 
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
382 
-                        new EE_Line_Item_Filter_Collection()
383 
-                    ),
384 
-                    $this->checkout->cart->get_grand_total()
385 
-                );
386 
-                /** @var EE_Line_Item $filtered_line_item_tree */
387 
-                $filtered_line_item_tree = $line_item_filter_processor->process();
388 
-                EEH_Autoloader::register_line_item_display_autoloaders();
389 
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
390 
-                $subsections['payment_options'] = $this->_display_payment_options(
391 
-                    $this->line_item_display->display_line_item(
392 
-                        $filtered_line_item_tree,
393 
-                        array('registrations' => $registrations)
394 
-                    )
395 
-                );
396 
-                $this->checkout->amount_owing = $filtered_line_item_tree->total();
397 
-                $this->_apply_registration_payments_to_amount_owing($registrations);
398 
-            }
399 
-            $no_payment_required = false;
400 
-        } else {
401 
-            $this->_hide_reg_step_submit_button_if_revisit();
402 
-        }
403 
-        $this->_save_selected_method_of_payment();
404 
-
405 
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
406 
-        $subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
407 
-
408 
-        return new EE_Form_Section_Proper(
409 
-            array(
410 
-                'name'            => $this->reg_form_name(),
411 
-                'html_id'         => $this->reg_form_name(),
412 
-                'subsections'     => $subsections,
413 
-                'layout_strategy' => new EE_No_Layout(),
414 
-            )
415 
-        );
416 
-    }
417 
-
418 
-
419 
-    /**
420 
-     * add line item filters required for this reg step
421 
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
422 
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
423 
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
424 
-     *        payment options reg step, can apply these filters via the following: apply_filters(
425 
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
426 
-     *        filter collection by passing that instead of instantiating a new collection
427 
-     *
428 
-     * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
429 
-     * @return EE_Line_Item_Filter_Collection
430 
-     * @throws EE_Error
431 
-     * @throws InvalidArgumentException
432 
-     * @throws ReflectionException
433 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
434 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
435 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
436 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
437 
-     */
438 
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
439 
-    {
440 
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
441 
-            return $line_item_filter_collection;
442 
-        }
443 
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
444 
-            return $line_item_filter_collection;
445 
-        }
446 
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
447 
-            return $line_item_filter_collection;
448 
-        }
449 
-        $line_item_filter_collection->add(
450 
-            new EE_Billable_Line_Item_Filter(
451 
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
452 
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
453 
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
454 
-                    )
455 
-                )
456 
-            )
457 
-        );
458 
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
459 
-        return $line_item_filter_collection;
460 
-    }
461 
-
462 
-
463 
-    /**
464 
-     * remove_ejected_registrations
465 
-     * if a registrant has lost their potential space at an event due to lack of payment,
466 
-     * then this method removes them from the list of registrations being paid for during this request
467 
-     *
468 
-     * @param \EE_Registration[] $registrations
469 
-     * @return EE_Registration[]
470 
-     * @throws EE_Error
471 
-     * @throws InvalidArgumentException
472 
-     * @throws ReflectionException
473 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
474 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
475 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
476 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
477 
-     */
478 
-    public static function remove_ejected_registrations(array $registrations)
479 
-    {
480 
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
481 
-            $registrations,
482 
-            EE_Registry::instance()->SSN->checkout()->revisit
483 
-        );
484 
-        foreach ($registrations as $REG_ID => $registration) {
485 
-            // has this registration lost it's space ?
486 
-            if (isset($ejected_registrations[ $REG_ID ])) {
487 
-                unset($registrations[ $REG_ID ]);
488 
-                continue;
489 
-            }
490 
-        }
491 
-        return $registrations;
492 
-    }
493 
-
494 
-
495 
-    /**
496 
-     * find_registrations_that_lost_their_space
497 
-     * If a registrant chooses an offline payment method like Invoice,
498 
-     * then no space is reserved for them at the event until they fully pay fo that site
499 
-     * (unless the event's default reg status is set to APPROVED)
500 
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
501 
-     * then this method will determine which registrations have lost the ability to complete the reg process.
502 
-     *
503 
-     * @param \EE_Registration[] $registrations
504 
-     * @param bool               $revisit
505 
-     * @return array
506 
-     * @throws EE_Error
507 
-     * @throws InvalidArgumentException
508 
-     * @throws ReflectionException
509 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
510 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
511 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
512 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
513 
-     */
514 
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
515 
-    {
516 
-        // registrations per event
517 
-        $event_reg_count = array();
518 
-        // spaces left per event
519 
-        $event_spaces_remaining = array();
520 
-        // tickets left sorted by ID
521 
-        $tickets_remaining = array();
522 
-        // registrations that have lost their space
523 
-        $ejected_registrations = array();
524 
-        foreach ($registrations as $REG_ID => $registration) {
525 
-            if ($registration->status_ID() === EEM_Registration::status_id_approved
526 
-                || apply_filters(
527 
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
528 
-                    false,
529 
-                    $registration,
530 
-                    $revisit
531 
-                )
532 
-            ) {
533 
-                continue;
534 
-            }
535 
-            $EVT_ID = $registration->event_ID();
536 
-            $ticket = $registration->ticket();
537 
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
538 
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
539 
-            }
540 
-            if ($tickets_remaining[ $ticket->ID() ] > 0) {
541 
-                if (! isset($event_reg_count[ $EVT_ID ])) {
542 
-                    $event_reg_count[ $EVT_ID ] = 0;
543 
-                }
544 
-                $event_reg_count[ $EVT_ID ]++;
545 
-                if (! isset($event_spaces_remaining[ $EVT_ID ])) {
546 
-                    $event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
547 
-                }
548 
-            }
549 
-            if ($revisit
550 
-                && ($tickets_remaining[ $ticket->ID() ] === 0
551 
-                    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
552 
-                )
553 
-            ) {
554 
-                $ejected_registrations[ $REG_ID ] = $registration->event();
555 
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
556 
-                    /** @type EE_Registration_Processor $registration_processor */
557 
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
558 
-                    // at this point, we should have enough details about the registrant to consider the registration
559 
-                    // NOT incomplete
560 
-                    $registration_processor->manually_update_registration_status(
561 
-                        $registration,
562 
-                        EEM_Registration::status_id_wait_list
563 
-                    );
564 
-                }
565 
-            }
566 
-        }
567 
-        return $ejected_registrations;
568 
-    }
569 
-
570 
-
571 
-    /**
572 
-     * _hide_reg_step_submit_button
573 
-     * removes the html for the reg step submit button
574 
-     * by replacing it with an empty string via filter callback
575 
-     *
576 
-     * @return void
577 
-     */
578 
-    protected function _adjust_registration_status_if_event_old_sold()
579 
-    {
580 
-    }
581 
-
582 
-
583 
-    /**
584 
-     * _hide_reg_step_submit_button
585 
-     * removes the html for the reg step submit button
586 
-     * by replacing it with an empty string via filter callback
587 
-     *
588 
-     * @return void
589 
-     */
590 
-    protected function _hide_reg_step_submit_button_if_revisit()
591 
-    {
592 
-        if ($this->checkout->revisit) {
593 
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
594 
-        }
595 
-    }
596 
-
597 
-
598 
-    /**
599 
-     * sold_out_events
600 
-     * displays notices regarding events that have sold out since hte registrant first signed up
601 
-     *
602 
-     * @param \EE_Event[] $sold_out_events_array
603 
-     * @return \EE_Form_Section_Proper
604 
-     * @throws \EE_Error
605 
-     */
606 
-    private function _sold_out_events($sold_out_events_array = array())
607 
-    {
608 
-        // set some defaults
609 
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
610 
-        $sold_out_events = '';
611 
-        foreach ($sold_out_events_array as $sold_out_event) {
612 
-            $sold_out_events .= EEH_HTML::li(
613 
-                EEH_HTML::span(
614 
-                    '  ' . $sold_out_event->name(),
615 
-                    '',
616 
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
617 
-                )
618 
-            );
619 
-        }
620 
-        return new EE_Form_Section_Proper(
621 
-            array(
622 
-                'layout_strategy' => new EE_Template_Layout(
623 
-                    array(
624 
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
625 
-                                                  . $this->_slug
626 
-                                                  . DS
627 
-                                                  . 'sold_out_events.template.php',
628 
-                        'template_args'        => apply_filters(
629 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
630 
-                            array(
631 
-                                'sold_out_events'     => $sold_out_events,
632 
-                                'sold_out_events_msg' => apply_filters(
633 
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
634 
-                                    sprintf(
635 
-                                        esc_html__(
636 
-                                            'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
637 
-                                            'event_espresso'
638 
-                                        ),
639 
-                                        '<strong>',
640 
-                                        '</strong>',
641 
-                                        '<br />'
642 
-                                    )
643 
-                                ),
644 
-                            )
645 
-                        ),
646 
-                    )
647 
-                ),
648 
-            )
649 
-        );
650 
-    }
651 
-
652 
-
653 
-    /**
654 
-     * _insufficient_spaces_available
655 
-     * displays notices regarding events that do not have enough remaining spaces
656 
-     * to satisfy the current number of registrations looking to pay
657 
-     *
658 
-     * @param \EE_Event[] $insufficient_spaces_events_array
659 
-     * @return \EE_Form_Section_Proper
660 
-     * @throws \EE_Error
661 
-     */
662 
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
663 
-    {
664 
-        // set some defaults
665 
-        $this->checkout->selected_method_of_payment = 'invoice';
666 
-        $insufficient_space_events = '';
667 
-        foreach ($insufficient_spaces_events_array as $event) {
668 
-            if ($event instanceof EE_Event) {
669 
-                $insufficient_space_events .= EEH_HTML::li(
670 
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
671 
-                );
672 
-            }
673 
-        }
674 
-        return new EE_Form_Section_Proper(
675 
-            array(
676 
-                'subsections'     => array(
677 
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
678 
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
679 
-                ),
680 
-                'layout_strategy' => new EE_Template_Layout(
681 
-                    array(
682 
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
683 
-                                                  . $this->_slug
684 
-                                                  . DS
685 
-                                                  . 'sold_out_events.template.php',
686 
-                        'template_args'        => apply_filters(
687 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
688 
-                            array(
689 
-                                'sold_out_events'     => $insufficient_space_events,
690 
-                                'sold_out_events_msg' => apply_filters(
691 
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
692 
-                                    esc_html__(
693 
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
694 
-                                        'event_espresso'
695 
-                                    )
696 
-                                ),
697 
-                            )
698 
-                        ),
699 
-                    )
700 
-                ),
701 
-            )
702 
-        );
703 
-    }
704 
-
705 
-
706 
-    /**
707 
-     * registrations_requiring_pre_approval
708 
-     *
709 
-     * @param array $registrations_requiring_pre_approval
710 
-     * @return EE_Form_Section_Proper
711 
-     * @throws EE_Error
712 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
713 
-     */
714 
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
715 
-    {
716 
-        $events_requiring_pre_approval = '';
717 
-        foreach ($registrations_requiring_pre_approval as $registration) {
718 
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
719 
-                $events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
720 
-                    EEH_HTML::span(
721 
-                        '',
722 
-                        '',
723 
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
724 
-                    )
725 
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
726 
-                );
727 
-            }
728 
-        }
729 
-        return new EE_Form_Section_Proper(
730 
-            array(
731 
-                'layout_strategy' => new EE_Template_Layout(
732 
-                    array(
733 
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
734 
-                                                  . $this->_slug
735 
-                                                  . DS
736 
-                                                  . 'events_requiring_pre_approval.template.php', // layout_template
737 
-                        'template_args'        => apply_filters(
738 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
739 
-                            array(
740 
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
741 
-                                'events_requiring_pre_approval_msg' => apply_filters(
742 
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
743 
-                                    esc_html__(
744 
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
745 
-                                        'event_espresso'
746 
-                                    )
747 
-                                ),
748 
-                            )
749 
-                        ),
750 
-                    )
751 
-                ),
752 
-            )
753 
-        );
754 
-    }
755 
-
756 
-
757 
-    /**
758 
-     * _no_payment_required
759 
-     *
760 
-     * @param \EE_Event[] $registrations_for_free_events
761 
-     * @return \EE_Form_Section_Proper
762 
-     * @throws \EE_Error
763 
-     */
764 
-    private function _no_payment_required($registrations_for_free_events = array())
765 
-    {
766 
-        // set some defaults
767 
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
768 
-        // generate no_payment_required form
769 
-        return new EE_Form_Section_Proper(
770 
-            array(
771 
-                'layout_strategy' => new EE_Template_Layout(
772 
-                    array(
773 
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
774 
-                                                  . $this->_slug
775 
-                                                  . DS
776 
-                                                  . 'no_payment_required.template.php', // layout_template
777 
-                        'template_args'        => apply_filters(
778 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
779 
-                            array(
780 
-                                'revisit'                       => $this->checkout->revisit,
781 
-                                'registrations'                 => array(),
782 
-                                'ticket_count'                  => array(),
783 
-                                'registrations_for_free_events' => $registrations_for_free_events,
784 
-                                'no_payment_required_msg'       => EEH_HTML::p(
785 
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
786 
-                                ),
787 
-                            )
788 
-                        ),
789 
-                    )
790 
-                ),
791 
-            )
792 
-        );
793 
-    }
794 
-
795 
-
796 
-    /**
797 
-     * _display_payment_options
798 
-     *
799 
-     * @param string $transaction_details
800 
-     * @return EE_Form_Section_Proper
801 
-     * @throws EE_Error
802 
-     * @throws InvalidArgumentException
803 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
804 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
805 
-     */
806 
-    private function _display_payment_options($transaction_details = '')
807 
-    {
808 
-        // has method_of_payment been set by no-js user?
809 
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
810 
-        // build payment options form
811 
-        return apply_filters(
812 
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
813 
-            new EE_Form_Section_Proper(
814 
-                array(
815 
-                    'subsections'     => array(
816 
-                        'before_payment_options' => apply_filters(
817 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
818 
-                            new EE_Form_Section_Proper(
819 
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
820 
-                            )
821 
-                        ),
822 
-                        'payment_options'        => $this->_setup_payment_options(),
823 
-                        'after_payment_options'  => apply_filters(
824 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
825 
-                            new EE_Form_Section_Proper(
826 
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
827 
-                            )
828 
-                        ),
829 
-                    ),
830 
-                    'layout_strategy' => new EE_Template_Layout(
831 
-                        array(
832 
-                            'layout_template_file' => $this->_template,
833 
-                            'template_args'        => apply_filters(
834 
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
835 
-                                array(
836 
-                                    'reg_count'                 => $this->line_item_display->total_items(),
837 
-                                    'transaction_details'       => $transaction_details,
838 
-                                    'available_payment_methods' => array(),
839 
-                                )
840 
-                            ),
841 
-                        )
842 
-                    ),
843 
-                )
844 
-            )
845 
-        );
846 
-    }
847 
-
848 
-
849 
-    /**
850 
-     * _extra_hidden_inputs
851 
-     *
852 
-     * @param bool $no_payment_required
853 
-     * @return \EE_Form_Section_Proper
854 
-     * @throws \EE_Error
855 
-     */
856 
-    private function _extra_hidden_inputs($no_payment_required = true)
857 
-    {
858 
-        return new EE_Form_Section_Proper(
859 
-            array(
860 
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
861 
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
862 
-                'subsections'     => array(
863 
-                    'spco_no_payment_required' => new EE_Hidden_Input(
864 
-                        array(
865 
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
866 
-                            'html_name'              => 'spco_no_payment_required',
867 
-                            'html_id'                => 'spco-no-payment-required-payment_options',
868 
-                            'default'                => $no_payment_required,
869 
-                        )
870 
-                    ),
871 
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
872 
-                        array(
873 
-                            'normalization_strategy' => new EE_Int_Normalization(),
874 
-                            'html_name'              => 'spco_transaction_id',
875 
-                            'html_id'                => 'spco-transaction-id',
876 
-                            'default'                => $this->checkout->transaction->ID(),
877 
-                        )
878 
-                    ),
879 
-                ),
880 
-            )
881 
-        );
882 
-    }
883 
-
884 
-
885 
-    /**
886 
-     *    _apply_registration_payments_to_amount_owing
887 
-     *
888 
-     * @access protected
889 
-     * @param array $registrations
890 
-     * @throws EE_Error
891 
-     */
892 
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
893 
-    {
894 
-        $payments = array();
895 
-        foreach ($registrations as $registration) {
896 
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
897 
-                $payments += $registration->registration_payments();
898 
-            }
899 
-        }
900 
-        if (! empty($payments)) {
901 
-            foreach ($payments as $payment) {
902 
-                if ($payment instanceof EE_Registration_Payment) {
903 
-                    $this->checkout->amount_owing -= $payment->amount();
904 
-                }
905 
-            }
906 
-        }
907 
-    }
908 
-
909 
-
910 
-    /**
911 
-     *    _reset_selected_method_of_payment
912 
-     *
913 
-     * @access    private
914 
-     * @param    bool $force_reset
915 
-     * @return void
916 
-     * @throws InvalidArgumentException
917 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
918 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
919 
-     */
920 
-    private function _reset_selected_method_of_payment($force_reset = false)
921 
-    {
922 
-        $reset_payment_method = $force_reset
923 
-            ? true
924 
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
925 
-        if ($reset_payment_method) {
926 
-            $this->checkout->selected_method_of_payment = null;
927 
-            $this->checkout->payment_method = null;
928 
-            $this->checkout->billing_form = null;
929 
-            $this->_save_selected_method_of_payment();
930 
-        }
931 
-    }
932 
-
933 
-
934 
-    /**
935 
-     * _save_selected_method_of_payment
936 
-     * stores the selected_method_of_payment in the session
937 
-     * so that it's available for all subsequent requests including AJAX
938 
-     *
939 
-     * @access        private
940 
-     * @param string $selected_method_of_payment
941 
-     * @return void
942 
-     * @throws InvalidArgumentException
943 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
944 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
945 
-     */
946 
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
947 
-    {
948 
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
949 
-            ? $selected_method_of_payment
950 
-            : $this->checkout->selected_method_of_payment;
951 
-        EE_Registry::instance()->SSN->set_session_data(
952 
-            array('selected_method_of_payment' => $selected_method_of_payment)
953 
-        );
954 
-    }
955 
-
956 
-
957 
-    /**
958 
-     * _setup_payment_options
959 
-     *
960 
-     * @return EE_Form_Section_Proper
961 
-     * @throws EE_Error
962 
-     * @throws InvalidArgumentException
963 
-     * @throws ReflectionException
964 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
965 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
966 
-     */
967 
-    public function _setup_payment_options()
968 
-    {
969 
-        // load payment method classes
970 
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
971 
-        if (empty($this->checkout->available_payment_methods)) {
972 
-            EE_Error::add_error(
973 
-                apply_filters(
974 
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
975 
-                    sprintf(
976 
-                        esc_html__(
977 
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
978 
-                            'event_espresso'
979 
-                        ),
980 
-                        '<br>',
981 
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
982 
-                    )
983 
-                ),
984 
-                __FILE__,
985 
-                __FUNCTION__,
986 
-                __LINE__
987 
-            );
988 
-        }
989 
-        // switch up header depending on number of available payment methods
990 
-        $payment_method_header = count($this->checkout->available_payment_methods) > 1
991 
-            ? apply_filters(
992 
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
993 
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
994 
-            )
995 
-            : apply_filters(
996 
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
997 
-                esc_html__('Method of Payment', 'event_espresso')
998 
-            );
999 
-        $available_payment_methods = array(
1000 
-            // display the "Payment Method" header
1001 
-            'payment_method_header' => new EE_Form_Section_HTML(
1002 
-                EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
1003 
-            ),
1004 
-        );
1005 
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1006 
-        $available_payment_method_options = array();
1007 
-        $default_payment_method_option = array();
1008 
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1009 
-        $payment_methods_billing_info = array(
1010 
-            new EE_Form_Section_HTML(
1011 
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
1012 
-            ),
1013 
-        );
1014 
-        // loop through payment methods
1015 
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
1016 
-            if ($payment_method instanceof EE_Payment_Method) {
1017 
-                $payment_method_button = EEH_HTML::img(
1018 
-                    $payment_method->button_url(),
1019 
-                    $payment_method->name(),
1020 
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1021 
-                    'spco-payment-method-btn-img'
1022 
-                );
1023 
-                // check if any payment methods are set as default
1024 
-                // if payment method is already selected OR nothing is selected and this payment method should be
1025 
-                // open_by_default
1026 
-                if (($this->checkout->selected_method_of_payment === $payment_method->slug())
1027 
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1028 
-                ) {
1029 
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
1030 
-                    $this->_save_selected_method_of_payment();
1031 
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1032 
-                } else {
1033 
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1034 
-                }
1035 
-                $payment_methods_billing_info[ $payment_method->slug(
1036 
-                ) . '-info' ] = $this->_payment_method_billing_info(
1037 
-                    $payment_method
1038 
-                );
1039 
-            }
1040 
-        }
1041 
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1042 
-        // of PMs
1043 
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1044 
-        // now generate the actual form  inputs
1045 
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1046 
-            $available_payment_method_options
1047 
-        );
1048 
-        $available_payment_methods += $payment_methods_billing_info;
1049 
-        // build the available payment methods form
1050 
-        return new EE_Form_Section_Proper(
1051 
-            array(
1052 
-                'html_id'         => 'spco-available-methods-of-payment-dv',
1053 
-                'subsections'     => $available_payment_methods,
1054 
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1055 
-            )
1056 
-        );
1057 
-    }
1058 
-
1059 
-
1060 
-    /**
1061 
-     * _get_available_payment_methods
1062 
-     *
1063 
-     * @return EE_Payment_Method[]
1064 
-     * @throws EE_Error
1065 
-     * @throws InvalidArgumentException
1066 
-     * @throws ReflectionException
1067 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1068 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1069 
-     */
1070 
-    protected function _get_available_payment_methods()
1071 
-    {
1072 
-        if (! empty($this->checkout->available_payment_methods)) {
1073 
-            return $this->checkout->available_payment_methods;
1074 
-        }
1075 
-        $available_payment_methods = array();
1076 
-        // load EEM_Payment_Method
1077 
-        EE_Registry::instance()->load_model('Payment_Method');
1078 
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
1079 
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
1080 
-        // get all active payment methods
1081 
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1082 
-            $this->checkout->transaction,
1083 
-            EEM_Payment_Method::scope_cart
1084 
-        );
1085 
-        foreach ($payment_methods as $payment_method) {
1086 
-            if ($payment_method instanceof EE_Payment_Method) {
1087 
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
1088 
-            }
1089 
-        }
1090 
-        return $available_payment_methods;
1091 
-    }
1092 
-
1093 
-
1094 
-    /**
1095 
-     *    _available_payment_method_inputs
1096 
-     *
1097 
-     * @access    private
1098 
-     * @param    array $available_payment_method_options
1099 
-     * @return    \EE_Form_Section_Proper
1100 
-     */
1101 
-    private function _available_payment_method_inputs($available_payment_method_options = array())
1102 
-    {
1103 
-        // generate inputs
1104 
-        return new EE_Form_Section_Proper(
1105 
-            array(
1106 
-                'html_id'         => 'ee-available-payment-method-inputs',
1107 
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1108 
-                'subsections'     => array(
1109 
-                    '' => new EE_Radio_Button_Input(
1110 
-                        $available_payment_method_options,
1111 
-                        array(
1112 
-                            'html_name'          => 'selected_method_of_payment',
1113 
-                            'html_class'         => 'spco-payment-method',
1114 
-                            'default'            => $this->checkout->selected_method_of_payment,
1115 
-                            'label_size'         => 11,
1116 
-                            'enforce_label_size' => true,
1117 
-                        )
1118 
-                    ),
1119 
-                ),
1120 
-            )
1121 
-        );
1122 
-    }
1123 
-
1124 
-
1125 
-    /**
1126 
-     *    _payment_method_billing_info
1127 
-     *
1128 
-     * @access    private
1129 
-     * @param    EE_Payment_Method $payment_method
1130 
-     * @return EE_Form_Section_Proper
1131 
-     * @throws EE_Error
1132 
-     * @throws InvalidArgumentException
1133 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1134 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1135 
-     */
1136 
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1137 
-    {
1138 
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
1139 
-            ? true
1140 
-            : false;
1141 
-        // generate the billing form for payment method
1142 
-        $billing_form = $currently_selected
1143 
-            ? $this->_get_billing_form_for_payment_method($payment_method)
1144 
-            : new EE_Form_Section_HTML();
1145 
-        $this->checkout->billing_form = $currently_selected
1146 
-            ? $billing_form
1147 
-            : $this->checkout->billing_form;
1148 
-        // it's all in the details
1149 
-        $info_html = EEH_HTML::h3(
1150 
-            esc_html__('Important information regarding your payment', 'event_espresso'),
1151 
-            '',
1152 
-            'spco-payment-method-hdr'
1153 
-        );
1154 
-        // add some info regarding the step, either from what's saved in the admin,
1155 
-        // or a default string depending on whether the PM has a billing form or not
1156 
-        if ($payment_method->description()) {
1157 
-            $payment_method_info = $payment_method->description();
1158 
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
1159 
-            $payment_method_info = sprintf(
1160 
-                esc_html__(
1161 
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1162 
-                    'event_espresso'
1163 
-                ),
1164 
-                $this->submit_button_text()
1165 
-            );
1166 
-        } else {
1167 
-            $payment_method_info = sprintf(
1168 
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1169 
-                $this->submit_button_text()
1170 
-            );
1171 
-        }
1172 
-        $info_html .= EEH_HTML::div(
1173 
-            apply_filters(
1174 
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1175 
-                $payment_method_info
1176 
-            ),
1177 
-            '',
1178 
-            'spco-payment-method-desc ee-attention'
1179 
-        );
1180 
-        return new EE_Form_Section_Proper(
1181 
-            array(
1182 
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1183 
-                'html_class'      => 'spco-payment-method-info-dv',
1184 
-                // only display the selected or default PM
1185 
-                'html_style'      => $currently_selected ? '' : 'display:none;',
1186 
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
1187 
-                'subsections'     => array(
1188 
-                    'info'         => new EE_Form_Section_HTML($info_html),
1189 
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1190 
-                ),
1191 
-            )
1192 
-        );
1193 
-    }
1194 
-
1195 
-
1196 
-    /**
1197 
-     * get_billing_form_html_for_payment_method
1198 
-     *
1199 
-     * @access public
1200 
-     * @return string
1201 
-     * @throws EE_Error
1202 
-     * @throws InvalidArgumentException
1203 
-     * @throws ReflectionException
1204 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1205 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1206 
-     */
1207 
-    public function get_billing_form_html_for_payment_method()
1208 
-    {
1209 
-        // how have they chosen to pay?
1210 
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1211 
-        $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1212 
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1213 
-            return false;
1214 
-        }
1215 
-        if (apply_filters(
1216 
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1217 
-            false
1218 
-        )) {
1219 
-            EE_Error::add_success(
1220 
-                apply_filters(
1221 
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1222 
-                    sprintf(
1223 
-                        esc_html__(
1224 
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1225 
-                            'event_espresso'
1226 
-                        ),
1227 
-                        $this->checkout->payment_method->name()
1228 
-                    )
1229 
-                )
1230 
-            );
1231 
-        }
1232 
-        // now generate billing form for selected method of payment
1233 
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1234 
-        // fill form with attendee info if applicable
1235 
-        if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1236 
-            && $this->checkout->transaction_has_primary_registrant()
1237 
-        ) {
1238 
-            $payment_method_billing_form->populate_from_attendee(
1239 
-                $this->checkout->transaction->primary_registration()->attendee()
1240 
-            );
1241 
-        }
1242 
-        // and debug content
1243 
-        if ($payment_method_billing_form instanceof EE_Billing_Info_Form
1244 
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1245 
-        ) {
1246 
-            $payment_method_billing_form =
1247 
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1248 
-                    $payment_method_billing_form
1249 
-                );
1250 
-        }
1251 
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1252 
-            ? $payment_method_billing_form->get_html()
1253 
-            : '';
1254 
-        $this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
1255 
-        // localize validation rules for main form
1256 
-        $this->checkout->current_step->reg_form->localize_validation_rules();
1257 
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1258 
-        return true;
1259 
-    }
1260 
-
1261 
-
1262 
-    /**
1263 
-     * _get_billing_form_for_payment_method
1264 
-     *
1265 
-     * @access private
1266 
-     * @param EE_Payment_Method $payment_method
1267 
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1268 
-     * @throws EE_Error
1269 
-     * @throws InvalidArgumentException
1270 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1271 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1272 
-     */
1273 
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1274 
-    {
1275 
-        $billing_form = $payment_method->type_obj()->billing_form(
1276 
-            $this->checkout->transaction,
1277 
-            array('amount_owing' => $this->checkout->amount_owing)
1278 
-        );
1279 
-        if ($billing_form instanceof EE_Billing_Info_Form) {
1280 
-            if (apply_filters(
1281 
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1282 
-                false
1283 
-            )
1284 
-                && EE_Registry::instance()->REQ->is_set('payment_method')
1285 
-            ) {
1286 
-                EE_Error::add_success(
1287 
-                    apply_filters(
1288 
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1289 
-                        sprintf(
1290 
-                            esc_html__(
1291 
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
1292 
-                                'event_espresso'
1293 
-                            ),
1294 
-                            $payment_method->name()
1295 
-                        )
1296 
-                    )
1297 
-                );
1298 
-            }
1299 
-            return apply_filters(
1300 
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1301 
-                $billing_form,
1302 
-                $payment_method
1303 
-            );
1304 
-        }
1305 
-        // no actual billing form, so return empty HTML form section
1306 
-        return new EE_Form_Section_HTML();
1307 
-    }
1308 
-
1309 
-
1310 
-    /**
1311 
-     * _get_selected_method_of_payment
1312 
-     *
1313 
-     * @access private
1314 
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1315 
-     *                          is not found in the incoming request
1316 
-     * @param string  $request_param
1317 
-     * @return NULL|string
1318 
-     * @throws EE_Error
1319 
-     * @throws InvalidArgumentException
1320 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1321 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1322 
-     */
1323 
-    private function _get_selected_method_of_payment(
1324 
-        $required = false,
1325 
-        $request_param = 'selected_method_of_payment'
1326 
-    ) {
1327 
-        // is selected_method_of_payment set in the request ?
1328 
-        $selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
1329 
-        if ($selected_method_of_payment) {
1330 
-            // sanitize it
1331 
-            $selected_method_of_payment = is_array($selected_method_of_payment)
1332 
-                ? array_shift($selected_method_of_payment)
1333 
-                : $selected_method_of_payment;
1334 
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1335 
-            // store it in the session so that it's available for all subsequent requests including AJAX
1336 
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
1337 
-        } else {
1338 
-            // or is is set in the session ?
1339 
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1340 
-                'selected_method_of_payment'
1341 
-            );
1342 
-        }
1343 
-        // do ya really really gotta have it?
1344 
-        if (empty($selected_method_of_payment) && $required) {
1345 
-            EE_Error::add_error(
1346 
-                sprintf(
1347 
-                    esc_html__(
1348 
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
1349 
-                        'event_espresso'
1350 
-                    ),
1351 
-                    '<br/>',
1352 
-                    '<br/>',
1353 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
1354 
-                ),
1355 
-                __FILE__,
1356 
-                __FUNCTION__,
1357 
-                __LINE__
1358 
-            );
1359 
-            return null;
1360 
-        }
1361 
-        return $selected_method_of_payment;
1362 
-    }
1363 
-
1364 
-
1365 
-
1366 
-
1367 
-
1368 
-
1369 
-    /********************************************************************************************************/
1370 
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
1371 
-    /********************************************************************************************************/
1372 
-    /**
1373 
-     * switch_payment_method
1374 
-     *
1375 
-     * @access public
1376 
-     * @return string
1377 
-     * @throws EE_Error
1378 
-     * @throws InvalidArgumentException
1379 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1380 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1381 
-     */
1382 
-    public function switch_payment_method()
1383 
-    {
1384 
-        if (! $this->_verify_payment_method_is_set()) {
1385 
-            return false;
1386 
-        }
1387 
-        if (apply_filters(
1388 
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1389 
-            false
1390 
-        )) {
1391 
-            EE_Error::add_success(
1392 
-                apply_filters(
1393 
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1394 
-                    sprintf(
1395 
-                        esc_html__(
1396 
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
1397 
-                            'event_espresso'
1398 
-                        ),
1399 
-                        $this->checkout->payment_method->name()
1400 
-                    )
1401 
-                )
1402 
-            );
1403 
-        }
1404 
-        // generate billing form for selected method of payment if it hasn't been done already
1405 
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1406 
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1407 
-                $this->checkout->payment_method
1408 
-            );
1409 
-        }
1410 
-        // fill form with attendee info if applicable
1411 
-        if (apply_filters(
1412 
-            'FHEE__populate_billing_form_fields_from_attendee',
1413 
-            (
1414 
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1415 
-                && $this->checkout->transaction_has_primary_registrant()
1416 
-            ),
1417 
-            $this->checkout->billing_form,
1418 
-            $this->checkout->transaction
1419 
-        )
1420 
-        ) {
1421 
-            $this->checkout->billing_form->populate_from_attendee(
1422 
-                $this->checkout->transaction->primary_registration()->attendee()
1423 
-            );
1424 
-        }
1425 
-        // and debug content
1426 
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
1427 
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1428 
-        ) {
1429 
-            $this->checkout->billing_form =
1430 
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1431 
-                    $this->checkout->billing_form
1432 
-                );
1433 
-        }
1434 
-        // get html and validation rules for form
1435 
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1436 
-            $this->checkout->json_response->set_return_data(
1437 
-                array('payment_method_info' => $this->checkout->billing_form->get_html())
1438 
-            );
1439 
-            // localize validation rules for main form
1440 
-            $this->checkout->billing_form->localize_validation_rules(true);
1441 
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1442 
-        } else {
1443 
-            $this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
1444 
-        }
1445 
-        // prevents advancement to next step
1446 
-        $this->checkout->continue_reg = false;
1447 
-        return true;
1448 
-    }
1449 
-
1450 
-
1451 
-    /**
1452 
-     * _verify_payment_method_is_set
1453 
-     *
1454 
-     * @return bool
1455 
-     * @throws EE_Error
1456 
-     * @throws InvalidArgumentException
1457 
-     * @throws ReflectionException
1458 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1459 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1460 
-     */
1461 
-    protected function _verify_payment_method_is_set()
1462 
-    {
1463 
-        // generate billing form for selected method of payment if it hasn't been done already
1464 
-        if (empty($this->checkout->selected_method_of_payment)) {
1465 
-            // how have they chosen to pay?
1466 
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1467 
-        } else {
1468 
-            // choose your own adventure based on method_of_payment
1469 
-            switch ($this->checkout->selected_method_of_payment) {
1470 
-                case 'events_sold_out':
1471 
-                    EE_Error::add_attention(
1472 
-                        apply_filters(
1473 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1474 
-                            esc_html__(
1475 
-                                'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
1476 
-                                'event_espresso'
1477 
-                            )
1478 
-                        ),
1479 
-                        __FILE__,
1480 
-                        __FUNCTION__,
1481 
-                        __LINE__
1482 
-                    );
1483 
-                    return false;
1484 
-                    break;
1485 
-                case 'payments_closed':
1486 
-                    EE_Error::add_attention(
1487 
-                        apply_filters(
1488 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1489 
-                            esc_html__(
1490 
-                                'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
1491 
-                                'event_espresso'
1492 
-                            )
1493 
-                        ),
1494 
-                        __FILE__,
1495 
-                        __FUNCTION__,
1496 
-                        __LINE__
1497 
-                    );
1498 
-                    return false;
1499 
-                    break;
1500 
-                case 'no_payment_required':
1501 
-                    EE_Error::add_attention(
1502 
-                        apply_filters(
1503 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1504 
-                            esc_html__(
1505 
-                                'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
1506 
-                                'event_espresso'
1507 
-                            )
1508 
-                        ),
1509 
-                        __FILE__,
1510 
-                        __FUNCTION__,
1511 
-                        __LINE__
1512 
-                    );
1513 
-                    return false;
1514 
-                    break;
1515 
-                default:
1516 
-            }
1517 
-        }
1518 
-        // verify payment method
1519 
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1520 
-            // get payment method for selected method of payment
1521 
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1522 
-        }
1523 
-        return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
1524 
-    }
1525 
-
1526 
-
1527 
-
1528 
-    /********************************************************************************************************/
1529 
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
1530 
-    /********************************************************************************************************/
1531 
-    /**
1532 
-     * save_payer_details_via_ajax
1533 
-     *
1534 
-     * @return void
1535 
-     * @throws EE_Error
1536 
-     * @throws InvalidArgumentException
1537 
-     * @throws ReflectionException
1538 
-     * @throws RuntimeException
1539 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1540 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1541 
-     */
1542 
-    public function save_payer_details_via_ajax()
1543 
-    {
1544 
-        if (! $this->_verify_payment_method_is_set()) {
1545 
-            return;
1546 
-        }
1547 
-        // generate billing form for selected method of payment if it hasn't been done already
1548 
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1549 
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1550 
-                $this->checkout->payment_method
1551 
-            );
1552 
-        }
1553 
-        // generate primary attendee from payer info if applicable
1554 
-        if (! $this->checkout->transaction_has_primary_registrant()) {
1555 
-            $attendee = $this->_create_attendee_from_request_data();
1556 
-            if ($attendee instanceof EE_Attendee) {
1557 
-                foreach ($this->checkout->transaction->registrations() as $registration) {
1558 
-                    if ($registration->is_primary_registrant()) {
1559 
-                        $this->checkout->primary_attendee_obj = $attendee;
1560 
-                        $registration->_add_relation_to($attendee, 'Attendee');
1561 
-                        $registration->set_attendee_id($attendee->ID());
1562 
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
1563 
-                    }
1564 
-                }
1565 
-            }
1566 
-        }
1567 
-    }
1568 
-
1569 
-
1570 
-    /**
1571 
-     * create_attendee_from_request_data
1572 
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1573 
-     *
1574 
-     * @return EE_Attendee
1575 
-     * @throws EE_Error
1576 
-     * @throws InvalidArgumentException
1577 
-     * @throws ReflectionException
1578 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1579 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1580 
-     */
1581 
-    protected function _create_attendee_from_request_data()
1582 
-    {
1583 
-        // get State ID
1584 
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
1585 
-        if (! empty($STA_ID)) {
1586 
-            // can we get state object from name ?
1587 
-            EE_Registry::instance()->load_model('State');
1588 
-            $state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
1589 
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1590 
-        }
1591 
-        // get Country ISO
1592 
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
1593 
-        if (! empty($CNT_ISO)) {
1594 
-            // can we get country object from name ?
1595 
-            EE_Registry::instance()->load_model('Country');
1596 
-            $country = EEM_Country::instance()->get_col(
1597 
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
1598 
-                'CNT_ISO'
1599 
-            );
1600 
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1601 
-        }
1602 
-        // grab attendee data
1603 
-        $attendee_data = array(
1604 
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
1605 
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
1606 
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
1607 
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
1608 
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
1609 
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
1610 
-            'STA_ID'       => $STA_ID,
1611 
-            'CNT_ISO'      => $CNT_ISO,
1612 
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
1613 
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
1614 
-        );
1615 
-        // validate the email address since it is the most important piece of info
1616 
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
1617 
-            EE_Error::add_error(
1618 
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
1619 
-                __FILE__,
1620 
-                __FUNCTION__,
1621 
-                __LINE__
1622 
-            );
1623 
-        }
1624 
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1625 
-        // AND email address
1626 
-        if (! empty($attendee_data['ATT_fname'])
1627 
-            && ! empty($attendee_data['ATT_lname'])
1628 
-            && ! empty($attendee_data['ATT_email'])
1629 
-        ) {
1630 
-            $existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
1631 
-                array(
1632 
-                    'ATT_fname' => $attendee_data['ATT_fname'],
1633 
-                    'ATT_lname' => $attendee_data['ATT_lname'],
1634 
-                    'ATT_email' => $attendee_data['ATT_email'],
1635 
-                )
1636 
-            );
1637 
-            if ($existing_attendee instanceof EE_Attendee) {
1638 
-                return $existing_attendee;
1639 
-            }
1640 
-        }
1641 
-        // no existing attendee? kk let's create a new one
1642 
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1643 
-        // don't exist
1644 
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1645 
-            ? $attendee_data['ATT_fname']
1646 
-            : $attendee_data['ATT_email'];
1647 
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1648 
-            ? $attendee_data['ATT_lname']
1649 
-            : $attendee_data['ATT_email'];
1650 
-        return EE_Attendee::new_instance($attendee_data);
1651 
-    }
1652 
-
1653 
-
1654 
-
1655 
-    /********************************************************************************************************/
1656 
-    /****************************************  PROCESS REG STEP  *****************************************/
1657 
-    /********************************************************************************************************/
1658 
-    /**
1659 
-     * process_reg_step
1660 
-     *
1661 
-     * @return bool
1662 
-     * @throws EE_Error
1663 
-     * @throws InvalidArgumentException
1664 
-     * @throws ReflectionException
1665 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1666 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1667 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1668 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
1669 
-     */
1670 
-    public function process_reg_step()
1671 
-    {
1672 
-        // how have they chosen to pay?
1673 
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1674 
-            ? 'no_payment_required'
1675 
-            : $this->_get_selected_method_of_payment(true);
1676 
-        // choose your own adventure based on method_of_payment
1677 
-        switch ($this->checkout->selected_method_of_payment) {
1678 
-            case 'events_sold_out':
1679 
-                $this->checkout->redirect = true;
1680 
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
1681 
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1682 
-                // mark this reg step as completed
1683 
-                $this->set_completed();
1684 
-                return false;
1685 
-                break;
1686 
-
1687 
-            case 'payments_closed':
1688 
-                if (apply_filters(
1689 
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1690 
-                    false
1691 
-                )) {
1692 
-                    EE_Error::add_success(
1693 
-                        esc_html__('no payment required at this time.', 'event_espresso'),
1694 
-                        __FILE__,
1695 
-                        __FUNCTION__,
1696 
-                        __LINE__
1697 
-                    );
1698 
-                }
1699 
-                // mark this reg step as completed
1700 
-                $this->set_completed();
1701 
-                return true;
1702 
-                break;
1703 
-
1704 
-            case 'no_payment_required':
1705 
-                if (apply_filters(
1706 
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1707 
-                    false
1708 
-                )) {
1709 
-                    EE_Error::add_success(
1710 
-                        esc_html__('no payment required.', 'event_espresso'),
1711 
-                        __FILE__,
1712 
-                        __FUNCTION__,
1713 
-                        __LINE__
1714 
-                    );
1715 
-                }
1716 
-                // mark this reg step as completed
1717 
-                $this->set_completed();
1718 
-                return true;
1719 
-                break;
1720 
-
1721 
-            default:
1722 
-                $registrations = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1723 
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1724 
-                );
1725 
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1726 
-                    $registrations,
1727 
-                    EE_Registry::instance()->SSN->checkout()->revisit
1728 
-                );
1729 
-                // calculate difference between the two arrays
1730 
-                $registrations = array_diff($registrations, $ejected_registrations);
1731 
-                if (empty($registrations)) {
1732 
-                    $this->_redirect_because_event_sold_out();
1733 
-                    return false;
1734 
-                }
1735 
-                $payment_successful = $this->_process_payment();
1736 
-                if ($payment_successful) {
1737 
-                    $this->checkout->continue_reg = true;
1738 
-                    $this->_maybe_set_completed($this->checkout->payment_method);
1739 
-                } else {
1740 
-                    $this->checkout->continue_reg = false;
1741 
-                }
1742 
-                return $payment_successful;
1743 
-        }
1744 
-    }
1745 
-
1746 
-
1747 
-    /**
1748 
-     * _redirect_because_event_sold_out
1749 
-     *
1750 
-     * @access protected
1751 
-     * @return void
1752 
-     */
1753 
-    protected function _redirect_because_event_sold_out()
1754 
-    {
1755 
-        $this->checkout->continue_reg = false;
1756 
-        // set redirect URL
1757 
-        $this->checkout->redirect_url = add_query_arg(
1758 
-            array('e_reg_url_link' => $this->checkout->reg_url_link),
1759 
-            $this->checkout->current_step->reg_step_url()
1760 
-        );
1761 
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1762 
-    }
1763 
-
1764 
-
1765 
-    /**
1766 
-     * _maybe_set_completed
1767 
-     *
1768 
-     * @access protected
1769 
-     * @param \EE_Payment_Method $payment_method
1770 
-     * @return void
1771 
-     * @throws \EE_Error
1772 
-     */
1773 
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
1774 
-    {
1775 
-        switch ($payment_method->type_obj()->payment_occurs()) {
1776 
-            case EE_PMT_Base::offsite:
1777 
-                break;
1778 
-            case EE_PMT_Base::onsite:
1779 
-            case EE_PMT_Base::offline:
1780 
-                // mark this reg step as completed
1781 
-                $this->set_completed();
1782 
-                break;
1783 
-        }
1784 
-    }
1785 
-
1786 
-
1787 
-    /**
1788 
-     *    update_reg_step
1789 
-     *    this is the final step after a user  revisits the site to retry a payment
1790 
-     *
1791 
-     * @return bool
1792 
-     * @throws EE_Error
1793 
-     * @throws InvalidArgumentException
1794 
-     * @throws ReflectionException
1795 
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1796 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1797 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1798 
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
1799 
-     */
1800 
-    public function update_reg_step()
1801 
-    {
1802 
-        $success = true;
1803 
-        // if payment required
1804 
-        if ($this->checkout->transaction->total() > 0) {
1805 
-            do_action(
1806 
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1807 
-                $this->checkout->transaction
1808 
-            );
1809 
-            // attempt payment via payment method
1810 
-            $success = $this->process_reg_step();
1811 
-        }
1812 
-        if ($success && ! $this->checkout->redirect) {
1813 
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1814 
-                $this->checkout->transaction->ID()
1815 
-            );
1816 
-            // set return URL
1817 
-            $this->checkout->redirect_url = add_query_arg(
1818 
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
1819 
-                $this->checkout->thank_you_page_url
1820 
-            );
1821 
-        }
1822 
-        return $success;
1823 
-    }
1824 
-
1825 
-
1826 
-    /**
1827 
-     *    _process_payment
1828 
-     *
1829 
-     * @access private
1830 
-     * @return bool
1831 
-     * @throws EE_Error
1832 
-     * @throws InvalidArgumentException
1833 
-     * @throws ReflectionException
1834 
-     * @throws RuntimeException
1835 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1836 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1837 
-     */
1838 
-    private function _process_payment()
1839 
-    {
1840 
-        // basically confirm that the event hasn't sold out since they hit the page
1841 
-        if (! $this->_last_second_ticket_verifications()) {
1842 
-            return false;
1843 
-        }
1844 
-        // ya gotta make a choice man
1845 
-        if (empty($this->checkout->selected_method_of_payment)) {
1846 
-            $this->checkout->json_response->set_plz_select_method_of_payment(
1847 
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1848 
-            );
1849 
-            return false;
1850 
-        }
1851 
-        // get EE_Payment_Method object
1852 
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853 
-            return false;
1854 
-        }
1855 
-        // setup billing form
1856 
-        if ($this->checkout->payment_method->is_on_site()) {
1857 
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1858 
-                $this->checkout->payment_method
1859 
-            );
1860 
-            // bad billing form ?
1861 
-            if (! $this->_billing_form_is_valid()) {
1862 
-                return false;
1863 
-            }
1864 
-        }
1865 
-        // ensure primary registrant has been fully processed
1866 
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
1867 
-            return false;
1868 
-        }
1869 
-        // if session is close to expiring (under 10 minutes by default)
1870 
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1871 
-            // add some time to session expiration so that payment can be completed
1872 
-            EE_Registry::instance()->SSN->extend_expiration();
1873 
-        }
1874 
-        /** @type EE_Transaction_Processor $transaction_processor */
1875 
-        // $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1876 
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1877 
-        // for events with a default reg status of Approved
1878 
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1879 
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1880 
-        // );
1881 
-        // attempt payment
1882 
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
1883 
-        // process results
1884 
-        $payment = $this->_validate_payment($payment);
1885 
-        $payment = $this->_post_payment_processing($payment);
1886 
-        // verify payment
1887 
-        if ($payment instanceof EE_Payment) {
1888 
-            // store that for later
1889 
-            $this->checkout->payment = $payment;
1890 
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1891 
-            $this->checkout->transaction->toggle_failed_transaction_status();
1892 
-            $payment_status = $payment->status();
1893 
-            if ($payment_status === EEM_Payment::status_id_approved
1894 
-                || $payment_status === EEM_Payment::status_id_pending
1895 
-            ) {
1896 
-                return true;
1897 
-            } else {
1898 
-                return false;
1899 
-            }
1900 
-        } elseif ($payment === true) {
1901 
-            // please note that offline payment methods will NOT make a payment,
1902 
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
1903 
-            $this->checkout->payment = $payment;
1904 
-            return true;
1905 
-        }
1906 
-        // where's my money?
1907 
-        return false;
1908 
-    }
1909 
-
1910 
-
1911 
-    /**
1912 
-     * _last_second_ticket_verifications
1913 
-     *
1914 
-     * @access public
1915 
-     * @return bool
1916 
-     * @throws EE_Error
1917 
-     */
1918 
-    protected function _last_second_ticket_verifications()
1919 
-    {
1920 
-        // don't bother re-validating if not a return visit
1921 
-        if (! $this->checkout->revisit) {
1922 
-            return true;
1923 
-        }
1924 
-        $registrations = $this->checkout->transaction->registrations();
1925 
-        if (empty($registrations)) {
1926 
-            return false;
1927 
-        }
1928 
-        foreach ($registrations as $registration) {
1929 
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1930 
-                $event = $registration->event_obj();
1931 
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1932 
-                    EE_Error::add_error(
1933 
-                        apply_filters(
1934 
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1935 
-                            sprintf(
1936 
-                                esc_html__(
1937 
-                                    'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
1938 
-                                    'event_espresso'
1939 
-                                ),
1940 
-                                $event->name()
1941 
-                            )
1942 
-                        ),
1943 
-                        __FILE__,
1944 
-                        __FUNCTION__,
1945 
-                        __LINE__
1946 
-                    );
1947 
-                    return false;
1948 
-                }
1949 
-            }
1950 
-        }
1951 
-        return true;
1952 
-    }
1953 
-
1954 
-
1955 
-    /**
1956 
-     * redirect_form
1957 
-     *
1958 
-     * @access public
1959 
-     * @return bool
1960 
-     * @throws EE_Error
1961 
-     * @throws InvalidArgumentException
1962 
-     * @throws ReflectionException
1963 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1964 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1965 
-     */
1966 
-    public function redirect_form()
1967 
-    {
1968 
-        $payment_method_billing_info = $this->_payment_method_billing_info(
1969 
-            $this->_get_payment_method_for_selected_method_of_payment()
1970 
-        );
1971 
-        $html = $payment_method_billing_info->get_html();
1972 
-        $html .= $this->checkout->redirect_form;
1973 
-        EE_Registry::instance()->REQ->add_output($html);
1974 
-        return true;
1975 
-    }
1976 
-
1977 
-
1978 
-    /**
1979 
-     * _billing_form_is_valid
1980 
-     *
1981 
-     * @access private
1982 
-     * @return bool
1983 
-     * @throws \EE_Error
1984 
-     */
1985 
-    private function _billing_form_is_valid()
1986 
-    {
1987 
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1988 
-            return true;
1989 
-        }
1990 
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1991 
-            if ($this->checkout->billing_form->was_submitted()) {
1992 
-                $this->checkout->billing_form->receive_form_submission();
1993 
-                if ($this->checkout->billing_form->is_valid()) {
1994 
-                    return true;
1995 
-                }
1996 
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1997 
-                $error_strings = array();
1998 
-                foreach ($validation_errors as $validation_error) {
1999 
-                    if ($validation_error instanceof EE_Validation_Error) {
2000 
-                        $form_section = $validation_error->get_form_section();
2001 
-                        if ($form_section instanceof EE_Form_Input_Base) {
2002 
-                            $label = $form_section->html_label_text();
2003 
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
2004 
-                            $label = $form_section->name();
2005 
-                        } else {
2006 
-                            $label = esc_html__('Validation Error', 'event_espresso');
2007 
-                        }
2008 
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2009 
-                    }
2010 
-                }
2011 
-                EE_Error::add_error(
2012 
-                    sprintf(
2013 
-                        esc_html__(
2014 
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2015 
-                            'event_espresso'
2016 
-                        ),
2017 
-                        '<br/>',
2018 
-                        implode('<br/>', $error_strings)
2019 
-                    ),
2020 
-                    __FILE__,
2021 
-                    __FUNCTION__,
2022 
-                    __LINE__
2023 
-                );
2024 
-            } else {
2025 
-                EE_Error::add_error(
2026 
-                    esc_html__(
2027 
-                        'The billing form was not submitted or something prevented it\'s submission.',
2028 
-                        'event_espresso'
2029 
-                    ),
2030 
-                    __FILE__,
2031 
-                    __FUNCTION__,
2032 
-                    __LINE__
2033 
-                );
2034 
-            }
2035 
-        } else {
2036 
-            EE_Error::add_error(
2037 
-                esc_html__(
2038 
-                    'The submitted billing form is invalid possibly due to a technical reason.',
2039 
-                    'event_espresso'
2040 
-                ),
2041 
-                __FILE__,
2042 
-                __FUNCTION__,
2043 
-                __LINE__
2044 
-            );
2045 
-        }
2046 
-        return false;
2047 
-    }
2048 
-
2049 
-
2050 
-    /**
2051 
-     * _setup_primary_registrant_prior_to_payment
2052 
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
2053 
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
2054 
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2055 
-     * yet)
2056 
-     *
2057 
-     * @access private
2058 
-     * @return bool
2059 
-     * @throws EE_Error
2060 
-     * @throws InvalidArgumentException
2061 
-     * @throws ReflectionException
2062 
-     * @throws RuntimeException
2063 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2064 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2065 
-     */
2066 
-    private function _setup_primary_registrant_prior_to_payment()
2067 
-    {
2068 
-        // check if transaction has a primary registrant and that it has a related Attendee object
2069 
-        // if not, then we need to at least gather some primary registrant data before attempting payment
2070 
-        if ($this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2071 
-            && ! $this->checkout->transaction_has_primary_registrant()
2072 
-            && ! $this->_capture_primary_registration_data_from_billing_form()
2073 
-        ) {
2074 
-            return false;
2075 
-        }
2076 
-        // because saving an object clears it's cache, we need to do the chevy shuffle
2077 
-        // grab the primary_registration object
2078 
-        $primary_registration = $this->checkout->transaction->primary_registration();
2079 
-        // at this point we'll consider a TXN to not have been failed
2080 
-        $this->checkout->transaction->toggle_failed_transaction_status();
2081 
-        // save the TXN ( which clears cached copy of primary_registration)
2082 
-        $this->checkout->transaction->save();
2083 
-        // grab TXN ID and save it to the primary_registration
2084 
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
2085 
-        // save what we have so far
2086 
-        $primary_registration->save();
2087 
-        return true;
2088 
-    }
2089 
-
2090 
-
2091 
-    /**
2092 
-     * _capture_primary_registration_data_from_billing_form
2093 
-     *
2094 
-     * @access private
2095 
-     * @return bool
2096 
-     * @throws EE_Error
2097 
-     * @throws InvalidArgumentException
2098 
-     * @throws ReflectionException
2099 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2100 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2101 
-     */
2102 
-    private function _capture_primary_registration_data_from_billing_form()
2103 
-    {
2104 
-        // convert billing form data into an attendee
2105 
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2106 
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107 
-            EE_Error::add_error(
2108 
-                sprintf(
2109 
-                    esc_html__(
2110 
-                        'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2111 
-                        'event_espresso'
2112 
-                    ),
2113 
-                    '<br/>',
2114 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2115 
-                ),
2116 
-                __FILE__,
2117 
-                __FUNCTION__,
2118 
-                __LINE__
2119 
-            );
2120 
-            return false;
2121 
-        }
2122 
-        $primary_registration = $this->checkout->transaction->primary_registration();
2123 
-        if (! $primary_registration instanceof EE_Registration) {
2124 
-            EE_Error::add_error(
2125 
-                sprintf(
2126 
-                    esc_html__(
2127 
-                        'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2128 
-                        'event_espresso'
2129 
-                    ),
2130 
-                    '<br/>',
2131 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2132 
-                ),
2133 
-                __FILE__,
2134 
-                __FUNCTION__,
2135 
-                __LINE__
2136 
-            );
2137 
-            return false;
2138 
-        }
2139 
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2140 
-              instanceof
2141 
-              EE_Attendee
2142 
-        ) {
2143 
-            EE_Error::add_error(
2144 
-                sprintf(
2145 
-                    esc_html__(
2146 
-                        'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2147 
-                        'event_espresso'
2148 
-                    ),
2149 
-                    '<br/>',
2150 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2151 
-                ),
2152 
-                __FILE__,
2153 
-                __FUNCTION__,
2154 
-                __LINE__
2155 
-            );
2156 
-            return false;
2157 
-        }
2158 
-        /** @type EE_Registration_Processor $registration_processor */
2159 
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2160 
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2161 
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2162 
-        return true;
2163 
-    }
2164 
-
2165 
-
2166 
-    /**
2167 
-     * _get_payment_method_for_selected_method_of_payment
2168 
-     * retrieves a valid payment method
2169 
-     *
2170 
-     * @access public
2171 
-     * @return EE_Payment_Method
2172 
-     * @throws EE_Error
2173 
-     * @throws InvalidArgumentException
2174 
-     * @throws ReflectionException
2175 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2176 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2177 
-     */
2178 
-    private function _get_payment_method_for_selected_method_of_payment()
2179 
-    {
2180 
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2181 
-            $this->_redirect_because_event_sold_out();
2182 
-            return null;
2183 
-        }
2184 
-        // get EE_Payment_Method object
2185 
-        if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2186 
-            $payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2187 
-        } else {
2188 
-            // load EEM_Payment_Method
2189 
-            EE_Registry::instance()->load_model('Payment_Method');
2190 
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
2191 
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
2192 
-            $payment_method = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
2193 
-        }
2194 
-        // verify $payment_method
2195 
-        if (! $payment_method instanceof EE_Payment_Method) {
2196 
-            // not a payment
2197 
-            EE_Error::add_error(
2198 
-                sprintf(
2199 
-                    esc_html__(
2200 
-                        'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2201 
-                        'event_espresso'
2202 
-                    ),
2203 
-                    '<br/>',
2204 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2205 
-                ),
2206 
-                __FILE__,
2207 
-                __FUNCTION__,
2208 
-                __LINE__
2209 
-            );
2210 
-            return null;
2211 
-        }
2212 
-        // and verify it has a valid Payment_Method Type object
2213 
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
2214 
-            // not a payment
2215 
-            EE_Error::add_error(
2216 
-                sprintf(
2217 
-                    esc_html__(
2218 
-                        'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2219 
-                        'event_espresso'
2220 
-                    ),
2221 
-                    '<br/>',
2222 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2223 
-                ),
2224 
-                __FILE__,
2225 
-                __FUNCTION__,
2226 
-                __LINE__
2227 
-            );
2228 
-            return null;
2229 
-        }
2230 
-        return $payment_method;
2231 
-    }
2232 
-
2233 
-
2234 
-    /**
2235 
-     *    _attempt_payment
2236 
-     *
2237 
-     * @access    private
2238 
-     * @type    EE_Payment_Method $payment_method
2239 
-     * @return mixed EE_Payment | boolean
2240 
-     * @throws EE_Error
2241 
-     * @throws InvalidArgumentException
2242 
-     * @throws ReflectionException
2243 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2244 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2245 
-     */
2246 
-    private function _attempt_payment(EE_Payment_Method $payment_method)
2247 
-    {
2248 
-        $payment = null;
2249 
-        $this->checkout->transaction->save();
2250 
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2251 
-        if (! $payment_processor instanceof EE_Payment_Processor) {
2252 
-            return false;
2253 
-        }
2254 
-        try {
2255 
-            $payment_processor->set_revisit($this->checkout->revisit);
2256 
-            // generate payment object
2257 
-            $payment = $payment_processor->process_payment(
2258 
-                $payment_method,
2259 
-                $this->checkout->transaction,
2260 
-                $this->checkout->amount_owing,
2261 
-                $this->checkout->billing_form,
2262 
-                $this->_get_return_url($payment_method),
2263 
-                'CART',
2264 
-                $this->checkout->admin_request,
2265 
-                true,
2266 
-                $this->reg_step_url()
2267 
-            );
2268 
-        } catch (Exception $e) {
2269 
-            $this->_handle_payment_processor_exception($e);
2270 
-        }
2271 
-        return $payment;
2272 
-    }
2273 
-
2274 
-
2275 
-    /**
2276 
-     * _handle_payment_processor_exception
2277 
-     *
2278 
-     * @access protected
2279 
-     * @param \Exception $e
2280 
-     * @return void
2281 
-     * @throws EE_Error
2282 
-     * @throws InvalidArgumentException
2283 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2284 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2285 
-     */
2286 
-    protected function _handle_payment_processor_exception(Exception $e)
2287 
-    {
2288 
-        EE_Error::add_error(
2289 
-            sprintf(
2290 
-                esc_html__(
2291 
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
2292 
-                    'event_espresso'
2293 
-                ),
2294 
-                '<br/>',
2295 
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
2296 
-                $e->getMessage(),
2297 
-                $e->getFile(),
2298 
-                $e->getLine()
2299 
-            ),
2300 
-            __FILE__,
2301 
-            __FUNCTION__,
2302 
-            __LINE__
2303 
-        );
2304 
-    }
2305 
-
2306 
-
2307 
-    /**
2308 
-     * _get_return_url
2309 
-     *
2310 
-     * @access protected
2311 
-     * @param \EE_Payment_Method $payment_method
2312 
-     * @return string
2313 
-     * @throws \EE_Error
2314 
-     */
2315 
-    protected function _get_return_url(EE_Payment_Method $payment_method)
2316 
-    {
2317 
-        $return_url = '';
2318 
-        switch ($payment_method->type_obj()->payment_occurs()) {
2319 
-            case EE_PMT_Base::offsite:
2320 
-                $return_url = add_query_arg(
2321 
-                    array(
2322 
-                        'action'                     => 'process_gateway_response',
2323 
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2324 
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
2325 
-                    ),
2326 
-                    $this->reg_step_url()
2327 
-                );
2328 
-                break;
2329 
-            case EE_PMT_Base::onsite:
2330 
-            case EE_PMT_Base::offline:
2331 
-                $return_url = $this->checkout->next_step->reg_step_url();
2332 
-                break;
2333 
-        }
2334 
-        return $return_url;
2335 
-    }
2336 
-
2337 
-
2338 
-    /**
2339 
-     * _validate_payment
2340 
-     *
2341 
-     * @access private
2342 
-     * @param EE_Payment $payment
2343 
-     * @return EE_Payment|FALSE
2344 
-     * @throws EE_Error
2345 
-     * @throws InvalidArgumentException
2346 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2347 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2348 
-     */
2349 
-    private function _validate_payment($payment = null)
2350 
-    {
2351 
-        if ($this->checkout->payment_method->is_off_line()) {
2352 
-            return true;
2353 
-        }
2354 
-        // verify payment object
2355 
-        if (! $payment instanceof EE_Payment) {
2356 
-            // not a payment
2357 
-            EE_Error::add_error(
2358 
-                sprintf(
2359 
-                    esc_html__(
2360 
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2361 
-                        'event_espresso'
2362 
-                    ),
2363 
-                    '<br/>',
2364 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2365 
-                ),
2366 
-                __FILE__,
2367 
-                __FUNCTION__,
2368 
-                __LINE__
2369 
-            );
2370 
-            return false;
2371 
-        }
2372 
-        return $payment;
2373 
-    }
2374 
-
2375 
-
2376 
-    /**
2377 
-     * _post_payment_processing
2378 
-     *
2379 
-     * @access private
2380 
-     * @param EE_Payment|bool $payment
2381 
-     * @return bool
2382 
-     * @throws EE_Error
2383 
-     * @throws InvalidArgumentException
2384 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2385 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2386 
-     */
2387 
-    private function _post_payment_processing($payment = null)
2388 
-    {
2389 
-        // Off-Line payment?
2390 
-        if ($payment === true) {
2391 
-            // $this->_setup_redirect_for_next_step();
2392 
-            return true;
2393 
-            // On-Site payment?
2394 
-        } elseif ($this->checkout->payment_method->is_on_site()) {
2395 
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2396 
-                // $this->_setup_redirect_for_next_step();
2397 
-                $this->checkout->continue_reg = false;
2398 
-            }
2399 
-            // Off-Site payment?
2400 
-        } elseif ($this->checkout->payment_method->is_off_site()) {
2401 
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
2402 
-            if ($payment instanceof EE_Payment && $payment->redirect_url()) {
2403 
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2404 
-                $this->checkout->redirect = true;
2405 
-                $this->checkout->redirect_form = $payment->redirect_form();
2406 
-                $this->checkout->redirect_url = $this->reg_step_url('redirect_form');
2407 
-                // set JSON response
2408 
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2409 
-                // and lastly, let's bump the payment status to pending
2410 
-                $payment->set_status(EEM_Payment::status_id_pending);
2411 
-                $payment->save();
2412 
-            } else {
2413 
-                // not a payment
2414 
-                $this->checkout->continue_reg = false;
2415 
-                EE_Error::add_error(
2416 
-                    sprintf(
2417 
-                        esc_html__(
2418 
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
2419 
-                            'event_espresso'
2420 
-                        ),
2421 
-                        '<br/>',
2422 
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
2423 
-                    ),
2424 
-                    __FILE__,
2425 
-                    __FUNCTION__,
2426 
-                    __LINE__
2427 
-                );
2428 
-            }
2429 
-        } else {
2430 
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
2431 
-            $this->checkout->continue_reg = false;
2432 
-            return false;
2433 
-        }
2434 
-        return $payment;
2435 
-    }
2436 
-
2437 
-
2438 
-    /**
2439 
-     *    _process_payment_status
2440 
-     *
2441 
-     * @access private
2442 
-     * @type    EE_Payment $payment
2443 
-     * @param string       $payment_occurs
2444 
-     * @return bool
2445 
-     * @throws EE_Error
2446 
-     * @throws InvalidArgumentException
2447 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2448 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2449 
-     */
2450 
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2451 
-    {
2452 
-        // off-line payment? carry on
2453 
-        if ($payment_occurs === EE_PMT_Base::offline) {
2454 
-            return true;
2455 
-        }
2456 
-        // verify payment validity
2457 
-        if ($payment instanceof EE_Payment) {
2458 
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2459 
-            $msg = $payment->gateway_response();
2460 
-            // check results
2461 
-            switch ($payment->status()) {
2462 
-                // good payment
2463 
-                case EEM_Payment::status_id_approved:
2464 
-                    EE_Error::add_success(
2465 
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
2466 
-                        __FILE__,
2467 
-                        __FUNCTION__,
2468 
-                        __LINE__
2469 
-                    );
2470 
-                    return true;
2471 
-                    break;
2472 
-                // slow payment
2473 
-                case EEM_Payment::status_id_pending:
2474 
-                    if (empty($msg)) {
2475 
-                        $msg = esc_html__(
2476 
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2477 
-                            'event_espresso'
2478 
-                        );
2479 
-                    }
2480 
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2481 
-                    return true;
2482 
-                    break;
2483 
-                // don't wanna payment
2484 
-                case EEM_Payment::status_id_cancelled:
2485 
-                    if (empty($msg)) {
2486 
-                        $msg = _n(
2487 
-                            'Payment cancelled. Please try again.',
2488 
-                            'Payment cancelled. Please try again or select another method of payment.',
2489 
-                            count($this->checkout->available_payment_methods),
2490 
-                            'event_espresso'
2491 
-                        );
2492 
-                    }
2493 
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2494 
-                    return false;
2495 
-                    break;
2496 
-                // not enough payment
2497 
-                case EEM_Payment::status_id_declined:
2498 
-                    if (empty($msg)) {
2499 
-                        $msg = _n(
2500 
-                            'We\'re sorry but your payment was declined. Please try again.',
2501 
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2502 
-                            count($this->checkout->available_payment_methods),
2503 
-                            'event_espresso'
2504 
-                        );
2505 
-                    }
2506 
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2507 
-                    return false;
2508 
-                    break;
2509 
-                // bad payment
2510 
-                case EEM_Payment::status_id_failed:
2511 
-                    if (! empty($msg)) {
2512 
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2513 
-                        return false;
2514 
-                    }
2515 
-                    // default to error below
2516 
-                    break;
2517 
-            }
2518 
-        }
2519 
-        // off-site payment gateway responses are too unreliable, so let's just assume that
2520 
-        // the payment processing is just running slower than the registrant's request
2521 
-        if ($payment_occurs === EE_PMT_Base::offsite) {
2522 
-            return true;
2523 
-        }
2524 
-        EE_Error::add_error(
2525 
-            sprintf(
2526 
-                esc_html__(
2527 
-                    'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2528 
-                    'event_espresso'
2529 
-                ),
2530 
-                '<br/>',
2531 
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
2532 
-            ),
2533 
-            __FILE__,
2534 
-            __FUNCTION__,
2535 
-            __LINE__
2536 
-        );
2537 
-        return false;
2538 
-    }
2539 
-
2540 
-
2541 
-
2542 
-
2543 
-
2544 
-
2545 
-    /********************************************************************************************************/
2546 
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2547 
-    /********************************************************************************************************/
2548 
-    /**
2549 
-     * process_gateway_response
2550 
-     * this is the return point for Off-Site Payment Methods
2551 
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2552 
-     * otherwise, it will load up the last payment made for the TXN.
2553 
-     * If the payment retrieved looks good, it will then either:
2554 
-     *    complete the current step and allow advancement to the next reg step
2555 
-     *        or present the payment options again
2556 
-     *
2557 
-     * @access private
2558 
-     * @return EE_Payment|FALSE
2559 
-     * @throws EE_Error
2560 
-     * @throws InvalidArgumentException
2561 
-     * @throws ReflectionException
2562 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2563 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2564 
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2565 
-     */
2566 
-    public function process_gateway_response()
2567 
-    {
2568 
-        $payment = null;
2569 
-        // how have they chosen to pay?
2570 
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2571 
-        // get EE_Payment_Method object
2572 
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2573 
-            $this->checkout->continue_reg = false;
2574 
-            return false;
2575 
-        }
2576 
-        if (! $this->checkout->payment_method->is_off_site()) {
2577 
-            return false;
2578 
-        }
2579 
-        $this->_validate_offsite_return();
2580 
-        // DEBUG LOG
2581 
-        // $this->checkout->log(
2582 
-        //     __CLASS__,
2583 
-        //     __FUNCTION__,
2584 
-        //     __LINE__,
2585 
-        //     array(
2586 
-        //         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2587 
-        //         'payment_method'             => $this->checkout->payment_method,
2588 
-        //     ),
2589 
-        //     true
2590 
-        // );
2591 
-        // verify TXN
2592 
-        if ($this->checkout->transaction instanceof EE_Transaction) {
2593 
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2594 
-            if (! $gateway instanceof EE_Offsite_Gateway) {
2595 
-                $this->checkout->continue_reg = false;
2596 
-                return false;
2597 
-            }
2598 
-            $payment = $this->_process_off_site_payment($gateway);
2599 
-            $payment = $this->_process_cancelled_payments($payment);
2600 
-            $payment = $this->_validate_payment($payment);
2601 
-            // if payment was not declined by the payment gateway or cancelled by the registrant
2602 
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2603 
-                // $this->_setup_redirect_for_next_step();
2604 
-                // store that for later
2605 
-                $this->checkout->payment = $payment;
2606 
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2607 
-                // because we will complete this step during the IPN processing then
2608 
-                if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
2609 
-                    $this->set_completed();
2610 
-                }
2611 
-                return true;
2612 
-            }
2613 
-        }
2614 
-        // DEBUG LOG
2615 
-        // $this->checkout->log(
2616 
-        //     __CLASS__,
2617 
-        //     __FUNCTION__,
2618 
-        //     __LINE__,
2619 
-        //     array('payment' => $payment)
2620 
-        // );
2621 
-        $this->checkout->continue_reg = false;
2622 
-        return false;
2623 
-    }
2624 
-
2625 
-
2626 
-    /**
2627 
-     * _validate_return
2628 
-     *
2629 
-     * @access private
2630 
-     * @return void
2631 
-     * @throws EE_Error
2632 
-     * @throws InvalidArgumentException
2633 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2634 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2635 
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2636 
-     */
2637 
-    private function _validate_offsite_return()
2638 
-    {
2639 
-        $TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
2640 
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
2641 
-            // Houston... we might have a problem
2642 
-            $invalid_TXN = false;
2643 
-            // first gather some info
2644 
-            $valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2645 
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
2646 
-                ? $valid_TXN->primary_registration()
2647 
-                : null;
2648 
-            // let's start by retrieving the cart for this TXN
2649 
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2650 
-            if ($cart instanceof EE_Cart) {
2651 
-                // verify that the current cart has tickets
2652 
-                $tickets = $cart->get_tickets();
2653 
-                if (empty($tickets)) {
2654 
-                    $invalid_TXN = true;
2655 
-                }
2656 
-            } else {
2657 
-                $invalid_TXN = true;
2658 
-            }
2659 
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
2660 
-                ? $primary_registrant->session_ID()
2661 
-                : null;
2662 
-            // validate current Session ID and compare against valid TXN session ID
2663 
-            if ($invalid_TXN // if this is already true, then skip other checks
2664 
-                || EE_Session::instance()->id() === null
2665 
-                || (
2666 
-                    // WARNING !!!
2667 
-                    // this could be PayPal sending back duplicate requests (ya they do that)
2668 
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
2669 
-                    // so now we need to determine if this current TXN looks valid or not
2670 
-                    // and whether this reg step has even been started ?
2671 
-                    EE_Session::instance()->id() === $valid_TXN_SID
2672 
-                    // really? you're half way through this reg step, but you never started it ?
2673 
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
2674 
-                )
2675 
-            ) {
2676 
-                $invalid_TXN = true;
2677 
-            }
2678 
-            if ($invalid_TXN) {
2679 
-                // is the valid TXN completed ?
2680 
-                if ($valid_TXN instanceof EE_Transaction) {
2681 
-                    // has this step even been started ?
2682 
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2683 
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
2684 
-                        // so it **looks** like this is a double request from PayPal
2685 
-                        // so let's try to pick up where we left off
2686 
-                        $this->checkout->transaction = $valid_TXN;
2687 
-                        $this->checkout->refresh_all_entities(true);
2688 
-                        return;
2689 
-                    }
2690 
-                }
2691 
-                // you appear to be lost?
2692 
-                $this->_redirect_wayward_request($primary_registrant);
2693 
-            }
2694 
-        }
2695 
-    }
2696 
-
2697 
-
2698 
-    /**
2699 
-     * _redirect_wayward_request
2700 
-     *
2701 
-     * @access private
2702 
-     * @param \EE_Registration|null $primary_registrant
2703 
-     * @return bool
2704 
-     * @throws EE_Error
2705 
-     * @throws InvalidArgumentException
2706 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2707 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2708 
-     */
2709 
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
2710 
-    {
2711 
-        if (! $primary_registrant instanceof EE_Registration) {
2712 
-            // try redirecting based on the current TXN
2713 
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2714 
-                ? $this->checkout->transaction->primary_registration()
2715 
-                : null;
2716 
-        }
2717 
-        if (! $primary_registrant instanceof EE_Registration) {
2718 
-            EE_Error::add_error(
2719 
-                sprintf(
2720 
-                    esc_html__(
2721 
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
2722 
-                        'event_espresso'
2723 
-                    ),
2724 
-                    '<br/>',
2725 
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
2726 
-                ),
2727 
-                __FILE__,
2728 
-                __FUNCTION__,
2729 
-                __LINE__
2730 
-            );
2731 
-            return false;
2732 
-        }
2733 
-        // make sure transaction is not locked
2734 
-        $this->checkout->transaction->unlock();
2735 
-        wp_safe_redirect(
2736 
-            add_query_arg(
2737 
-                array(
2738 
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
2739 
-                ),
2740 
-                $this->checkout->thank_you_page_url
2741 
-            )
2742 
-        );
2743 
-        exit();
2744 
-    }
2745 
-
2746 
-
2747 
-    /**
2748 
-     * _process_off_site_payment
2749 
-     *
2750 
-     * @access private
2751 
-     * @param \EE_Offsite_Gateway $gateway
2752 
-     * @return EE_Payment
2753 
-     * @throws EE_Error
2754 
-     * @throws InvalidArgumentException
2755 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2756 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2757 
-     */
2758 
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2759 
-    {
2760 
-        try {
2761 
-            $request_data = \EE_Registry::instance()->REQ->params();
2762 
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2763 
-            $this->set_handle_IPN_in_this_request(
2764 
-                $gateway->handle_IPN_in_this_request($request_data, false)
2765 
-            );
2766 
-            if ($this->handle_IPN_in_this_request()) {
2767 
-                // get payment details and process results
2768 
-                /** @type EE_Payment_Processor $payment_processor */
2769 
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2770 
-                $payment = $payment_processor->process_ipn(
2771 
-                    $request_data,
2772 
-                    $this->checkout->transaction,
2773 
-                    $this->checkout->payment_method,
2774 
-                    true,
2775 
-                    false
2776 
-                );
2777 
-                // $payment_source = 'process_ipn';
2778 
-            } else {
2779 
-                $payment = $this->checkout->transaction->last_payment();
2780 
-                // $payment_source = 'last_payment';
2781 
-            }
2782 
-        } catch (Exception $e) {
2783 
-            // let's just eat the exception and try to move on using any previously set payment info
2784 
-            $payment = $this->checkout->transaction->last_payment();
2785 
-            // $payment_source = 'last_payment after Exception';
2786 
-            // but if we STILL don't have a payment object
2787 
-            if (! $payment instanceof EE_Payment) {
2788 
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2789 
-                $this->_handle_payment_processor_exception($e);
2790 
-            }
2791 
-        }
2792 
-        // DEBUG LOG
2793 
-        // $this->checkout->log(
2794 
-        //     __CLASS__,
2795 
-        //     __FUNCTION__,
2796 
-        //     __LINE__,
2797 
-        //     array(
2798 
-        //         'process_ipn_payment' => $payment,
2799 
-        //         'payment_source'      => $payment_source,
2800 
-        //     )
2801 
-        // );
2802 
-        return $payment;
2803 
-    }
2804 
-
2805 
-
2806 
-    /**
2807 
-     * _process_cancelled_payments
2808 
-     * just makes sure that the payment status gets updated correctly
2809 
-     * so tha tan error isn't generated during payment validation
2810 
-     *
2811 
-     * @access private
2812 
-     * @param EE_Payment $payment
2813 
-     * @return EE_Payment | FALSE
2814 
-     * @throws \EE_Error
2815 
-     */
2816 
-    private function _process_cancelled_payments($payment = null)
2817 
-    {
2818 
-        if ($payment instanceof EE_Payment
2819 
-            && isset($_REQUEST['ee_cancel_payment'])
2820 
-            && $payment->status() === EEM_Payment::status_id_failed
2821 
-        ) {
2822 
-            $payment->set_status(EEM_Payment::status_id_cancelled);
2823 
-        }
2824 
-        return $payment;
2825 
-    }
2826 
-
2827 
-
2828 
-    /**
2829 
-     *    get_transaction_details_for_gateways
2830 
-     *
2831 
-     * @access    public
2832 
-     * @return int
2833 
-     * @throws EE_Error
2834 
-     * @throws InvalidArgumentException
2835 
-     * @throws ReflectionException
2836 
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2837 
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2838 
-     */
2839 
-    public function get_transaction_details_for_gateways()
2840 
-    {
2841 
-        $txn_details = array();
2842 
-        // ya gotta make a choice man
2843 
-        if (empty($this->checkout->selected_method_of_payment)) {
2844 
-            $txn_details = array(
2845 
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2846 
-            );
2847 
-        }
2848 
-        // get EE_Payment_Method object
2849 
-        if (empty($txn_details)
2850 
-            &&
2851 
-            ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2852 
-        ) {
2853 
-            $txn_details = array(
2854 
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2855 
-                'error'                      => esc_html__(
2856 
-                    'A valid Payment Method could not be determined.',
2857 
-                    'event_espresso'
2858 
-                ),
2859 
-            );
2860 
-        }
2861 
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2862 
-            $return_url = $this->_get_return_url($this->checkout->payment_method);
2863 
-            $txn_details = array(
2864 
-                'TXN_ID'         => $this->checkout->transaction->ID(),
2865 
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2866 
-                'TXN_total'      => $this->checkout->transaction->total(),
2867 
-                'TXN_paid'       => $this->checkout->transaction->paid(),
2868 
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2869 
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
2870 
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2871 
-                'payment_amount' => $this->checkout->amount_owing,
2872 
-                'return_url'     => $return_url,
2873 
-                'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
2874 
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
2875 
-                    array(
2876 
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2877 
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
2878 
-                    )
2879 
-                ),
2880 
-            );
2881 
-        }
2882 
-        echo wp_json_encode($txn_details);
2883 
-        exit();
2884 
-    }
2885 
-
2886 
-
2887 
-    /**
2888 
-     *    __sleep
2889 
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2890 
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2891 
-     * reg form, because if needed, it will be regenerated anyways
2892 
-     *
2893 
-     * @return array
2894 
-     */
2895 
-    public function __sleep()
2896 
-    {
2897 
-        // remove the reg form and the checkout
2898 
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
2899 
-    }
15 
+	/**
16 
+	 * @access protected
17 
+	 * @var EE_Line_Item_Display $Line_Item_Display
18 
+	 */
19 
+	protected $line_item_display;
20 
+
21 
+	/**
22 
+	 * @access protected
23 
+	 * @var boolean $handle_IPN_in_this_request
24 
+	 */
25 
+	protected $handle_IPN_in_this_request = false;
26 
+
27 
+
28 
+	/**
29 
+	 *    set_hooks - for hooking into EE Core, other modules, etc
30 
+	 *
31 
+	 * @access    public
32 
+	 * @return    void
33 
+	 */
34 
+	public static function set_hooks()
35 
+	{
36 
+		add_filter(
37 
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
38 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
39 
+		);
40 
+		add_action(
41 
+			'wp_ajax_switch_spco_billing_form',
42 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
43 
+		);
44 
+		add_action(
45 
+			'wp_ajax_nopriv_switch_spco_billing_form',
46 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
47 
+		);
48 
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
49 
+		add_action(
50 
+			'wp_ajax_nopriv_save_payer_details',
51 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
52 
+		);
53 
+		add_action(
54 
+			'wp_ajax_get_transaction_details_for_gateways',
55 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
56 
+		);
57 
+		add_action(
58 
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
59 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
60 
+		);
61 
+		add_filter(
62 
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
63 
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
64 
+			10,
65 
+			1
66 
+		);
67 
+	}
68 
+
69 
+
70 
+	/**
71 
+	 *    ajax switch_spco_billing_form
72 
+	 *
73 
+	 * @throws \EE_Error
74 
+	 */
75 
+	public static function switch_spco_billing_form()
76 
+	{
77 
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
78 
+	}
79 
+
80 
+
81 
+	/**
82 
+	 *    ajax save_payer_details
83 
+	 *
84 
+	 * @throws \EE_Error
85 
+	 */
86 
+	public static function save_payer_details()
87 
+	{
88 
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
89 
+	}
90 
+
91 
+
92 
+	/**
93 
+	 *    ajax get_transaction_details
94 
+	 *
95 
+	 * @throws \EE_Error
96 
+	 */
97 
+	public static function get_transaction_details()
98 
+	{
99 
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
100 
+	}
101 
+
102 
+
103 
+	/**
104 
+	 * bypass_recaptcha_for_load_payment_method
105 
+	 *
106 
+	 * @access public
107 
+	 * @return array
108 
+	 * @throws InvalidArgumentException
109 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
110 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
111 
+	 */
112 
+	public static function bypass_recaptcha_for_load_payment_method()
113 
+	{
114 
+		return array(
115 
+			'EESID'  => EE_Registry::instance()->SSN->id(),
116 
+			'step'   => 'payment_options',
117 
+			'action' => 'spco_billing_form',
118 
+		);
119 
+	}
120 
+
121 
+
122 
+	/**
123 
+	 *    class constructor
124 
+	 *
125 
+	 * @access    public
126 
+	 * @param    EE_Checkout $checkout
127 
+	 */
128 
+	public function __construct(EE_Checkout $checkout)
129 
+	{
130 
+		$this->_slug = 'payment_options';
131 
+		$this->_name = esc_html__('Payment Options', 'event_espresso');
132 
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
133 
+		$this->checkout = $checkout;
134 
+		$this->_reset_success_message();
135 
+		$this->set_instructions(
136 
+			esc_html__(
137 
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
138 
+				'event_espresso'
139 
+			)
140 
+		);
141 
+	}
142 
+
143 
+
144 
+	/**
145 
+	 * @return null
146 
+	 */
147 
+	public function line_item_display()
148 
+	{
149 
+		return $this->line_item_display;
150 
+	}
151 
+
152 
+
153 
+	/**
154 
+	 * @param null $line_item_display
155 
+	 */
156 
+	public function set_line_item_display($line_item_display)
157 
+	{
158 
+		$this->line_item_display = $line_item_display;
159 
+	}
160 
+
161 
+
162 
+	/**
163 
+	 * @return boolean
164 
+	 */
165 
+	public function handle_IPN_in_this_request()
166 
+	{
167 
+		return $this->handle_IPN_in_this_request;
168 
+	}
169 
+
170 
+
171 
+	/**
172 
+	 * @param boolean $handle_IPN_in_this_request
173 
+	 */
174 
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
175 
+	{
176 
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
177 
+	}
178 
+
179 
+
180 
+	/**
181 
+	 * translate_js_strings
182 
+	 *
183 
+	 * @return void
184 
+	 */
185 
+	public function translate_js_strings()
186 
+	{
187 
+		EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
188 
+			'Please select a method of payment in order to continue.',
189 
+			'event_espresso'
190 
+		);
191 
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
192 
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
193 
+			'event_espresso'
194 
+		);
195 
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
196 
+			'Forwarding to Secure Payment Provider.',
197 
+			'event_espresso'
198 
+		);
199 
+	}
200 
+
201 
+
202 
+	/**
203 
+	 * enqueue_styles_and_scripts
204 
+	 *
205 
+	 * @return void
206 
+	 * @throws EE_Error
207 
+	 * @throws InvalidArgumentException
208 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
209 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
210 
+	 */
211 
+	public function enqueue_styles_and_scripts()
212 
+	{
213 
+		$transaction = $this->checkout->transaction;
214 
+		// if the transaction isn't set or nothing is owed on it, don't enqueue any JS
215 
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
216 
+			return;
217 
+		}
218 
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction(
219 
+			$transaction,
220 
+			EEM_Payment_Method::scope_cart
221 
+		) as $payment_method) {
222 
+			$type_obj = $payment_method->type_obj();
223 
+			if ($type_obj instanceof EE_PMT_Base) {
224 
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
225 
+				if ($billing_form instanceof EE_Form_Section_Proper) {
226 
+					$billing_form->enqueue_js();
227 
+				}
228 
+			}
229 
+		}
230 
+	}
231 
+
232 
+
233 
+	/**
234 
+	 * initialize_reg_step
235 
+	 *
236 
+	 * @return bool
237 
+	 * @throws EE_Error
238 
+	 * @throws InvalidArgumentException
239 
+	 * @throws ReflectionException
240 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
241 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
242 
+	 */
243 
+	public function initialize_reg_step()
244 
+	{
245 
+		// TODO: if /when we implement donations, then this will need overriding
246 
+		if (// don't need payment options for:
247 
+			// registrations made via the admin
248 
+			// completed transactions
249 
+			// overpaid transactions
250 
+			// $ 0.00 transactions(no payment required)
251 
+			! $this->checkout->payment_required()
252 
+			// but do NOT remove if current action being called belongs to this reg step
253 
+			&& ! is_callable(array($this, $this->checkout->action))
254 
+			&& ! $this->completed()
255 
+		) {
256 
+			// and if so, then we no longer need the Payment Options step
257 
+			if ($this->is_current_step()) {
258 
+				$this->checkout->generate_reg_form = false;
259 
+			}
260 
+			$this->checkout->remove_reg_step($this->_slug);
261 
+			// DEBUG LOG
262 
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
263 
+			return false;
264 
+		}
265 
+		// load EEM_Payment_Method
266 
+		EE_Registry::instance()->load_model('Payment_Method');
267 
+		// get all active payment methods
268 
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
269 
+			$this->checkout->transaction,
270 
+			EEM_Payment_Method::scope_cart
271 
+		);
272 
+		return true;
273 
+	}
274 
+
275 
+
276 
+	/**
277 
+	 * @return EE_Form_Section_Proper
278 
+	 * @throws EE_Error
279 
+	 * @throws InvalidArgumentException
280 
+	 * @throws ReflectionException
281 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
282 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
283 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
284 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
285 
+	 */
286 
+	public function generate_reg_form()
287 
+	{
288 
+		// reset in case someone changes their mind
289 
+		$this->_reset_selected_method_of_payment();
290 
+		// set some defaults
291 
+		$this->checkout->selected_method_of_payment = 'payments_closed';
292 
+		$registrations_requiring_payment = array();
293 
+		$registrations_for_free_events = array();
294 
+		$registrations_requiring_pre_approval = array();
295 
+		$sold_out_events = array();
296 
+		$insufficient_spaces_available = array();
297 
+		$no_payment_required = true;
298 
+		// loop thru registrations to gather info
299 
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
300 
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
301 
+			$registrations,
302 
+			$this->checkout->revisit
303 
+		);
304 
+		foreach ($registrations as $REG_ID => $registration) {
305 
+			/** @var $registration EE_Registration */
306 
+			// has this registration lost it's space ?
307 
+			if (isset($ejected_registrations[ $REG_ID ])) {
308 
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
309 
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
310 
+				} else {
311 
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
312 
+				}
313 
+				continue;
314 
+			}
315 
+			// event requires admin approval
316 
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
317 
+				// add event to list of events with pre-approval reg status
318 
+				$registrations_requiring_pre_approval[ $REG_ID ] = $registration;
319 
+				do_action(
320 
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
321 
+					$registration->event(),
322 
+					$this
323 
+				);
324 
+				continue;
325 
+			}
326 
+			if ($this->checkout->revisit
327 
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
328 
+				&& (
329 
+					$registration->event()->is_sold_out()
330 
+					|| $registration->event()->is_sold_out(true)
331 
+				)
332 
+			) {
333 
+				// add event to list of events that are sold out
334 
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
335 
+				do_action(
336 
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
337 
+					$registration->event(),
338 
+					$this
339 
+				);
340 
+				continue;
341 
+			}
342 
+			// are they allowed to pay now and is there monies owing?
343 
+			if ($registration->owes_monies_and_can_pay()) {
344 
+				$registrations_requiring_payment[ $REG_ID ] = $registration;
345 
+				do_action(
346 
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
347 
+					$registration->event(),
348 
+					$this
349 
+				);
350 
+			} elseif (! $this->checkout->revisit
351 
+					  && $registration->status_ID() !== EEM_Registration::status_id_not_approved
352 
+					  && $registration->ticket()->is_free()
353 
+			) {
354 
+				$registrations_for_free_events[ $registration->event()->ID() ] = $registration;
355 
+			}
356 
+		}
357 
+		$subsections = array();
358 
+		// now decide which template to load
359 
+		if (! empty($sold_out_events)) {
360 
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
361 
+		}
362 
+		if (! empty($insufficient_spaces_available)) {
363 
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
364 
+				$insufficient_spaces_available
365 
+			);
366 
+		}
367 
+		if (! empty($registrations_requiring_pre_approval)) {
368 
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
369 
+				$registrations_requiring_pre_approval
370 
+			);
371 
+		}
372 
+		if (! empty($registrations_for_free_events)) {
373 
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
374 
+		}
375 
+		if (! empty($registrations_requiring_payment)) {
376 
+			if ($this->checkout->amount_owing > 0) {
377 
+				// autoload Line_Item_Display classes
378 
+				EEH_Autoloader::register_line_item_filter_autoloaders();
379 
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
380 
+					apply_filters(
381 
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
382 
+						new EE_Line_Item_Filter_Collection()
383 
+					),
384 
+					$this->checkout->cart->get_grand_total()
385 
+				);
386 
+				/** @var EE_Line_Item $filtered_line_item_tree */
387 
+				$filtered_line_item_tree = $line_item_filter_processor->process();
388 
+				EEH_Autoloader::register_line_item_display_autoloaders();
389 
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
390 
+				$subsections['payment_options'] = $this->_display_payment_options(
391 
+					$this->line_item_display->display_line_item(
392 
+						$filtered_line_item_tree,
393 
+						array('registrations' => $registrations)
394 
+					)
395 
+				);
396 
+				$this->checkout->amount_owing = $filtered_line_item_tree->total();
397 
+				$this->_apply_registration_payments_to_amount_owing($registrations);
398 
+			}
399 
+			$no_payment_required = false;
400 
+		} else {
401 
+			$this->_hide_reg_step_submit_button_if_revisit();
402 
+		}
403 
+		$this->_save_selected_method_of_payment();
404 
+
405 
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
406 
+		$subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
407 
+
408 
+		return new EE_Form_Section_Proper(
409 
+			array(
410 
+				'name'            => $this->reg_form_name(),
411 
+				'html_id'         => $this->reg_form_name(),
412 
+				'subsections'     => $subsections,
413 
+				'layout_strategy' => new EE_No_Layout(),
414 
+			)
415 
+		);
416 
+	}
417 
+
418 
+
419 
+	/**
420 
+	 * add line item filters required for this reg step
421 
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
422 
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
423 
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
424 
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
425 
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
426 
+	 *        filter collection by passing that instead of instantiating a new collection
427 
+	 *
428 
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
429 
+	 * @return EE_Line_Item_Filter_Collection
430 
+	 * @throws EE_Error
431 
+	 * @throws InvalidArgumentException
432 
+	 * @throws ReflectionException
433 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
434 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
435 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
436 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
437 
+	 */
438 
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
439 
+	{
440 
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
441 
+			return $line_item_filter_collection;
442 
+		}
443 
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
444 
+			return $line_item_filter_collection;
445 
+		}
446 
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
447 
+			return $line_item_filter_collection;
448 
+		}
449 
+		$line_item_filter_collection->add(
450 
+			new EE_Billable_Line_Item_Filter(
451 
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
452 
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
453 
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
454 
+					)
455 
+				)
456 
+			)
457 
+		);
458 
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
459 
+		return $line_item_filter_collection;
460 
+	}
461 
+
462 
+
463 
+	/**
464 
+	 * remove_ejected_registrations
465 
+	 * if a registrant has lost their potential space at an event due to lack of payment,
466 
+	 * then this method removes them from the list of registrations being paid for during this request
467 
+	 *
468 
+	 * @param \EE_Registration[] $registrations
469 
+	 * @return EE_Registration[]
470 
+	 * @throws EE_Error
471 
+	 * @throws InvalidArgumentException
472 
+	 * @throws ReflectionException
473 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
474 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
475 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
476 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
477 
+	 */
478 
+	public static function remove_ejected_registrations(array $registrations)
479 
+	{
480 
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
481 
+			$registrations,
482 
+			EE_Registry::instance()->SSN->checkout()->revisit
483 
+		);
484 
+		foreach ($registrations as $REG_ID => $registration) {
485 
+			// has this registration lost it's space ?
486 
+			if (isset($ejected_registrations[ $REG_ID ])) {
487 
+				unset($registrations[ $REG_ID ]);
488 
+				continue;
489 
+			}
490 
+		}
491 
+		return $registrations;
492 
+	}
493 
+
494 
+
495 
+	/**
496 
+	 * find_registrations_that_lost_their_space
497 
+	 * If a registrant chooses an offline payment method like Invoice,
498 
+	 * then no space is reserved for them at the event until they fully pay fo that site
499 
+	 * (unless the event's default reg status is set to APPROVED)
500 
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
501 
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
502 
+	 *
503 
+	 * @param \EE_Registration[] $registrations
504 
+	 * @param bool               $revisit
505 
+	 * @return array
506 
+	 * @throws EE_Error
507 
+	 * @throws InvalidArgumentException
508 
+	 * @throws ReflectionException
509 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
510 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
511 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
512 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
513 
+	 */
514 
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
515 
+	{
516 
+		// registrations per event
517 
+		$event_reg_count = array();
518 
+		// spaces left per event
519 
+		$event_spaces_remaining = array();
520 
+		// tickets left sorted by ID
521 
+		$tickets_remaining = array();
522 
+		// registrations that have lost their space
523 
+		$ejected_registrations = array();
524 
+		foreach ($registrations as $REG_ID => $registration) {
525 
+			if ($registration->status_ID() === EEM_Registration::status_id_approved
526 
+				|| apply_filters(
527 
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
528 
+					false,
529 
+					$registration,
530 
+					$revisit
531 
+				)
532 
+			) {
533 
+				continue;
534 
+			}
535 
+			$EVT_ID = $registration->event_ID();
536 
+			$ticket = $registration->ticket();
537 
+			if (! isset($tickets_remaining[ $ticket->ID() ])) {
538 
+				$tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
539 
+			}
540 
+			if ($tickets_remaining[ $ticket->ID() ] > 0) {
541 
+				if (! isset($event_reg_count[ $EVT_ID ])) {
542 
+					$event_reg_count[ $EVT_ID ] = 0;
543 
+				}
544 
+				$event_reg_count[ $EVT_ID ]++;
545 
+				if (! isset($event_spaces_remaining[ $EVT_ID ])) {
546 
+					$event_spaces_remaining[ $EVT_ID ] = $registration->event()->spaces_remaining_for_sale();
547 
+				}
548 
+			}
549 
+			if ($revisit
550 
+				&& ($tickets_remaining[ $ticket->ID() ] === 0
551 
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
552 
+				)
553 
+			) {
554 
+				$ejected_registrations[ $REG_ID ] = $registration->event();
555 
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
556 
+					/** @type EE_Registration_Processor $registration_processor */
557 
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
558 
+					// at this point, we should have enough details about the registrant to consider the registration
559 
+					// NOT incomplete
560 
+					$registration_processor->manually_update_registration_status(
561 
+						$registration,
562 
+						EEM_Registration::status_id_wait_list
563 
+					);
564 
+				}
565 
+			}
566 
+		}
567 
+		return $ejected_registrations;
568 
+	}
569 
+
570 
+
571 
+	/**
572 
+	 * _hide_reg_step_submit_button
573 
+	 * removes the html for the reg step submit button
574 
+	 * by replacing it with an empty string via filter callback
575 
+	 *
576 
+	 * @return void
577 
+	 */
578 
+	protected function _adjust_registration_status_if_event_old_sold()
579 
+	{
580 
+	}
581 
+
582 
+
583 
+	/**
584 
+	 * _hide_reg_step_submit_button
585 
+	 * removes the html for the reg step submit button
586 
+	 * by replacing it with an empty string via filter callback
587 
+	 *
588 
+	 * @return void
589 
+	 */
590 
+	protected function _hide_reg_step_submit_button_if_revisit()
591 
+	{
592 
+		if ($this->checkout->revisit) {
593 
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
594 
+		}
595 
+	}
596 
+
597 
+
598 
+	/**
599 
+	 * sold_out_events
600 
+	 * displays notices regarding events that have sold out since hte registrant first signed up
601 
+	 *
602 
+	 * @param \EE_Event[] $sold_out_events_array
603 
+	 * @return \EE_Form_Section_Proper
604 
+	 * @throws \EE_Error
605 
+	 */
606 
+	private function _sold_out_events($sold_out_events_array = array())
607 
+	{
608 
+		// set some defaults
609 
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
610 
+		$sold_out_events = '';
611 
+		foreach ($sold_out_events_array as $sold_out_event) {
612 
+			$sold_out_events .= EEH_HTML::li(
613 
+				EEH_HTML::span(
614 
+					'  ' . $sold_out_event->name(),
615 
+					'',
616 
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
617 
+				)
618 
+			);
619 
+		}
620 
+		return new EE_Form_Section_Proper(
621 
+			array(
622 
+				'layout_strategy' => new EE_Template_Layout(
623 
+					array(
624 
+						'layout_template_file' => SPCO_REG_STEPS_PATH
625 
+												  . $this->_slug
626 
+												  . DS
627 
+												  . 'sold_out_events.template.php',
628 
+						'template_args'        => apply_filters(
629 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
630 
+							array(
631 
+								'sold_out_events'     => $sold_out_events,
632 
+								'sold_out_events_msg' => apply_filters(
633 
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
634 
+									sprintf(
635 
+										esc_html__(
636 
+											'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
637 
+											'event_espresso'
638 
+										),
639 
+										'<strong>',
640 
+										'</strong>',
641 
+										'<br />'
642 
+									)
643 
+								),
644 
+							)
645 
+						),
646 
+					)
647 
+				),
648 
+			)
649 
+		);
650 
+	}
651 
+
652 
+
653 
+	/**
654 
+	 * _insufficient_spaces_available
655 
+	 * displays notices regarding events that do not have enough remaining spaces
656 
+	 * to satisfy the current number of registrations looking to pay
657 
+	 *
658 
+	 * @param \EE_Event[] $insufficient_spaces_events_array
659 
+	 * @return \EE_Form_Section_Proper
660 
+	 * @throws \EE_Error
661 
+	 */
662 
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
663 
+	{
664 
+		// set some defaults
665 
+		$this->checkout->selected_method_of_payment = 'invoice';
666 
+		$insufficient_space_events = '';
667 
+		foreach ($insufficient_spaces_events_array as $event) {
668 
+			if ($event instanceof EE_Event) {
669 
+				$insufficient_space_events .= EEH_HTML::li(
670 
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
671 
+				);
672 
+			}
673 
+		}
674 
+		return new EE_Form_Section_Proper(
675 
+			array(
676 
+				'subsections'     => array(
677 
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
678 
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
679 
+				),
680 
+				'layout_strategy' => new EE_Template_Layout(
681 
+					array(
682 
+						'layout_template_file' => SPCO_REG_STEPS_PATH
683 
+												  . $this->_slug
684 
+												  . DS
685 
+												  . 'sold_out_events.template.php',
686 
+						'template_args'        => apply_filters(
687 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
688 
+							array(
689 
+								'sold_out_events'     => $insufficient_space_events,
690 
+								'sold_out_events_msg' => apply_filters(
691 
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
692 
+									esc_html__(
693 
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
694 
+										'event_espresso'
695 
+									)
696 
+								),
697 
+							)
698 
+						),
699 
+					)
700 
+				),
701 
+			)
702 
+		);
703 
+	}
704 
+
705 
+
706 
+	/**
707 
+	 * registrations_requiring_pre_approval
708 
+	 *
709 
+	 * @param array $registrations_requiring_pre_approval
710 
+	 * @return EE_Form_Section_Proper
711 
+	 * @throws EE_Error
712 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
713 
+	 */
714 
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
715 
+	{
716 
+		$events_requiring_pre_approval = '';
717 
+		foreach ($registrations_requiring_pre_approval as $registration) {
718 
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
719 
+				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
720 
+					EEH_HTML::span(
721 
+						'',
722 
+						'',
723 
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
724 
+					)
725 
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
726 
+				);
727 
+			}
728 
+		}
729 
+		return new EE_Form_Section_Proper(
730 
+			array(
731 
+				'layout_strategy' => new EE_Template_Layout(
732 
+					array(
733 
+						'layout_template_file' => SPCO_REG_STEPS_PATH
734 
+												  . $this->_slug
735 
+												  . DS
736 
+												  . 'events_requiring_pre_approval.template.php', // layout_template
737 
+						'template_args'        => apply_filters(
738 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
739 
+							array(
740 
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
741 
+								'events_requiring_pre_approval_msg' => apply_filters(
742 
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
743 
+									esc_html__(
744 
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
745 
+										'event_espresso'
746 
+									)
747 
+								),
748 
+							)
749 
+						),
750 
+					)
751 
+				),
752 
+			)
753 
+		);
754 
+	}
755 
+
756 
+
757 
+	/**
758 
+	 * _no_payment_required
759 
+	 *
760 
+	 * @param \EE_Event[] $registrations_for_free_events
761 
+	 * @return \EE_Form_Section_Proper
762 
+	 * @throws \EE_Error
763 
+	 */
764 
+	private function _no_payment_required($registrations_for_free_events = array())
765 
+	{
766 
+		// set some defaults
767 
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
768 
+		// generate no_payment_required form
769 
+		return new EE_Form_Section_Proper(
770 
+			array(
771 
+				'layout_strategy' => new EE_Template_Layout(
772 
+					array(
773 
+						'layout_template_file' => SPCO_REG_STEPS_PATH
774 
+												  . $this->_slug
775 
+												  . DS
776 
+												  . 'no_payment_required.template.php', // layout_template
777 
+						'template_args'        => apply_filters(
778 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
779 
+							array(
780 
+								'revisit'                       => $this->checkout->revisit,
781 
+								'registrations'                 => array(),
782 
+								'ticket_count'                  => array(),
783 
+								'registrations_for_free_events' => $registrations_for_free_events,
784 
+								'no_payment_required_msg'       => EEH_HTML::p(
785 
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
786 
+								),
787 
+							)
788 
+						),
789 
+					)
790 
+				),
791 
+			)
792 
+		);
793 
+	}
794 
+
795 
+
796 
+	/**
797 
+	 * _display_payment_options
798 
+	 *
799 
+	 * @param string $transaction_details
800 
+	 * @return EE_Form_Section_Proper
801 
+	 * @throws EE_Error
802 
+	 * @throws InvalidArgumentException
803 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
804 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
805 
+	 */
806 
+	private function _display_payment_options($transaction_details = '')
807 
+	{
808 
+		// has method_of_payment been set by no-js user?
809 
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
810 
+		// build payment options form
811 
+		return apply_filters(
812 
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
813 
+			new EE_Form_Section_Proper(
814 
+				array(
815 
+					'subsections'     => array(
816 
+						'before_payment_options' => apply_filters(
817 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
818 
+							new EE_Form_Section_Proper(
819 
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
820 
+							)
821 
+						),
822 
+						'payment_options'        => $this->_setup_payment_options(),
823 
+						'after_payment_options'  => apply_filters(
824 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
825 
+							new EE_Form_Section_Proper(
826 
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
827 
+							)
828 
+						),
829 
+					),
830 
+					'layout_strategy' => new EE_Template_Layout(
831 
+						array(
832 
+							'layout_template_file' => $this->_template,
833 
+							'template_args'        => apply_filters(
834 
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
835 
+								array(
836 
+									'reg_count'                 => $this->line_item_display->total_items(),
837 
+									'transaction_details'       => $transaction_details,
838 
+									'available_payment_methods' => array(),
839 
+								)
840 
+							),
841 
+						)
842 
+					),
843 
+				)
844 
+			)
845 
+		);
846 
+	}
847 
+
848 
+
849 
+	/**
850 
+	 * _extra_hidden_inputs
851 
+	 *
852 
+	 * @param bool $no_payment_required
853 
+	 * @return \EE_Form_Section_Proper
854 
+	 * @throws \EE_Error
855 
+	 */
856 
+	private function _extra_hidden_inputs($no_payment_required = true)
857 
+	{
858 
+		return new EE_Form_Section_Proper(
859 
+			array(
860 
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
861 
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
862 
+				'subsections'     => array(
863 
+					'spco_no_payment_required' => new EE_Hidden_Input(
864 
+						array(
865 
+							'normalization_strategy' => new EE_Boolean_Normalization(),
866 
+							'html_name'              => 'spco_no_payment_required',
867 
+							'html_id'                => 'spco-no-payment-required-payment_options',
868 
+							'default'                => $no_payment_required,
869 
+						)
870 
+					),
871 
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
872 
+						array(
873 
+							'normalization_strategy' => new EE_Int_Normalization(),
874 
+							'html_name'              => 'spco_transaction_id',
875 
+							'html_id'                => 'spco-transaction-id',
876 
+							'default'                => $this->checkout->transaction->ID(),
877 
+						)
878 
+					),
879 
+				),
880 
+			)
881 
+		);
882 
+	}
883 
+
884 
+
885 
+	/**
886 
+	 *    _apply_registration_payments_to_amount_owing
887 
+	 *
888 
+	 * @access protected
889 
+	 * @param array $registrations
890 
+	 * @throws EE_Error
891 
+	 */
892 
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
893 
+	{
894 
+		$payments = array();
895 
+		foreach ($registrations as $registration) {
896 
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
897 
+				$payments += $registration->registration_payments();
898 
+			}
899 
+		}
900 
+		if (! empty($payments)) {
901 
+			foreach ($payments as $payment) {
902 
+				if ($payment instanceof EE_Registration_Payment) {
903 
+					$this->checkout->amount_owing -= $payment->amount();
904 
+				}
905 
+			}
906 
+		}
907 
+	}
908 
+
909 
+
910 
+	/**
911 
+	 *    _reset_selected_method_of_payment
912 
+	 *
913 
+	 * @access    private
914 
+	 * @param    bool $force_reset
915 
+	 * @return void
916 
+	 * @throws InvalidArgumentException
917 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
918 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
919 
+	 */
920 
+	private function _reset_selected_method_of_payment($force_reset = false)
921 
+	{
922 
+		$reset_payment_method = $force_reset
923 
+			? true
924 
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
925 
+		if ($reset_payment_method) {
926 
+			$this->checkout->selected_method_of_payment = null;
927 
+			$this->checkout->payment_method = null;
928 
+			$this->checkout->billing_form = null;
929 
+			$this->_save_selected_method_of_payment();
930 
+		}
931 
+	}
932 
+
933 
+
934 
+	/**
935 
+	 * _save_selected_method_of_payment
936 
+	 * stores the selected_method_of_payment in the session
937 
+	 * so that it's available for all subsequent requests including AJAX
938 
+	 *
939 
+	 * @access        private
940 
+	 * @param string $selected_method_of_payment
941 
+	 * @return void
942 
+	 * @throws InvalidArgumentException
943 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
944 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
945 
+	 */
946 
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
947 
+	{
948 
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
949 
+			? $selected_method_of_payment
950 
+			: $this->checkout->selected_method_of_payment;
951 
+		EE_Registry::instance()->SSN->set_session_data(
952 
+			array('selected_method_of_payment' => $selected_method_of_payment)
953 
+		);
954 
+	}
955 
+
956 
+
957 
+	/**
958 
+	 * _setup_payment_options
959 
+	 *
960 
+	 * @return EE_Form_Section_Proper
961 
+	 * @throws EE_Error
962 
+	 * @throws InvalidArgumentException
963 
+	 * @throws ReflectionException
964 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
965 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
966 
+	 */
967 
+	public function _setup_payment_options()
968 
+	{
969 
+		// load payment method classes
970 
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
971 
+		if (empty($this->checkout->available_payment_methods)) {
972 
+			EE_Error::add_error(
973 
+				apply_filters(
974 
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
975 
+					sprintf(
976 
+						esc_html__(
977 
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
978 
+							'event_espresso'
979 
+						),
980 
+						'<br>',
981 
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
982 
+					)
983 
+				),
984 
+				__FILE__,
985 
+				__FUNCTION__,
986 
+				__LINE__
987 
+			);
988 
+		}
989 
+		// switch up header depending on number of available payment methods
990 
+		$payment_method_header = count($this->checkout->available_payment_methods) > 1
991 
+			? apply_filters(
992 
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
993 
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
994 
+			)
995 
+			: apply_filters(
996 
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
997 
+				esc_html__('Method of Payment', 'event_espresso')
998 
+			);
999 
+		$available_payment_methods = array(
1000 
+			// display the "Payment Method" header
1001 
+			'payment_method_header' => new EE_Form_Section_HTML(
1002 
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
1003 
+			),
1004 
+		);
1005 
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
1006 
+		$available_payment_method_options = array();
1007 
+		$default_payment_method_option = array();
1008 
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
1009 
+		$payment_methods_billing_info = array(
1010 
+			new EE_Form_Section_HTML(
1011 
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
1012 
+			),
1013 
+		);
1014 
+		// loop through payment methods
1015 
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
1016 
+			if ($payment_method instanceof EE_Payment_Method) {
1017 
+				$payment_method_button = EEH_HTML::img(
1018 
+					$payment_method->button_url(),
1019 
+					$payment_method->name(),
1020 
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
1021 
+					'spco-payment-method-btn-img'
1022 
+				);
1023 
+				// check if any payment methods are set as default
1024 
+				// if payment method is already selected OR nothing is selected and this payment method should be
1025 
+				// open_by_default
1026 
+				if (($this->checkout->selected_method_of_payment === $payment_method->slug())
1027 
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
1028 
+				) {
1029 
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
1030 
+					$this->_save_selected_method_of_payment();
1031 
+					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
1032 
+				} else {
1033 
+					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
1034 
+				}
1035 
+				$payment_methods_billing_info[ $payment_method->slug(
1036 
+				) . '-info' ] = $this->_payment_method_billing_info(
1037 
+					$payment_method
1038 
+				);
1039 
+			}
1040 
+		}
1041 
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
1042 
+		// of PMs
1043 
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
1044 
+		// now generate the actual form  inputs
1045 
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
1046 
+			$available_payment_method_options
1047 
+		);
1048 
+		$available_payment_methods += $payment_methods_billing_info;
1049 
+		// build the available payment methods form
1050 
+		return new EE_Form_Section_Proper(
1051 
+			array(
1052 
+				'html_id'         => 'spco-available-methods-of-payment-dv',
1053 
+				'subsections'     => $available_payment_methods,
1054 
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1055 
+			)
1056 
+		);
1057 
+	}
1058 
+
1059 
+
1060 
+	/**
1061 
+	 * _get_available_payment_methods
1062 
+	 *
1063 
+	 * @return EE_Payment_Method[]
1064 
+	 * @throws EE_Error
1065 
+	 * @throws InvalidArgumentException
1066 
+	 * @throws ReflectionException
1067 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1068 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1069 
+	 */
1070 
+	protected function _get_available_payment_methods()
1071 
+	{
1072 
+		if (! empty($this->checkout->available_payment_methods)) {
1073 
+			return $this->checkout->available_payment_methods;
1074 
+		}
1075 
+		$available_payment_methods = array();
1076 
+		// load EEM_Payment_Method
1077 
+		EE_Registry::instance()->load_model('Payment_Method');
1078 
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
1079 
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
1080 
+		// get all active payment methods
1081 
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
1082 
+			$this->checkout->transaction,
1083 
+			EEM_Payment_Method::scope_cart
1084 
+		);
1085 
+		foreach ($payment_methods as $payment_method) {
1086 
+			if ($payment_method instanceof EE_Payment_Method) {
1087 
+				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
1088 
+			}
1089 
+		}
1090 
+		return $available_payment_methods;
1091 
+	}
1092 
+
1093 
+
1094 
+	/**
1095 
+	 *    _available_payment_method_inputs
1096 
+	 *
1097 
+	 * @access    private
1098 
+	 * @param    array $available_payment_method_options
1099 
+	 * @return    \EE_Form_Section_Proper
1100 
+	 */
1101 
+	private function _available_payment_method_inputs($available_payment_method_options = array())
1102 
+	{
1103 
+		// generate inputs
1104 
+		return new EE_Form_Section_Proper(
1105 
+			array(
1106 
+				'html_id'         => 'ee-available-payment-method-inputs',
1107 
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1108 
+				'subsections'     => array(
1109 
+					'' => new EE_Radio_Button_Input(
1110 
+						$available_payment_method_options,
1111 
+						array(
1112 
+							'html_name'          => 'selected_method_of_payment',
1113 
+							'html_class'         => 'spco-payment-method',
1114 
+							'default'            => $this->checkout->selected_method_of_payment,
1115 
+							'label_size'         => 11,
1116 
+							'enforce_label_size' => true,
1117 
+						)
1118 
+					),
1119 
+				),
1120 
+			)
1121 
+		);
1122 
+	}
1123 
+
1124 
+
1125 
+	/**
1126 
+	 *    _payment_method_billing_info
1127 
+	 *
1128 
+	 * @access    private
1129 
+	 * @param    EE_Payment_Method $payment_method
1130 
+	 * @return EE_Form_Section_Proper
1131 
+	 * @throws EE_Error
1132 
+	 * @throws InvalidArgumentException
1133 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1134 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1135 
+	 */
1136 
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
1137 
+	{
1138 
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
1139 
+			? true
1140 
+			: false;
1141 
+		// generate the billing form for payment method
1142 
+		$billing_form = $currently_selected
1143 
+			? $this->_get_billing_form_for_payment_method($payment_method)
1144 
+			: new EE_Form_Section_HTML();
1145 
+		$this->checkout->billing_form = $currently_selected
1146 
+			? $billing_form
1147 
+			: $this->checkout->billing_form;
1148 
+		// it's all in the details
1149 
+		$info_html = EEH_HTML::h3(
1150 
+			esc_html__('Important information regarding your payment', 'event_espresso'),
1151 
+			'',
1152 
+			'spco-payment-method-hdr'
1153 
+		);
1154 
+		// add some info regarding the step, either from what's saved in the admin,
1155 
+		// or a default string depending on whether the PM has a billing form or not
1156 
+		if ($payment_method->description()) {
1157 
+			$payment_method_info = $payment_method->description();
1158 
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
1159 
+			$payment_method_info = sprintf(
1160 
+				esc_html__(
1161 
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
1162 
+					'event_espresso'
1163 
+				),
1164 
+				$this->submit_button_text()
1165 
+			);
1166 
+		} else {
1167 
+			$payment_method_info = sprintf(
1168 
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
1169 
+				$this->submit_button_text()
1170 
+			);
1171 
+		}
1172 
+		$info_html .= EEH_HTML::div(
1173 
+			apply_filters(
1174 
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
1175 
+				$payment_method_info
1176 
+			),
1177 
+			'',
1178 
+			'spco-payment-method-desc ee-attention'
1179 
+		);
1180 
+		return new EE_Form_Section_Proper(
1181 
+			array(
1182 
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
1183 
+				'html_class'      => 'spco-payment-method-info-dv',
1184 
+				// only display the selected or default PM
1185 
+				'html_style'      => $currently_selected ? '' : 'display:none;',
1186 
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
1187 
+				'subsections'     => array(
1188 
+					'info'         => new EE_Form_Section_HTML($info_html),
1189 
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
1190 
+				),
1191 
+			)
1192 
+		);
1193 
+	}
1194 
+
1195 
+
1196 
+	/**
1197 
+	 * get_billing_form_html_for_payment_method
1198 
+	 *
1199 
+	 * @access public
1200 
+	 * @return string
1201 
+	 * @throws EE_Error
1202 
+	 * @throws InvalidArgumentException
1203 
+	 * @throws ReflectionException
1204 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1205 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1206 
+	 */
1207 
+	public function get_billing_form_html_for_payment_method()
1208 
+	{
1209 
+		// how have they chosen to pay?
1210 
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1211 
+		$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1212 
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1213 
+			return false;
1214 
+		}
1215 
+		if (apply_filters(
1216 
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1217 
+			false
1218 
+		)) {
1219 
+			EE_Error::add_success(
1220 
+				apply_filters(
1221 
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1222 
+					sprintf(
1223 
+						esc_html__(
1224 
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1225 
+							'event_espresso'
1226 
+						),
1227 
+						$this->checkout->payment_method->name()
1228 
+					)
1229 
+				)
1230 
+			);
1231 
+		}
1232 
+		// now generate billing form for selected method of payment
1233 
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
1234 
+		// fill form with attendee info if applicable
1235 
+		if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
1236 
+			&& $this->checkout->transaction_has_primary_registrant()
1237 
+		) {
1238 
+			$payment_method_billing_form->populate_from_attendee(
1239 
+				$this->checkout->transaction->primary_registration()->attendee()
1240 
+			);
1241 
+		}
1242 
+		// and debug content
1243 
+		if ($payment_method_billing_form instanceof EE_Billing_Info_Form
1244 
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1245 
+		) {
1246 
+			$payment_method_billing_form =
1247 
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1248 
+					$payment_method_billing_form
1249 
+				);
1250 
+		}
1251 
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
1252 
+			? $payment_method_billing_form->get_html()
1253 
+			: '';
1254 
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
1255 
+		// localize validation rules for main form
1256 
+		$this->checkout->current_step->reg_form->localize_validation_rules();
1257 
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1258 
+		return true;
1259 
+	}
1260 
+
1261 
+
1262 
+	/**
1263 
+	 * _get_billing_form_for_payment_method
1264 
+	 *
1265 
+	 * @access private
1266 
+	 * @param EE_Payment_Method $payment_method
1267 
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
1268 
+	 * @throws EE_Error
1269 
+	 * @throws InvalidArgumentException
1270 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1271 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1272 
+	 */
1273 
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
1274 
+	{
1275 
+		$billing_form = $payment_method->type_obj()->billing_form(
1276 
+			$this->checkout->transaction,
1277 
+			array('amount_owing' => $this->checkout->amount_owing)
1278 
+		);
1279 
+		if ($billing_form instanceof EE_Billing_Info_Form) {
1280 
+			if (apply_filters(
1281 
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1282 
+				false
1283 
+			)
1284 
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
1285 
+			) {
1286 
+				EE_Error::add_success(
1287 
+					apply_filters(
1288 
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1289 
+						sprintf(
1290 
+							esc_html__(
1291 
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
1292 
+								'event_espresso'
1293 
+							),
1294 
+							$payment_method->name()
1295 
+						)
1296 
+					)
1297 
+				);
1298 
+			}
1299 
+			return apply_filters(
1300 
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
1301 
+				$billing_form,
1302 
+				$payment_method
1303 
+			);
1304 
+		}
1305 
+		// no actual billing form, so return empty HTML form section
1306 
+		return new EE_Form_Section_HTML();
1307 
+	}
1308 
+
1309 
+
1310 
+	/**
1311 
+	 * _get_selected_method_of_payment
1312 
+	 *
1313 
+	 * @access private
1314 
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
1315 
+	 *                          is not found in the incoming request
1316 
+	 * @param string  $request_param
1317 
+	 * @return NULL|string
1318 
+	 * @throws EE_Error
1319 
+	 * @throws InvalidArgumentException
1320 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1321 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1322 
+	 */
1323 
+	private function _get_selected_method_of_payment(
1324 
+		$required = false,
1325 
+		$request_param = 'selected_method_of_payment'
1326 
+	) {
1327 
+		// is selected_method_of_payment set in the request ?
1328 
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
1329 
+		if ($selected_method_of_payment) {
1330 
+			// sanitize it
1331 
+			$selected_method_of_payment = is_array($selected_method_of_payment)
1332 
+				? array_shift($selected_method_of_payment)
1333 
+				: $selected_method_of_payment;
1334 
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
1335 
+			// store it in the session so that it's available for all subsequent requests including AJAX
1336 
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
1337 
+		} else {
1338 
+			// or is is set in the session ?
1339 
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
1340 
+				'selected_method_of_payment'
1341 
+			);
1342 
+		}
1343 
+		// do ya really really gotta have it?
1344 
+		if (empty($selected_method_of_payment) && $required) {
1345 
+			EE_Error::add_error(
1346 
+				sprintf(
1347 
+					esc_html__(
1348 
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
1349 
+						'event_espresso'
1350 
+					),
1351 
+					'<br/>',
1352 
+					'<br/>',
1353 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
1354 
+				),
1355 
+				__FILE__,
1356 
+				__FUNCTION__,
1357 
+				__LINE__
1358 
+			);
1359 
+			return null;
1360 
+		}
1361 
+		return $selected_method_of_payment;
1362 
+	}
1363 
+
1364 
+
1365 
+
1366 
+
1367 
+
1368 
+
1369 
+	/********************************************************************************************************/
1370 
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
1371 
+	/********************************************************************************************************/
1372 
+	/**
1373 
+	 * switch_payment_method
1374 
+	 *
1375 
+	 * @access public
1376 
+	 * @return string
1377 
+	 * @throws EE_Error
1378 
+	 * @throws InvalidArgumentException
1379 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1380 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1381 
+	 */
1382 
+	public function switch_payment_method()
1383 
+	{
1384 
+		if (! $this->_verify_payment_method_is_set()) {
1385 
+			return false;
1386 
+		}
1387 
+		if (apply_filters(
1388 
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
1389 
+			false
1390 
+		)) {
1391 
+			EE_Error::add_success(
1392 
+				apply_filters(
1393 
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
1394 
+					sprintf(
1395 
+						esc_html__(
1396 
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
1397 
+							'event_espresso'
1398 
+						),
1399 
+						$this->checkout->payment_method->name()
1400 
+					)
1401 
+				)
1402 
+			);
1403 
+		}
1404 
+		// generate billing form for selected method of payment if it hasn't been done already
1405 
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1406 
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1407 
+				$this->checkout->payment_method
1408 
+			);
1409 
+		}
1410 
+		// fill form with attendee info if applicable
1411 
+		if (apply_filters(
1412 
+			'FHEE__populate_billing_form_fields_from_attendee',
1413 
+			(
1414 
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
1415 
+				&& $this->checkout->transaction_has_primary_registrant()
1416 
+			),
1417 
+			$this->checkout->billing_form,
1418 
+			$this->checkout->transaction
1419 
+		)
1420 
+		) {
1421 
+			$this->checkout->billing_form->populate_from_attendee(
1422 
+				$this->checkout->transaction->primary_registration()->attendee()
1423 
+			);
1424 
+		}
1425 
+		// and debug content
1426 
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
1427 
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
1428 
+		) {
1429 
+			$this->checkout->billing_form =
1430 
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
1431 
+					$this->checkout->billing_form
1432 
+				);
1433 
+		}
1434 
+		// get html and validation rules for form
1435 
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
1436 
+			$this->checkout->json_response->set_return_data(
1437 
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
1438 
+			);
1439 
+			// localize validation rules for main form
1440 
+			$this->checkout->billing_form->localize_validation_rules(true);
1441 
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
1442 
+		} else {
1443 
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
1444 
+		}
1445 
+		// prevents advancement to next step
1446 
+		$this->checkout->continue_reg = false;
1447 
+		return true;
1448 
+	}
1449 
+
1450 
+
1451 
+	/**
1452 
+	 * _verify_payment_method_is_set
1453 
+	 *
1454 
+	 * @return bool
1455 
+	 * @throws EE_Error
1456 
+	 * @throws InvalidArgumentException
1457 
+	 * @throws ReflectionException
1458 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1459 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1460 
+	 */
1461 
+	protected function _verify_payment_method_is_set()
1462 
+	{
1463 
+		// generate billing form for selected method of payment if it hasn't been done already
1464 
+		if (empty($this->checkout->selected_method_of_payment)) {
1465 
+			// how have they chosen to pay?
1466 
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
1467 
+		} else {
1468 
+			// choose your own adventure based on method_of_payment
1469 
+			switch ($this->checkout->selected_method_of_payment) {
1470 
+				case 'events_sold_out':
1471 
+					EE_Error::add_attention(
1472 
+						apply_filters(
1473 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
1474 
+							esc_html__(
1475 
+								'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
1476 
+								'event_espresso'
1477 
+							)
1478 
+						),
1479 
+						__FILE__,
1480 
+						__FUNCTION__,
1481 
+						__LINE__
1482 
+					);
1483 
+					return false;
1484 
+					break;
1485 
+				case 'payments_closed':
1486 
+					EE_Error::add_attention(
1487 
+						apply_filters(
1488 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
1489 
+							esc_html__(
1490 
+								'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
1491 
+								'event_espresso'
1492 
+							)
1493 
+						),
1494 
+						__FILE__,
1495 
+						__FUNCTION__,
1496 
+						__LINE__
1497 
+					);
1498 
+					return false;
1499 
+					break;
1500 
+				case 'no_payment_required':
1501 
+					EE_Error::add_attention(
1502 
+						apply_filters(
1503 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
1504 
+							esc_html__(
1505 
+								'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
1506 
+								'event_espresso'
1507 
+							)
1508 
+						),
1509 
+						__FILE__,
1510 
+						__FUNCTION__,
1511 
+						__LINE__
1512 
+					);
1513 
+					return false;
1514 
+					break;
1515 
+				default:
1516 
+			}
1517 
+		}
1518 
+		// verify payment method
1519 
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
1520 
+			// get payment method for selected method of payment
1521 
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
1522 
+		}
1523 
+		return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
1524 
+	}
1525 
+
1526 
+
1527 
+
1528 
+	/********************************************************************************************************/
1529 
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
1530 
+	/********************************************************************************************************/
1531 
+	/**
1532 
+	 * save_payer_details_via_ajax
1533 
+	 *
1534 
+	 * @return void
1535 
+	 * @throws EE_Error
1536 
+	 * @throws InvalidArgumentException
1537 
+	 * @throws ReflectionException
1538 
+	 * @throws RuntimeException
1539 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1540 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1541 
+	 */
1542 
+	public function save_payer_details_via_ajax()
1543 
+	{
1544 
+		if (! $this->_verify_payment_method_is_set()) {
1545 
+			return;
1546 
+		}
1547 
+		// generate billing form for selected method of payment if it hasn't been done already
1548 
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
1549 
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1550 
+				$this->checkout->payment_method
1551 
+			);
1552 
+		}
1553 
+		// generate primary attendee from payer info if applicable
1554 
+		if (! $this->checkout->transaction_has_primary_registrant()) {
1555 
+			$attendee = $this->_create_attendee_from_request_data();
1556 
+			if ($attendee instanceof EE_Attendee) {
1557 
+				foreach ($this->checkout->transaction->registrations() as $registration) {
1558 
+					if ($registration->is_primary_registrant()) {
1559 
+						$this->checkout->primary_attendee_obj = $attendee;
1560 
+						$registration->_add_relation_to($attendee, 'Attendee');
1561 
+						$registration->set_attendee_id($attendee->ID());
1562 
+						$registration->update_cache_after_object_save('Attendee', $attendee);
1563 
+					}
1564 
+				}
1565 
+			}
1566 
+		}
1567 
+	}
1568 
+
1569 
+
1570 
+	/**
1571 
+	 * create_attendee_from_request_data
1572 
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
1573 
+	 *
1574 
+	 * @return EE_Attendee
1575 
+	 * @throws EE_Error
1576 
+	 * @throws InvalidArgumentException
1577 
+	 * @throws ReflectionException
1578 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1579 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1580 
+	 */
1581 
+	protected function _create_attendee_from_request_data()
1582 
+	{
1583 
+		// get State ID
1584 
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
1585 
+		if (! empty($STA_ID)) {
1586 
+			// can we get state object from name ?
1587 
+			EE_Registry::instance()->load_model('State');
1588 
+			$state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
1589 
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
1590 
+		}
1591 
+		// get Country ISO
1592 
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
1593 
+		if (! empty($CNT_ISO)) {
1594 
+			// can we get country object from name ?
1595 
+			EE_Registry::instance()->load_model('Country');
1596 
+			$country = EEM_Country::instance()->get_col(
1597 
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
1598 
+				'CNT_ISO'
1599 
+			);
1600 
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
1601 
+		}
1602 
+		// grab attendee data
1603 
+		$attendee_data = array(
1604 
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
1605 
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
1606 
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
1607 
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
1608 
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
1609 
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
1610 
+			'STA_ID'       => $STA_ID,
1611 
+			'CNT_ISO'      => $CNT_ISO,
1612 
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
1613 
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
1614 
+		);
1615 
+		// validate the email address since it is the most important piece of info
1616 
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
1617 
+			EE_Error::add_error(
1618 
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
1619 
+				__FILE__,
1620 
+				__FUNCTION__,
1621 
+				__LINE__
1622 
+			);
1623 
+		}
1624 
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
1625 
+		// AND email address
1626 
+		if (! empty($attendee_data['ATT_fname'])
1627 
+			&& ! empty($attendee_data['ATT_lname'])
1628 
+			&& ! empty($attendee_data['ATT_email'])
1629 
+		) {
1630 
+			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
1631 
+				array(
1632 
+					'ATT_fname' => $attendee_data['ATT_fname'],
1633 
+					'ATT_lname' => $attendee_data['ATT_lname'],
1634 
+					'ATT_email' => $attendee_data['ATT_email'],
1635 
+				)
1636 
+			);
1637 
+			if ($existing_attendee instanceof EE_Attendee) {
1638 
+				return $existing_attendee;
1639 
+			}
1640 
+		}
1641 
+		// no existing attendee? kk let's create a new one
1642 
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
1643 
+		// don't exist
1644 
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
1645 
+			? $attendee_data['ATT_fname']
1646 
+			: $attendee_data['ATT_email'];
1647 
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
1648 
+			? $attendee_data['ATT_lname']
1649 
+			: $attendee_data['ATT_email'];
1650 
+		return EE_Attendee::new_instance($attendee_data);
1651 
+	}
1652 
+
1653 
+
1654 
+
1655 
+	/********************************************************************************************************/
1656 
+	/****************************************  PROCESS REG STEP  *****************************************/
1657 
+	/********************************************************************************************************/
1658 
+	/**
1659 
+	 * process_reg_step
1660 
+	 *
1661 
+	 * @return bool
1662 
+	 * @throws EE_Error
1663 
+	 * @throws InvalidArgumentException
1664 
+	 * @throws ReflectionException
1665 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1666 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1667 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1668 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
1669 
+	 */
1670 
+	public function process_reg_step()
1671 
+	{
1672 
+		// how have they chosen to pay?
1673 
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
1674 
+			? 'no_payment_required'
1675 
+			: $this->_get_selected_method_of_payment(true);
1676 
+		// choose your own adventure based on method_of_payment
1677 
+		switch ($this->checkout->selected_method_of_payment) {
1678 
+			case 'events_sold_out':
1679 
+				$this->checkout->redirect = true;
1680 
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
1681 
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1682 
+				// mark this reg step as completed
1683 
+				$this->set_completed();
1684 
+				return false;
1685 
+				break;
1686 
+
1687 
+			case 'payments_closed':
1688 
+				if (apply_filters(
1689 
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
1690 
+					false
1691 
+				)) {
1692 
+					EE_Error::add_success(
1693 
+						esc_html__('no payment required at this time.', 'event_espresso'),
1694 
+						__FILE__,
1695 
+						__FUNCTION__,
1696 
+						__LINE__
1697 
+					);
1698 
+				}
1699 
+				// mark this reg step as completed
1700 
+				$this->set_completed();
1701 
+				return true;
1702 
+				break;
1703 
+
1704 
+			case 'no_payment_required':
1705 
+				if (apply_filters(
1706 
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
1707 
+					false
1708 
+				)) {
1709 
+					EE_Error::add_success(
1710 
+						esc_html__('no payment required.', 'event_espresso'),
1711 
+						__FILE__,
1712 
+						__FUNCTION__,
1713 
+						__LINE__
1714 
+					);
1715 
+				}
1716 
+				// mark this reg step as completed
1717 
+				$this->set_completed();
1718 
+				return true;
1719 
+				break;
1720 
+
1721 
+			default:
1722 
+				$registrations = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
1723 
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
1724 
+				);
1725 
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
1726 
+					$registrations,
1727 
+					EE_Registry::instance()->SSN->checkout()->revisit
1728 
+				);
1729 
+				// calculate difference between the two arrays
1730 
+				$registrations = array_diff($registrations, $ejected_registrations);
1731 
+				if (empty($registrations)) {
1732 
+					$this->_redirect_because_event_sold_out();
1733 
+					return false;
1734 
+				}
1735 
+				$payment_successful = $this->_process_payment();
1736 
+				if ($payment_successful) {
1737 
+					$this->checkout->continue_reg = true;
1738 
+					$this->_maybe_set_completed($this->checkout->payment_method);
1739 
+				} else {
1740 
+					$this->checkout->continue_reg = false;
1741 
+				}
1742 
+				return $payment_successful;
1743 
+		}
1744 
+	}
1745 
+
1746 
+
1747 
+	/**
1748 
+	 * _redirect_because_event_sold_out
1749 
+	 *
1750 
+	 * @access protected
1751 
+	 * @return void
1752 
+	 */
1753 
+	protected function _redirect_because_event_sold_out()
1754 
+	{
1755 
+		$this->checkout->continue_reg = false;
1756 
+		// set redirect URL
1757 
+		$this->checkout->redirect_url = add_query_arg(
1758 
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
1759 
+			$this->checkout->current_step->reg_step_url()
1760 
+		);
1761 
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
1762 
+	}
1763 
+
1764 
+
1765 
+	/**
1766 
+	 * _maybe_set_completed
1767 
+	 *
1768 
+	 * @access protected
1769 
+	 * @param \EE_Payment_Method $payment_method
1770 
+	 * @return void
1771 
+	 * @throws \EE_Error
1772 
+	 */
1773 
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
1774 
+	{
1775 
+		switch ($payment_method->type_obj()->payment_occurs()) {
1776 
+			case EE_PMT_Base::offsite:
1777 
+				break;
1778 
+			case EE_PMT_Base::onsite:
1779 
+			case EE_PMT_Base::offline:
1780 
+				// mark this reg step as completed
1781 
+				$this->set_completed();
1782 
+				break;
1783 
+		}
1784 
+	}
1785 
+
1786 
+
1787 
+	/**
1788 
+	 *    update_reg_step
1789 
+	 *    this is the final step after a user  revisits the site to retry a payment
1790 
+	 *
1791 
+	 * @return bool
1792 
+	 * @throws EE_Error
1793 
+	 * @throws InvalidArgumentException
1794 
+	 * @throws ReflectionException
1795 
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
1796 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1797 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1798 
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
1799 
+	 */
1800 
+	public function update_reg_step()
1801 
+	{
1802 
+		$success = true;
1803 
+		// if payment required
1804 
+		if ($this->checkout->transaction->total() > 0) {
1805 
+			do_action(
1806 
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
1807 
+				$this->checkout->transaction
1808 
+			);
1809 
+			// attempt payment via payment method
1810 
+			$success = $this->process_reg_step();
1811 
+		}
1812 
+		if ($success && ! $this->checkout->redirect) {
1813 
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
1814 
+				$this->checkout->transaction->ID()
1815 
+			);
1816 
+			// set return URL
1817 
+			$this->checkout->redirect_url = add_query_arg(
1818 
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
1819 
+				$this->checkout->thank_you_page_url
1820 
+			);
1821 
+		}
1822 
+		return $success;
1823 
+	}
1824 
+
1825 
+
1826 
+	/**
1827 
+	 *    _process_payment
1828 
+	 *
1829 
+	 * @access private
1830 
+	 * @return bool
1831 
+	 * @throws EE_Error
1832 
+	 * @throws InvalidArgumentException
1833 
+	 * @throws ReflectionException
1834 
+	 * @throws RuntimeException
1835 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1836 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1837 
+	 */
1838 
+	private function _process_payment()
1839 
+	{
1840 
+		// basically confirm that the event hasn't sold out since they hit the page
1841 
+		if (! $this->_last_second_ticket_verifications()) {
1842 
+			return false;
1843 
+		}
1844 
+		// ya gotta make a choice man
1845 
+		if (empty($this->checkout->selected_method_of_payment)) {
1846 
+			$this->checkout->json_response->set_plz_select_method_of_payment(
1847 
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
1848 
+			);
1849 
+			return false;
1850 
+		}
1851 
+		// get EE_Payment_Method object
1852 
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
1853 
+			return false;
1854 
+		}
1855 
+		// setup billing form
1856 
+		if ($this->checkout->payment_method->is_on_site()) {
1857 
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
1858 
+				$this->checkout->payment_method
1859 
+			);
1860 
+			// bad billing form ?
1861 
+			if (! $this->_billing_form_is_valid()) {
1862 
+				return false;
1863 
+			}
1864 
+		}
1865 
+		// ensure primary registrant has been fully processed
1866 
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
1867 
+			return false;
1868 
+		}
1869 
+		// if session is close to expiring (under 10 minutes by default)
1870 
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
1871 
+			// add some time to session expiration so that payment can be completed
1872 
+			EE_Registry::instance()->SSN->extend_expiration();
1873 
+		}
1874 
+		/** @type EE_Transaction_Processor $transaction_processor */
1875 
+		// $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
1876 
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
1877 
+		// for events with a default reg status of Approved
1878 
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
1879 
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
1880 
+		// );
1881 
+		// attempt payment
1882 
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
1883 
+		// process results
1884 
+		$payment = $this->_validate_payment($payment);
1885 
+		$payment = $this->_post_payment_processing($payment);
1886 
+		// verify payment
1887 
+		if ($payment instanceof EE_Payment) {
1888 
+			// store that for later
1889 
+			$this->checkout->payment = $payment;
1890 
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
1891 
+			$this->checkout->transaction->toggle_failed_transaction_status();
1892 
+			$payment_status = $payment->status();
1893 
+			if ($payment_status === EEM_Payment::status_id_approved
1894 
+				|| $payment_status === EEM_Payment::status_id_pending
1895 
+			) {
1896 
+				return true;
1897 
+			} else {
1898 
+				return false;
1899 
+			}
1900 
+		} elseif ($payment === true) {
1901 
+			// please note that offline payment methods will NOT make a payment,
1902 
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
1903 
+			$this->checkout->payment = $payment;
1904 
+			return true;
1905 
+		}
1906 
+		// where's my money?
1907 
+		return false;
1908 
+	}
1909 
+
1910 
+
1911 
+	/**
1912 
+	 * _last_second_ticket_verifications
1913 
+	 *
1914 
+	 * @access public
1915 
+	 * @return bool
1916 
+	 * @throws EE_Error
1917 
+	 */
1918 
+	protected function _last_second_ticket_verifications()
1919 
+	{
1920 
+		// don't bother re-validating if not a return visit
1921 
+		if (! $this->checkout->revisit) {
1922 
+			return true;
1923 
+		}
1924 
+		$registrations = $this->checkout->transaction->registrations();
1925 
+		if (empty($registrations)) {
1926 
+			return false;
1927 
+		}
1928 
+		foreach ($registrations as $registration) {
1929 
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
1930 
+				$event = $registration->event_obj();
1931 
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
1932 
+					EE_Error::add_error(
1933 
+						apply_filters(
1934 
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
1935 
+							sprintf(
1936 
+								esc_html__(
1937 
+									'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
1938 
+									'event_espresso'
1939 
+								),
1940 
+								$event->name()
1941 
+							)
1942 
+						),
1943 
+						__FILE__,
1944 
+						__FUNCTION__,
1945 
+						__LINE__
1946 
+					);
1947 
+					return false;
1948 
+				}
1949 
+			}
1950 
+		}
1951 
+		return true;
1952 
+	}
1953 
+
1954 
+
1955 
+	/**
1956 
+	 * redirect_form
1957 
+	 *
1958 
+	 * @access public
1959 
+	 * @return bool
1960 
+	 * @throws EE_Error
1961 
+	 * @throws InvalidArgumentException
1962 
+	 * @throws ReflectionException
1963 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
1964 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
1965 
+	 */
1966 
+	public function redirect_form()
1967 
+	{
1968 
+		$payment_method_billing_info = $this->_payment_method_billing_info(
1969 
+			$this->_get_payment_method_for_selected_method_of_payment()
1970 
+		);
1971 
+		$html = $payment_method_billing_info->get_html();
1972 
+		$html .= $this->checkout->redirect_form;
1973 
+		EE_Registry::instance()->REQ->add_output($html);
1974 
+		return true;
1975 
+	}
1976 
+
1977 
+
1978 
+	/**
1979 
+	 * _billing_form_is_valid
1980 
+	 *
1981 
+	 * @access private
1982 
+	 * @return bool
1983 
+	 * @throws \EE_Error
1984 
+	 */
1985 
+	private function _billing_form_is_valid()
1986 
+	{
1987 
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
1988 
+			return true;
1989 
+		}
1990 
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
1991 
+			if ($this->checkout->billing_form->was_submitted()) {
1992 
+				$this->checkout->billing_form->receive_form_submission();
1993 
+				if ($this->checkout->billing_form->is_valid()) {
1994 
+					return true;
1995 
+				}
1996 
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
1997 
+				$error_strings = array();
1998 
+				foreach ($validation_errors as $validation_error) {
1999 
+					if ($validation_error instanceof EE_Validation_Error) {
2000 
+						$form_section = $validation_error->get_form_section();
2001 
+						if ($form_section instanceof EE_Form_Input_Base) {
2002 
+							$label = $form_section->html_label_text();
2003 
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
2004 
+							$label = $form_section->name();
2005 
+						} else {
2006 
+							$label = esc_html__('Validation Error', 'event_espresso');
2007 
+						}
2008 
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
2009 
+					}
2010 
+				}
2011 
+				EE_Error::add_error(
2012 
+					sprintf(
2013 
+						esc_html__(
2014 
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
2015 
+							'event_espresso'
2016 
+						),
2017 
+						'<br/>',
2018 
+						implode('<br/>', $error_strings)
2019 
+					),
2020 
+					__FILE__,
2021 
+					__FUNCTION__,
2022 
+					__LINE__
2023 
+				);
2024 
+			} else {
2025 
+				EE_Error::add_error(
2026 
+					esc_html__(
2027 
+						'The billing form was not submitted or something prevented it\'s submission.',
2028 
+						'event_espresso'
2029 
+					),
2030 
+					__FILE__,
2031 
+					__FUNCTION__,
2032 
+					__LINE__
2033 
+				);
2034 
+			}
2035 
+		} else {
2036 
+			EE_Error::add_error(
2037 
+				esc_html__(
2038 
+					'The submitted billing form is invalid possibly due to a technical reason.',
2039 
+					'event_espresso'
2040 
+				),
2041 
+				__FILE__,
2042 
+				__FUNCTION__,
2043 
+				__LINE__
2044 
+			);
2045 
+		}
2046 
+		return false;
2047 
+	}
2048 
+
2049 
+
2050 
+	/**
2051 
+	 * _setup_primary_registrant_prior_to_payment
2052 
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
2053 
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
2054 
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
2055 
+	 * yet)
2056 
+	 *
2057 
+	 * @access private
2058 
+	 * @return bool
2059 
+	 * @throws EE_Error
2060 
+	 * @throws InvalidArgumentException
2061 
+	 * @throws ReflectionException
2062 
+	 * @throws RuntimeException
2063 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2064 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2065 
+	 */
2066 
+	private function _setup_primary_registrant_prior_to_payment()
2067 
+	{
2068 
+		// check if transaction has a primary registrant and that it has a related Attendee object
2069 
+		// if not, then we need to at least gather some primary registrant data before attempting payment
2070 
+		if ($this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
2071 
+			&& ! $this->checkout->transaction_has_primary_registrant()
2072 
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
2073 
+		) {
2074 
+			return false;
2075 
+		}
2076 
+		// because saving an object clears it's cache, we need to do the chevy shuffle
2077 
+		// grab the primary_registration object
2078 
+		$primary_registration = $this->checkout->transaction->primary_registration();
2079 
+		// at this point we'll consider a TXN to not have been failed
2080 
+		$this->checkout->transaction->toggle_failed_transaction_status();
2081 
+		// save the TXN ( which clears cached copy of primary_registration)
2082 
+		$this->checkout->transaction->save();
2083 
+		// grab TXN ID and save it to the primary_registration
2084 
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
2085 
+		// save what we have so far
2086 
+		$primary_registration->save();
2087 
+		return true;
2088 
+	}
2089 
+
2090 
+
2091 
+	/**
2092 
+	 * _capture_primary_registration_data_from_billing_form
2093 
+	 *
2094 
+	 * @access private
2095 
+	 * @return bool
2096 
+	 * @throws EE_Error
2097 
+	 * @throws InvalidArgumentException
2098 
+	 * @throws ReflectionException
2099 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2100 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2101 
+	 */
2102 
+	private function _capture_primary_registration_data_from_billing_form()
2103 
+	{
2104 
+		// convert billing form data into an attendee
2105 
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
2106 
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
2107 
+			EE_Error::add_error(
2108 
+				sprintf(
2109 
+					esc_html__(
2110 
+						'The billing form details could not be used for attendee details due to a technical issue.%sPlease try again or contact %s for assistance.',
2111 
+						'event_espresso'
2112 
+					),
2113 
+					'<br/>',
2114 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2115 
+				),
2116 
+				__FILE__,
2117 
+				__FUNCTION__,
2118 
+				__LINE__
2119 
+			);
2120 
+			return false;
2121 
+		}
2122 
+		$primary_registration = $this->checkout->transaction->primary_registration();
2123 
+		if (! $primary_registration instanceof EE_Registration) {
2124 
+			EE_Error::add_error(
2125 
+				sprintf(
2126 
+					esc_html__(
2127 
+						'The primary registrant for this transaction could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2128 
+						'event_espresso'
2129 
+					),
2130 
+					'<br/>',
2131 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2132 
+				),
2133 
+				__FILE__,
2134 
+				__FUNCTION__,
2135 
+				__LINE__
2136 
+			);
2137 
+			return false;
2138 
+		}
2139 
+		if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
2140 
+			  instanceof
2141 
+			  EE_Attendee
2142 
+		) {
2143 
+			EE_Error::add_error(
2144 
+				sprintf(
2145 
+					esc_html__(
2146 
+						'The primary registrant could not be associated with this transaction due to a technical issue.%sPlease try again or contact %s for assistance.',
2147 
+						'event_espresso'
2148 
+					),
2149 
+					'<br/>',
2150 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2151 
+				),
2152 
+				__FILE__,
2153 
+				__FUNCTION__,
2154 
+				__LINE__
2155 
+			);
2156 
+			return false;
2157 
+		}
2158 
+		/** @type EE_Registration_Processor $registration_processor */
2159 
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
2160 
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
2161 
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
2162 
+		return true;
2163 
+	}
2164 
+
2165 
+
2166 
+	/**
2167 
+	 * _get_payment_method_for_selected_method_of_payment
2168 
+	 * retrieves a valid payment method
2169 
+	 *
2170 
+	 * @access public
2171 
+	 * @return EE_Payment_Method
2172 
+	 * @throws EE_Error
2173 
+	 * @throws InvalidArgumentException
2174 
+	 * @throws ReflectionException
2175 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2176 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2177 
+	 */
2178 
+	private function _get_payment_method_for_selected_method_of_payment()
2179 
+	{
2180 
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
2181 
+			$this->_redirect_because_event_sold_out();
2182 
+			return null;
2183 
+		}
2184 
+		// get EE_Payment_Method object
2185 
+		if (isset($this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ])) {
2186 
+			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
2187 
+		} else {
2188 
+			// load EEM_Payment_Method
2189 
+			EE_Registry::instance()->load_model('Payment_Method');
2190 
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
2191 
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
2192 
+			$payment_method = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
2193 
+		}
2194 
+		// verify $payment_method
2195 
+		if (! $payment_method instanceof EE_Payment_Method) {
2196 
+			// not a payment
2197 
+			EE_Error::add_error(
2198 
+				sprintf(
2199 
+					esc_html__(
2200 
+						'The selected method of payment could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2201 
+						'event_espresso'
2202 
+					),
2203 
+					'<br/>',
2204 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2205 
+				),
2206 
+				__FILE__,
2207 
+				__FUNCTION__,
2208 
+				__LINE__
2209 
+			);
2210 
+			return null;
2211 
+		}
2212 
+		// and verify it has a valid Payment_Method Type object
2213 
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
2214 
+			// not a payment
2215 
+			EE_Error::add_error(
2216 
+				sprintf(
2217 
+					esc_html__(
2218 
+						'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
2219 
+						'event_espresso'
2220 
+					),
2221 
+					'<br/>',
2222 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2223 
+				),
2224 
+				__FILE__,
2225 
+				__FUNCTION__,
2226 
+				__LINE__
2227 
+			);
2228 
+			return null;
2229 
+		}
2230 
+		return $payment_method;
2231 
+	}
2232 
+
2233 
+
2234 
+	/**
2235 
+	 *    _attempt_payment
2236 
+	 *
2237 
+	 * @access    private
2238 
+	 * @type    EE_Payment_Method $payment_method
2239 
+	 * @return mixed EE_Payment | boolean
2240 
+	 * @throws EE_Error
2241 
+	 * @throws InvalidArgumentException
2242 
+	 * @throws ReflectionException
2243 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2244 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2245 
+	 */
2246 
+	private function _attempt_payment(EE_Payment_Method $payment_method)
2247 
+	{
2248 
+		$payment = null;
2249 
+		$this->checkout->transaction->save();
2250 
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2251 
+		if (! $payment_processor instanceof EE_Payment_Processor) {
2252 
+			return false;
2253 
+		}
2254 
+		try {
2255 
+			$payment_processor->set_revisit($this->checkout->revisit);
2256 
+			// generate payment object
2257 
+			$payment = $payment_processor->process_payment(
2258 
+				$payment_method,
2259 
+				$this->checkout->transaction,
2260 
+				$this->checkout->amount_owing,
2261 
+				$this->checkout->billing_form,
2262 
+				$this->_get_return_url($payment_method),
2263 
+				'CART',
2264 
+				$this->checkout->admin_request,
2265 
+				true,
2266 
+				$this->reg_step_url()
2267 
+			);
2268 
+		} catch (Exception $e) {
2269 
+			$this->_handle_payment_processor_exception($e);
2270 
+		}
2271 
+		return $payment;
2272 
+	}
2273 
+
2274 
+
2275 
+	/**
2276 
+	 * _handle_payment_processor_exception
2277 
+	 *
2278 
+	 * @access protected
2279 
+	 * @param \Exception $e
2280 
+	 * @return void
2281 
+	 * @throws EE_Error
2282 
+	 * @throws InvalidArgumentException
2283 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2284 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2285 
+	 */
2286 
+	protected function _handle_payment_processor_exception(Exception $e)
2287 
+	{
2288 
+		EE_Error::add_error(
2289 
+			sprintf(
2290 
+				esc_html__(
2291 
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
2292 
+					'event_espresso'
2293 
+				),
2294 
+				'<br/>',
2295 
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
2296 
+				$e->getMessage(),
2297 
+				$e->getFile(),
2298 
+				$e->getLine()
2299 
+			),
2300 
+			__FILE__,
2301 
+			__FUNCTION__,
2302 
+			__LINE__
2303 
+		);
2304 
+	}
2305 
+
2306 
+
2307 
+	/**
2308 
+	 * _get_return_url
2309 
+	 *
2310 
+	 * @access protected
2311 
+	 * @param \EE_Payment_Method $payment_method
2312 
+	 * @return string
2313 
+	 * @throws \EE_Error
2314 
+	 */
2315 
+	protected function _get_return_url(EE_Payment_Method $payment_method)
2316 
+	{
2317 
+		$return_url = '';
2318 
+		switch ($payment_method->type_obj()->payment_occurs()) {
2319 
+			case EE_PMT_Base::offsite:
2320 
+				$return_url = add_query_arg(
2321 
+					array(
2322 
+						'action'                     => 'process_gateway_response',
2323 
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2324 
+						'spco_txn'                   => $this->checkout->transaction->ID(),
2325 
+					),
2326 
+					$this->reg_step_url()
2327 
+				);
2328 
+				break;
2329 
+			case EE_PMT_Base::onsite:
2330 
+			case EE_PMT_Base::offline:
2331 
+				$return_url = $this->checkout->next_step->reg_step_url();
2332 
+				break;
2333 
+		}
2334 
+		return $return_url;
2335 
+	}
2336 
+
2337 
+
2338 
+	/**
2339 
+	 * _validate_payment
2340 
+	 *
2341 
+	 * @access private
2342 
+	 * @param EE_Payment $payment
2343 
+	 * @return EE_Payment|FALSE
2344 
+	 * @throws EE_Error
2345 
+	 * @throws InvalidArgumentException
2346 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2347 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2348 
+	 */
2349 
+	private function _validate_payment($payment = null)
2350 
+	{
2351 
+		if ($this->checkout->payment_method->is_off_line()) {
2352 
+			return true;
2353 
+		}
2354 
+		// verify payment object
2355 
+		if (! $payment instanceof EE_Payment) {
2356 
+			// not a payment
2357 
+			EE_Error::add_error(
2358 
+				sprintf(
2359 
+					esc_html__(
2360 
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
2361 
+						'event_espresso'
2362 
+					),
2363 
+					'<br/>',
2364 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2365 
+				),
2366 
+				__FILE__,
2367 
+				__FUNCTION__,
2368 
+				__LINE__
2369 
+			);
2370 
+			return false;
2371 
+		}
2372 
+		return $payment;
2373 
+	}
2374 
+
2375 
+
2376 
+	/**
2377 
+	 * _post_payment_processing
2378 
+	 *
2379 
+	 * @access private
2380 
+	 * @param EE_Payment|bool $payment
2381 
+	 * @return bool
2382 
+	 * @throws EE_Error
2383 
+	 * @throws InvalidArgumentException
2384 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2385 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2386 
+	 */
2387 
+	private function _post_payment_processing($payment = null)
2388 
+	{
2389 
+		// Off-Line payment?
2390 
+		if ($payment === true) {
2391 
+			// $this->_setup_redirect_for_next_step();
2392 
+			return true;
2393 
+			// On-Site payment?
2394 
+		} elseif ($this->checkout->payment_method->is_on_site()) {
2395 
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
2396 
+				// $this->_setup_redirect_for_next_step();
2397 
+				$this->checkout->continue_reg = false;
2398 
+			}
2399 
+			// Off-Site payment?
2400 
+		} elseif ($this->checkout->payment_method->is_off_site()) {
2401 
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
2402 
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
2403 
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
2404 
+				$this->checkout->redirect = true;
2405 
+				$this->checkout->redirect_form = $payment->redirect_form();
2406 
+				$this->checkout->redirect_url = $this->reg_step_url('redirect_form');
2407 
+				// set JSON response
2408 
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
2409 
+				// and lastly, let's bump the payment status to pending
2410 
+				$payment->set_status(EEM_Payment::status_id_pending);
2411 
+				$payment->save();
2412 
+			} else {
2413 
+				// not a payment
2414 
+				$this->checkout->continue_reg = false;
2415 
+				EE_Error::add_error(
2416 
+					sprintf(
2417 
+						esc_html__(
2418 
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
2419 
+							'event_espresso'
2420 
+						),
2421 
+						'<br/>',
2422 
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
2423 
+					),
2424 
+					__FILE__,
2425 
+					__FUNCTION__,
2426 
+					__LINE__
2427 
+				);
2428 
+			}
2429 
+		} else {
2430 
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
2431 
+			$this->checkout->continue_reg = false;
2432 
+			return false;
2433 
+		}
2434 
+		return $payment;
2435 
+	}
2436 
+
2437 
+
2438 
+	/**
2439 
+	 *    _process_payment_status
2440 
+	 *
2441 
+	 * @access private
2442 
+	 * @type    EE_Payment $payment
2443 
+	 * @param string       $payment_occurs
2444 
+	 * @return bool
2445 
+	 * @throws EE_Error
2446 
+	 * @throws InvalidArgumentException
2447 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2448 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2449 
+	 */
2450 
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
2451 
+	{
2452 
+		// off-line payment? carry on
2453 
+		if ($payment_occurs === EE_PMT_Base::offline) {
2454 
+			return true;
2455 
+		}
2456 
+		// verify payment validity
2457 
+		if ($payment instanceof EE_Payment) {
2458 
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
2459 
+			$msg = $payment->gateway_response();
2460 
+			// check results
2461 
+			switch ($payment->status()) {
2462 
+				// good payment
2463 
+				case EEM_Payment::status_id_approved:
2464 
+					EE_Error::add_success(
2465 
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
2466 
+						__FILE__,
2467 
+						__FUNCTION__,
2468 
+						__LINE__
2469 
+					);
2470 
+					return true;
2471 
+					break;
2472 
+				// slow payment
2473 
+				case EEM_Payment::status_id_pending:
2474 
+					if (empty($msg)) {
2475 
+						$msg = esc_html__(
2476 
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
2477 
+							'event_espresso'
2478 
+						);
2479 
+					}
2480 
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
2481 
+					return true;
2482 
+					break;
2483 
+				// don't wanna payment
2484 
+				case EEM_Payment::status_id_cancelled:
2485 
+					if (empty($msg)) {
2486 
+						$msg = _n(
2487 
+							'Payment cancelled. Please try again.',
2488 
+							'Payment cancelled. Please try again or select another method of payment.',
2489 
+							count($this->checkout->available_payment_methods),
2490 
+							'event_espresso'
2491 
+						);
2492 
+					}
2493 
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2494 
+					return false;
2495 
+					break;
2496 
+				// not enough payment
2497 
+				case EEM_Payment::status_id_declined:
2498 
+					if (empty($msg)) {
2499 
+						$msg = _n(
2500 
+							'We\'re sorry but your payment was declined. Please try again.',
2501 
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
2502 
+							count($this->checkout->available_payment_methods),
2503 
+							'event_espresso'
2504 
+						);
2505 
+					}
2506 
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
2507 
+					return false;
2508 
+					break;
2509 
+				// bad payment
2510 
+				case EEM_Payment::status_id_failed:
2511 
+					if (! empty($msg)) {
2512 
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
2513 
+						return false;
2514 
+					}
2515 
+					// default to error below
2516 
+					break;
2517 
+			}
2518 
+		}
2519 
+		// off-site payment gateway responses are too unreliable, so let's just assume that
2520 
+		// the payment processing is just running slower than the registrant's request
2521 
+		if ($payment_occurs === EE_PMT_Base::offsite) {
2522 
+			return true;
2523 
+		}
2524 
+		EE_Error::add_error(
2525 
+			sprintf(
2526 
+				esc_html__(
2527 
+					'Your payment could not be processed successfully due to a technical issue.%sPlease try again or contact %s for assistance.',
2528 
+					'event_espresso'
2529 
+				),
2530 
+				'<br/>',
2531 
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
2532 
+			),
2533 
+			__FILE__,
2534 
+			__FUNCTION__,
2535 
+			__LINE__
2536 
+		);
2537 
+		return false;
2538 
+	}
2539 
+
2540 
+
2541 
+
2542 
+
2543 
+
2544 
+
2545 
+	/********************************************************************************************************/
2546 
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
2547 
+	/********************************************************************************************************/
2548 
+	/**
2549 
+	 * process_gateway_response
2550 
+	 * this is the return point for Off-Site Payment Methods
2551 
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
2552 
+	 * otherwise, it will load up the last payment made for the TXN.
2553 
+	 * If the payment retrieved looks good, it will then either:
2554 
+	 *    complete the current step and allow advancement to the next reg step
2555 
+	 *        or present the payment options again
2556 
+	 *
2557 
+	 * @access private
2558 
+	 * @return EE_Payment|FALSE
2559 
+	 * @throws EE_Error
2560 
+	 * @throws InvalidArgumentException
2561 
+	 * @throws ReflectionException
2562 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2563 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2564 
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2565 
+	 */
2566 
+	public function process_gateway_response()
2567 
+	{
2568 
+		$payment = null;
2569 
+		// how have they chosen to pay?
2570 
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
2571 
+		// get EE_Payment_Method object
2572 
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
2573 
+			$this->checkout->continue_reg = false;
2574 
+			return false;
2575 
+		}
2576 
+		if (! $this->checkout->payment_method->is_off_site()) {
2577 
+			return false;
2578 
+		}
2579 
+		$this->_validate_offsite_return();
2580 
+		// DEBUG LOG
2581 
+		// $this->checkout->log(
2582 
+		//     __CLASS__,
2583 
+		//     __FUNCTION__,
2584 
+		//     __LINE__,
2585 
+		//     array(
2586 
+		//         'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2587 
+		//         'payment_method'             => $this->checkout->payment_method,
2588 
+		//     ),
2589 
+		//     true
2590 
+		// );
2591 
+		// verify TXN
2592 
+		if ($this->checkout->transaction instanceof EE_Transaction) {
2593 
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
2594 
+			if (! $gateway instanceof EE_Offsite_Gateway) {
2595 
+				$this->checkout->continue_reg = false;
2596 
+				return false;
2597 
+			}
2598 
+			$payment = $this->_process_off_site_payment($gateway);
2599 
+			$payment = $this->_process_cancelled_payments($payment);
2600 
+			$payment = $this->_validate_payment($payment);
2601 
+			// if payment was not declined by the payment gateway or cancelled by the registrant
2602 
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
2603 
+				// $this->_setup_redirect_for_next_step();
2604 
+				// store that for later
2605 
+				$this->checkout->payment = $payment;
2606 
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
2607 
+				// because we will complete this step during the IPN processing then
2608 
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
2609 
+					$this->set_completed();
2610 
+				}
2611 
+				return true;
2612 
+			}
2613 
+		}
2614 
+		// DEBUG LOG
2615 
+		// $this->checkout->log(
2616 
+		//     __CLASS__,
2617 
+		//     __FUNCTION__,
2618 
+		//     __LINE__,
2619 
+		//     array('payment' => $payment)
2620 
+		// );
2621 
+		$this->checkout->continue_reg = false;
2622 
+		return false;
2623 
+	}
2624 
+
2625 
+
2626 
+	/**
2627 
+	 * _validate_return
2628 
+	 *
2629 
+	 * @access private
2630 
+	 * @return void
2631 
+	 * @throws EE_Error
2632 
+	 * @throws InvalidArgumentException
2633 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2634 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2635 
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
2636 
+	 */
2637 
+	private function _validate_offsite_return()
2638 
+	{
2639 
+		$TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
2640 
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
2641 
+			// Houston... we might have a problem
2642 
+			$invalid_TXN = false;
2643 
+			// first gather some info
2644 
+			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
2645 
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
2646 
+				? $valid_TXN->primary_registration()
2647 
+				: null;
2648 
+			// let's start by retrieving the cart for this TXN
2649 
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
2650 
+			if ($cart instanceof EE_Cart) {
2651 
+				// verify that the current cart has tickets
2652 
+				$tickets = $cart->get_tickets();
2653 
+				if (empty($tickets)) {
2654 
+					$invalid_TXN = true;
2655 
+				}
2656 
+			} else {
2657 
+				$invalid_TXN = true;
2658 
+			}
2659 
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
2660 
+				? $primary_registrant->session_ID()
2661 
+				: null;
2662 
+			// validate current Session ID and compare against valid TXN session ID
2663 
+			if ($invalid_TXN // if this is already true, then skip other checks
2664 
+				|| EE_Session::instance()->id() === null
2665 
+				|| (
2666 
+					// WARNING !!!
2667 
+					// this could be PayPal sending back duplicate requests (ya they do that)
2668 
+					// or it **could** mean someone is simply registering AGAIN after having just done so
2669 
+					// so now we need to determine if this current TXN looks valid or not
2670 
+					// and whether this reg step has even been started ?
2671 
+					EE_Session::instance()->id() === $valid_TXN_SID
2672 
+					// really? you're half way through this reg step, but you never started it ?
2673 
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
2674 
+				)
2675 
+			) {
2676 
+				$invalid_TXN = true;
2677 
+			}
2678 
+			if ($invalid_TXN) {
2679 
+				// is the valid TXN completed ?
2680 
+				if ($valid_TXN instanceof EE_Transaction) {
2681 
+					// has this step even been started ?
2682 
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
2683 
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
2684 
+						// so it **looks** like this is a double request from PayPal
2685 
+						// so let's try to pick up where we left off
2686 
+						$this->checkout->transaction = $valid_TXN;
2687 
+						$this->checkout->refresh_all_entities(true);
2688 
+						return;
2689 
+					}
2690 
+				}
2691 
+				// you appear to be lost?
2692 
+				$this->_redirect_wayward_request($primary_registrant);
2693 
+			}
2694 
+		}
2695 
+	}
2696 
+
2697 
+
2698 
+	/**
2699 
+	 * _redirect_wayward_request
2700 
+	 *
2701 
+	 * @access private
2702 
+	 * @param \EE_Registration|null $primary_registrant
2703 
+	 * @return bool
2704 
+	 * @throws EE_Error
2705 
+	 * @throws InvalidArgumentException
2706 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2707 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2708 
+	 */
2709 
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
2710 
+	{
2711 
+		if (! $primary_registrant instanceof EE_Registration) {
2712 
+			// try redirecting based on the current TXN
2713 
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
2714 
+				? $this->checkout->transaction->primary_registration()
2715 
+				: null;
2716 
+		}
2717 
+		if (! $primary_registrant instanceof EE_Registration) {
2718 
+			EE_Error::add_error(
2719 
+				sprintf(
2720 
+					esc_html__(
2721 
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
2722 
+						'event_espresso'
2723 
+					),
2724 
+					'<br/>',
2725 
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
2726 
+				),
2727 
+				__FILE__,
2728 
+				__FUNCTION__,
2729 
+				__LINE__
2730 
+			);
2731 
+			return false;
2732 
+		}
2733 
+		// make sure transaction is not locked
2734 
+		$this->checkout->transaction->unlock();
2735 
+		wp_safe_redirect(
2736 
+			add_query_arg(
2737 
+				array(
2738 
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
2739 
+				),
2740 
+				$this->checkout->thank_you_page_url
2741 
+			)
2742 
+		);
2743 
+		exit();
2744 
+	}
2745 
+
2746 
+
2747 
+	/**
2748 
+	 * _process_off_site_payment
2749 
+	 *
2750 
+	 * @access private
2751 
+	 * @param \EE_Offsite_Gateway $gateway
2752 
+	 * @return EE_Payment
2753 
+	 * @throws EE_Error
2754 
+	 * @throws InvalidArgumentException
2755 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2756 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2757 
+	 */
2758 
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
2759 
+	{
2760 
+		try {
2761 
+			$request_data = \EE_Registry::instance()->REQ->params();
2762 
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
2763 
+			$this->set_handle_IPN_in_this_request(
2764 
+				$gateway->handle_IPN_in_this_request($request_data, false)
2765 
+			);
2766 
+			if ($this->handle_IPN_in_this_request()) {
2767 
+				// get payment details and process results
2768 
+				/** @type EE_Payment_Processor $payment_processor */
2769 
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
2770 
+				$payment = $payment_processor->process_ipn(
2771 
+					$request_data,
2772 
+					$this->checkout->transaction,
2773 
+					$this->checkout->payment_method,
2774 
+					true,
2775 
+					false
2776 
+				);
2777 
+				// $payment_source = 'process_ipn';
2778 
+			} else {
2779 
+				$payment = $this->checkout->transaction->last_payment();
2780 
+				// $payment_source = 'last_payment';
2781 
+			}
2782 
+		} catch (Exception $e) {
2783 
+			// let's just eat the exception and try to move on using any previously set payment info
2784 
+			$payment = $this->checkout->transaction->last_payment();
2785 
+			// $payment_source = 'last_payment after Exception';
2786 
+			// but if we STILL don't have a payment object
2787 
+			if (! $payment instanceof EE_Payment) {
2788 
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
2789 
+				$this->_handle_payment_processor_exception($e);
2790 
+			}
2791 
+		}
2792 
+		// DEBUG LOG
2793 
+		// $this->checkout->log(
2794 
+		//     __CLASS__,
2795 
+		//     __FUNCTION__,
2796 
+		//     __LINE__,
2797 
+		//     array(
2798 
+		//         'process_ipn_payment' => $payment,
2799 
+		//         'payment_source'      => $payment_source,
2800 
+		//     )
2801 
+		// );
2802 
+		return $payment;
2803 
+	}
2804 
+
2805 
+
2806 
+	/**
2807 
+	 * _process_cancelled_payments
2808 
+	 * just makes sure that the payment status gets updated correctly
2809 
+	 * so tha tan error isn't generated during payment validation
2810 
+	 *
2811 
+	 * @access private
2812 
+	 * @param EE_Payment $payment
2813 
+	 * @return EE_Payment | FALSE
2814 
+	 * @throws \EE_Error
2815 
+	 */
2816 
+	private function _process_cancelled_payments($payment = null)
2817 
+	{
2818 
+		if ($payment instanceof EE_Payment
2819 
+			&& isset($_REQUEST['ee_cancel_payment'])
2820 
+			&& $payment->status() === EEM_Payment::status_id_failed
2821 
+		) {
2822 
+			$payment->set_status(EEM_Payment::status_id_cancelled);
2823 
+		}
2824 
+		return $payment;
2825 
+	}
2826 
+
2827 
+
2828 
+	/**
2829 
+	 *    get_transaction_details_for_gateways
2830 
+	 *
2831 
+	 * @access    public
2832 
+	 * @return int
2833 
+	 * @throws EE_Error
2834 
+	 * @throws InvalidArgumentException
2835 
+	 * @throws ReflectionException
2836 
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
2837 
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
2838 
+	 */
2839 
+	public function get_transaction_details_for_gateways()
2840 
+	{
2841 
+		$txn_details = array();
2842 
+		// ya gotta make a choice man
2843 
+		if (empty($this->checkout->selected_method_of_payment)) {
2844 
+			$txn_details = array(
2845 
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
2846 
+			);
2847 
+		}
2848 
+		// get EE_Payment_Method object
2849 
+		if (empty($txn_details)
2850 
+			&&
2851 
+			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
2852 
+		) {
2853 
+			$txn_details = array(
2854 
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
2855 
+				'error'                      => esc_html__(
2856 
+					'A valid Payment Method could not be determined.',
2857 
+					'event_espresso'
2858 
+				),
2859 
+			);
2860 
+		}
2861 
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
2862 
+			$return_url = $this->_get_return_url($this->checkout->payment_method);
2863 
+			$txn_details = array(
2864 
+				'TXN_ID'         => $this->checkout->transaction->ID(),
2865 
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
2866 
+				'TXN_total'      => $this->checkout->transaction->total(),
2867 
+				'TXN_paid'       => $this->checkout->transaction->paid(),
2868 
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
2869 
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
2870 
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
2871 
+				'payment_amount' => $this->checkout->amount_owing,
2872 
+				'return_url'     => $return_url,
2873 
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
2874 
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
2875 
+					array(
2876 
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
2877 
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
2878 
+					)
2879 
+				),
2880 
+			);
2881 
+		}
2882 
+		echo wp_json_encode($txn_details);
2883 
+		exit();
2884 
+	}
2885 
+
2886 
+
2887 
+	/**
2888 
+	 *    __sleep
2889 
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
2890 
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
2891 
+	 * reg form, because if needed, it will be regenerated anyways
2892 
+	 *
2893 
+	 * @return array
2894 
+	 */
2895 
+	public function __sleep()
2896 
+	{
2897 
+		// remove the reg form and the checkout
2898 
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
2899 
+	}
2900 2900 
 }
Please login to merge, or discard this patch.
core/domain/services/admin/ajax/WordpressHeartbeat.php 1 patch
Indentation   +41 added lines, -41 removed lines patch added patch discarded remove patch 
@@ -17,50 +17,50 @@
 
 block discarded – undo
17 17 
 class WordpressHeartbeat
18 18 
 {
19 19
20 
-    /**
21 
-     * @var LoaderInterface $loader
22 
-     */
23 
-    protected $loader;
20 
+	/**
21 
+	 * @var LoaderInterface $loader
22 
+	 */
23 
+	protected $loader;
24 24
25 
-    /**
26 
-     * @var RequestInterface $request
27 
-     */
28 
-    protected $request;
25 
+	/**
26 
+	 * @var RequestInterface $request
27 
+	 */
28 
+	protected $request;
29 29
30 30
31 
-    /**
32 
-     * WordpressHeartbeat constructor.
33 
-     *
34 
-     * @param LoaderInterface  $loader
35 
-     * @param RequestInterface $request
36 
-     */
37 
-    public function __construct(
38 
-        LoaderInterface $loader,
39 
-        RequestInterface $request
40 
-    ) {
41 
-        $this->loader = $loader;
42 
-        $this->request = $request;
43 
-        do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
44 
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
45 
-    }
31 
+	/**
32 
+	 * WordpressHeartbeat constructor.
33 
+	 *
34 
+	 * @param LoaderInterface  $loader
35 
+	 * @param RequestInterface $request
36 
+	 */
37 
+	public function __construct(
38 
+		LoaderInterface $loader,
39 
+		RequestInterface $request
40 
+	) {
41 
+		$this->loader = $loader;
42 
+		$this->request = $request;
43 
+		do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
44 
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
45 
+	}
46 46
47 47
48 
-    /**
49 
-     * @since $VID:$
50 
-     * @throws InvalidClassException
51 
-     */
52 
-    public function resolveRoutes()
53 
-    {
54 
-        $screenID = $this->request->getRequestParam('screen_id');
55 
-        $heartbeat_data = $this->request->getRequestParam('data', []);
56 
-        if ($screenID === 'espresso_events') {
57 
-            $this->loader->getShared(
58 
-                'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
59 
-            );
60 
-        } elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
61 
-            $this->loader->getShared(
62 
-                'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
63 
-            );
64 
-        }
65 
-    }
48 
+	/**
49 
+	 * @since $VID:$
50 
+	 * @throws InvalidClassException
51 
+	 */
52 
+	public function resolveRoutes()
53 
+	{
54 
+		$screenID = $this->request->getRequestParam('screen_id');
55 
+		$heartbeat_data = $this->request->getRequestParam('data', []);
56 
+		if ($screenID === 'espresso_events') {
57 
+			$this->loader->getShared(
58 
+				'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
59 
+			);
60 
+		} elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
61 
+			$this->loader->getShared(
62 
+				'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
63 
+			);
64 
+		}
65 
+	}
66 66 
 }
Please login to merge, or discard this patch.
core/domain/services/admin/ajax/EventEditorHeartbeat.php 2 patches
Indentation   +43 added lines, -43 removed lines patch added patch discarded remove patch 
@@ -16,52 +16,52 @@
 
 block discarded – undo
16 16 
 class EventEditorHeartbeat
17 17 
 {
18 18
19 
-    /**
20 
-     * @var Domain $domain
21 
-     */
22 
-    protected $domain;
19 
+	/**
20 
+	 * @var Domain $domain
21 
+	 */
22 
+	protected $domain;
23 23
24 
-    /**
25 
-     * @var EE_Environment_Config $environment
26 
-     */
27 
-    protected $environment;
24 
+	/**
25 
+	 * @var EE_Environment_Config $environment
26 
+	 */
27 
+	protected $environment;
28 28
29 29
30 
-    /**
31 
-     * EventEditorHeartbeat constructor.
32 
-     *
33 
-     * @param Domain                $domain
34 
-     * @param EE_Environment_Config $environment
35 
-     */
36 
-    public function __construct(Domain $domain, EE_Environment_Config $environment)
37 
-    {
38 
-        $this->domain = $domain;
39 
-        $this->environment = $environment;
40 
-        if ($this->domain->isCaffeinated()) {
41 
-            add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 2);
42 
-        }
43 
-    }
30 
+	/**
31 
+	 * EventEditorHeartbeat constructor.
32 
+	 *
33 
+	 * @param Domain                $domain
34 
+	 * @param EE_Environment_Config $environment
35 
+	 */
36 
+	public function __construct(Domain $domain, EE_Environment_Config $environment)
37 
+	{
38 
+		$this->domain = $domain;
39 
+		$this->environment = $environment;
40 
+		if ($this->domain->isCaffeinated()) {
41 
+			add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 2);
42 
+		}
43 
+	}
44 44
45 45
46 
-    /**
47 
-     * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
48 
-     * accordingly.
49 
-     *
50 
-     * @param array $response The existing heartbeat response array.
51 
-     * @param array $data     The incoming data package.
52 
-     * @return array  possibly appended response.
53 
-     */
54 
-    public function heartbeatResponse($response, $data)
55 
-    {
56 
-        /**
57 
-         * check whether count of tickets is approaching the potential
58 
-         * limits for the server.
59 
-         */
60 
-        if (! empty($data['input_count'])) {
61 
-            $response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check(
62 
-                $data['input_count']
63 
-            );
64 
-        }
65 
-        return $response;
66 
-    }
46 
+	/**
47 
+	 * This will be used to listen for any heartbeat data packages coming via the WordPress heartbeat API and handle
48 
+	 * accordingly.
49 
+	 *
50 
+	 * @param array $response The existing heartbeat response array.
51 
+	 * @param array $data     The incoming data package.
52 
+	 * @return array  possibly appended response.
53 
+	 */
54 
+	public function heartbeatResponse($response, $data)
55 
+	{
56 
+		/**
57 
+		 * check whether count of tickets is approaching the potential
58 
+		 * limits for the server.
59 
+		 */
60 
+		if (! empty($data['input_count'])) {
61 
+			$response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check(
62 
+				$data['input_count']
63 
+			);
64 
+		}
65 
+		return $response;
66 
+	}
67 67 
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch 
@@ -57,7 +57,7 @@
 
 block discarded – undo
57 57 
          * check whether count of tickets is approaching the potential
58 58 
          * limits for the server.
59 59 
          */
60 
-        if (! empty($data['input_count'])) {
60 
+        if ( ! empty($data['input_count'])) {
61 61 
             $response['max_input_vars_check'] = $this->environment->max_input_vars_limit_check(
62 62 
                 $data['input_count']
63 63 
             );
Please login to merge, or discard this patch.