@@ -459,7 +459,7 @@ discard block |
||
459 | 459 | * with construction finalize being called later |
460 | 460 | * (realizing that the subsections' html names |
461 | 461 | * might not be set yet, etc.) |
462 | - * @return EE_Form_Section_Base |
|
462 | + * @return EE_Form_Section_Validatable|null |
|
463 | 463 | * @throws EE_Error |
464 | 464 | */ |
465 | 465 | public function get_subsection($name, $require_construction_to_be_finalized = true) |
@@ -1289,7 +1289,6 @@ discard block |
||
1289 | 1289 | /** |
1290 | 1290 | * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
1291 | 1291 | * @param string $form_submission_error_message |
1292 | - * @param EE_Form_Section_Validatable $form_section unused |
|
1293 | 1292 | * @throws EE_Error |
1294 | 1293 | */ |
1295 | 1294 | public function set_submission_error_message( |
@@ -14,1504 +14,1504 @@ |
||
14 | 14 | class EE_Form_Section_Proper extends EE_Form_Section_Validatable |
15 | 15 | { |
16 | 16 | |
17 | - const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data'; |
|
18 | - |
|
19 | - /** |
|
20 | - * Subsections |
|
21 | - * |
|
22 | - * @var EE_Form_Section_Validatable[] |
|
23 | - */ |
|
24 | - protected $_subsections = array(); |
|
25 | - |
|
26 | - /** |
|
27 | - * Strategy for laying out the form |
|
28 | - * |
|
29 | - * @var EE_Form_Section_Layout_Base |
|
30 | - */ |
|
31 | - protected $_layout_strategy; |
|
32 | - |
|
33 | - /** |
|
34 | - * Whether or not this form has received and validated a form submission yet |
|
35 | - * |
|
36 | - * @var boolean |
|
37 | - */ |
|
38 | - protected $_received_submission = false; |
|
39 | - |
|
40 | - /** |
|
41 | - * message displayed to users upon successful form submission |
|
42 | - * |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - protected $_form_submission_success_message = ''; |
|
46 | - |
|
47 | - /** |
|
48 | - * message displayed to users upon unsuccessful form submission |
|
49 | - * |
|
50 | - * @var string |
|
51 | - */ |
|
52 | - protected $_form_submission_error_message = ''; |
|
53 | - |
|
54 | - /** |
|
55 | - * @var array like $_REQUEST |
|
56 | - */ |
|
57 | - protected $cached_request_data; |
|
58 | - |
|
59 | - /** |
|
60 | - * Stores whether this form (and its sub-sections) were found to be valid or not. |
|
61 | - * Starts off as null, but once the form is validated, it set to either true or false |
|
62 | - * @var boolean|null |
|
63 | - */ |
|
64 | - protected $is_valid; |
|
65 | - |
|
66 | - /** |
|
67 | - * Stores all the data that will localized for form validation |
|
68 | - * |
|
69 | - * @var array |
|
70 | - */ |
|
71 | - static protected $_js_localization = array(); |
|
72 | - |
|
73 | - /** |
|
74 | - * whether or not the form's localized validation JS vars have been set |
|
75 | - * |
|
76 | - * @type boolean |
|
77 | - */ |
|
78 | - static protected $_scripts_localized = false; |
|
79 | - |
|
80 | - |
|
81 | - /** |
|
82 | - * when constructing a proper form section, calls _construct_finalize on children |
|
83 | - * so that they know who their parent is, and what name they've been given. |
|
84 | - * |
|
85 | - * @param array[] $options_array { |
|
86 | - * @type $subsections EE_Form_Section_Validatable[] where keys are the section's name |
|
87 | - * @type $include string[] numerically-indexed where values are section names to be included, |
|
88 | - * and in that order. This is handy if you want |
|
89 | - * the subsections to be ordered differently than the default, and if you override |
|
90 | - * which fields are shown |
|
91 | - * @type $exclude string[] values are subsections to be excluded. This is handy if you want |
|
92 | - * to remove certain default subsections (note: if you specify BOTH 'include' AND |
|
93 | - * 'exclude', the inclusions will be applied first, and the exclusions will exclude |
|
94 | - * items from that list of inclusions) |
|
95 | - * @type $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form |
|
96 | - * } @see EE_Form_Section_Validatable::__construct() |
|
97 | - * @throws EE_Error |
|
98 | - */ |
|
99 | - public function __construct($options_array = array()) |
|
100 | - { |
|
101 | - $options_array = (array) apply_filters( |
|
102 | - 'FHEE__EE_Form_Section_Proper___construct__options_array', |
|
103 | - $options_array, |
|
104 | - $this |
|
105 | - ); |
|
106 | - //call parent first, as it may be setting the name |
|
107 | - parent::__construct($options_array); |
|
108 | - //if they've included subsections in the constructor, add them now |
|
109 | - if (isset($options_array['include'])) { |
|
110 | - //we are going to make sure we ONLY have those subsections to include |
|
111 | - //AND we are going to make sure they're in that specified order |
|
112 | - $reordered_subsections = array(); |
|
113 | - foreach ($options_array['include'] as $input_name) { |
|
114 | - if (isset($this->_subsections[ $input_name ])) { |
|
115 | - $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
116 | - } |
|
117 | - } |
|
118 | - $this->_subsections = $reordered_subsections; |
|
119 | - } |
|
120 | - if (isset($options_array['exclude'])) { |
|
121 | - $exclude = $options_array['exclude']; |
|
122 | - $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude)); |
|
123 | - } |
|
124 | - if (isset($options_array['layout_strategy'])) { |
|
125 | - $this->_layout_strategy = $options_array['layout_strategy']; |
|
126 | - } |
|
127 | - if (! $this->_layout_strategy) { |
|
128 | - $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
|
129 | - } |
|
130 | - $this->_layout_strategy->_construct_finalize($this); |
|
131 | - //ok so we are definitely going to want the forms JS, |
|
132 | - //so enqueue it or remember to enqueue it during wp_enqueue_scripts |
|
133 | - if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) { |
|
134 | - //ok so they've constructed this object after when they should have. |
|
135 | - //just enqueue the generic form scripts and initialize the form immediately in the JS |
|
136 | - EE_Form_Section_Proper::wp_enqueue_scripts(true); |
|
137 | - } else { |
|
138 | - add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
139 | - add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
140 | - } |
|
141 | - add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1); |
|
142 | - /** |
|
143 | - * Gives other plugins a chance to hook in before construct finalize is called. |
|
144 | - * The form probably doesn't yet have a parent form section. |
|
145 | - * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form, |
|
146 | - * assuming you don't care what the form section's name, HTML ID, or HTML name etc are. |
|
147 | - * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end |
|
148 | - * |
|
149 | - * @since 4.9.32 |
|
150 | - * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, |
|
151 | - * except maybe calling _construct_finalize has been done |
|
152 | - * @param array $options_array options passed into the constructor |
|
153 | - */ |
|
154 | - do_action( |
|
155 | - 'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', |
|
156 | - $this, |
|
157 | - $options_array |
|
158 | - ); |
|
159 | - if (isset($options_array['name'])) { |
|
160 | - $this->_construct_finalize(null, $options_array['name']); |
|
161 | - } |
|
162 | - } |
|
163 | - |
|
164 | - |
|
165 | - /** |
|
166 | - * Finishes construction given the parent form section and this form section's name |
|
167 | - * |
|
168 | - * @param EE_Form_Section_Proper $parent_form_section |
|
169 | - * @param string $name |
|
170 | - * @throws EE_Error |
|
171 | - */ |
|
172 | - public function _construct_finalize($parent_form_section, $name) |
|
173 | - { |
|
174 | - parent::_construct_finalize($parent_form_section, $name); |
|
175 | - $this->_set_default_name_if_empty(); |
|
176 | - $this->_set_default_html_id_if_empty(); |
|
177 | - foreach ($this->_subsections as $subsection_name => $subsection) { |
|
178 | - if ($subsection instanceof EE_Form_Section_Base) { |
|
179 | - $subsection->_construct_finalize($this, $subsection_name); |
|
180 | - } else { |
|
181 | - throw new EE_Error( |
|
182 | - sprintf( |
|
183 | - esc_html__( |
|
184 | - 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', |
|
185 | - 'event_espresso' |
|
186 | - ), |
|
187 | - $subsection_name, |
|
188 | - get_class($this), |
|
189 | - $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
190 | - ) |
|
191 | - ); |
|
192 | - } |
|
193 | - } |
|
194 | - /** |
|
195 | - * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed. |
|
196 | - * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID |
|
197 | - * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done. |
|
198 | - * This might only happen just before displaying the form, or just before it receives form submission data. |
|
199 | - * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've |
|
200 | - * ensured it has a name, HTML IDs, etc |
|
201 | - * |
|
202 | - * @param EE_Form_Section_Proper $this |
|
203 | - * @param EE_Form_Section_Proper|null $parent_form_section |
|
204 | - * @param string $name |
|
205 | - */ |
|
206 | - do_action( |
|
207 | - 'AHEE__EE_Form_Section_Proper___construct_finalize__end', |
|
208 | - $this, |
|
209 | - $parent_form_section, |
|
210 | - $name |
|
211 | - ); |
|
212 | - } |
|
213 | - |
|
214 | - |
|
215 | - /** |
|
216 | - * Gets the layout strategy for this form section |
|
217 | - * |
|
218 | - * @return EE_Form_Section_Layout_Base |
|
219 | - */ |
|
220 | - public function get_layout_strategy() |
|
221 | - { |
|
222 | - return $this->_layout_strategy; |
|
223 | - } |
|
224 | - |
|
225 | - |
|
226 | - /** |
|
227 | - * Gets the HTML for a single input for this form section according |
|
228 | - * to the layout strategy |
|
229 | - * |
|
230 | - * @param EE_Form_Input_Base $input |
|
231 | - * @return string |
|
232 | - */ |
|
233 | - public function get_html_for_input($input) |
|
234 | - { |
|
235 | - return $this->_layout_strategy->layout_input($input); |
|
236 | - } |
|
237 | - |
|
238 | - |
|
239 | - /** |
|
240 | - * was_submitted - checks if form inputs are present in request data |
|
241 | - * Basically an alias for form_data_present_in() (which is used by both |
|
242 | - * proper form sections and form inputs) |
|
243 | - * |
|
244 | - * @param null $form_data |
|
245 | - * @return boolean |
|
246 | - * @throws EE_Error |
|
247 | - */ |
|
248 | - public function was_submitted($form_data = null) |
|
249 | - { |
|
250 | - return $this->form_data_present_in($form_data); |
|
251 | - } |
|
252 | - |
|
253 | - /** |
|
254 | - * Gets the cached request data; but if there is none, or $req_data was set with |
|
255 | - * something different, refresh the cache, and then return it |
|
256 | - * @param null $req_data |
|
257 | - * @return array |
|
258 | - */ |
|
259 | - protected function getCachedRequest($req_data = null) |
|
260 | - { |
|
261 | - if ($this->cached_request_data === null |
|
262 | - || ( |
|
263 | - $req_data !== null && |
|
264 | - $req_data !== $this->cached_request_data |
|
265 | - ) |
|
266 | - ) { |
|
267 | - $req_data = apply_filters( |
|
268 | - 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', |
|
269 | - $req_data, |
|
270 | - $this |
|
271 | - ); |
|
272 | - if ($req_data === null) { |
|
273 | - $req_data = array_merge($_GET, $_POST); |
|
274 | - } |
|
275 | - $req_data = apply_filters( |
|
276 | - 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', |
|
277 | - $req_data, |
|
278 | - $this |
|
279 | - ); |
|
280 | - $this->cached_request_data = (array)$req_data; |
|
281 | - } |
|
282 | - return $this->cached_request_data; |
|
283 | - } |
|
284 | - |
|
285 | - |
|
286 | - /** |
|
287 | - * After the form section is initially created, call this to sanitize the data in the submission |
|
288 | - * which relates to this form section, validate it, and set it as properties on the form. |
|
289 | - * |
|
290 | - * @param array|null $req_data should usually be $_POST (the default). |
|
291 | - * However, you CAN supply a different array. |
|
292 | - * Consider using set_defaults() instead however. |
|
293 | - * (If you rendered the form in the page using echo $form_x->get_html() |
|
294 | - * the inputs will have the correct name in the request data for this function |
|
295 | - * to find them and populate the form with them. |
|
296 | - * If you have a flat form (with only input subsections), |
|
297 | - * you can supply a flat array where keys |
|
298 | - * are the form input names and values are their values) |
|
299 | - * @param boolean $validate whether or not to perform validation on this data. Default is, |
|
300 | - * of course, to validate that data, and set errors on the invalid values. |
|
301 | - * But if the data has already been validated |
|
302 | - * (eg you validated the data then stored it in the DB) |
|
303 | - * you may want to skip this step. |
|
304 | - * @throws InvalidArgumentException |
|
305 | - * @throws InvalidInterfaceException |
|
306 | - * @throws InvalidDataTypeException |
|
307 | - * @throws EE_Error |
|
308 | - */ |
|
309 | - public function receive_form_submission($req_data = null, $validate = true) |
|
310 | - { |
|
311 | - $req_data = $this->getCachedRequest($req_data); |
|
312 | - $this->_normalize($req_data); |
|
313 | - if ($validate) { |
|
314 | - $this->_validate(); |
|
315 | - //if it's invalid, we're going to want to re-display so remember what they submitted |
|
316 | - if (! $this->is_valid()) { |
|
317 | - $this->store_submitted_form_data_in_session(); |
|
318 | - } |
|
319 | - } |
|
320 | - if ($this->submission_error_message() === '' && ! $this->is_valid()) { |
|
321 | - $this->set_submission_error_message(); |
|
322 | - } |
|
323 | - do_action( |
|
324 | - 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', |
|
325 | - $req_data, |
|
326 | - $this, |
|
327 | - $validate |
|
328 | - ); |
|
329 | - } |
|
330 | - |
|
331 | - |
|
332 | - /** |
|
333 | - * caches the originally submitted input values in the session |
|
334 | - * so that they can be used to repopulate the form if it failed validation |
|
335 | - * |
|
336 | - * @return boolean whether or not the data was successfully stored in the session |
|
337 | - * @throws InvalidArgumentException |
|
338 | - * @throws InvalidInterfaceException |
|
339 | - * @throws InvalidDataTypeException |
|
340 | - * @throws EE_Error |
|
341 | - */ |
|
342 | - protected function store_submitted_form_data_in_session() |
|
343 | - { |
|
344 | - return EE_Registry::instance()->SSN->set_session_data( |
|
345 | - array( |
|
346 | - EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true), |
|
347 | - ) |
|
348 | - ); |
|
349 | - } |
|
350 | - |
|
351 | - |
|
352 | - /** |
|
353 | - * retrieves the originally submitted input values in the session |
|
354 | - * so that they can be used to repopulate the form if it failed validation |
|
355 | - * |
|
356 | - * @return array |
|
357 | - * @throws InvalidArgumentException |
|
358 | - * @throws InvalidInterfaceException |
|
359 | - * @throws InvalidDataTypeException |
|
360 | - */ |
|
361 | - protected function get_submitted_form_data_from_session() |
|
362 | - { |
|
363 | - $session = EE_Registry::instance()->SSN; |
|
364 | - if ($session instanceof EE_Session) { |
|
365 | - return $session->get_session_data( |
|
366 | - EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY |
|
367 | - ); |
|
368 | - } |
|
369 | - return array(); |
|
370 | - } |
|
371 | - |
|
372 | - |
|
373 | - /** |
|
374 | - * flushed the originally submitted input values from the session |
|
375 | - * |
|
376 | - * @return boolean whether or not the data was successfully removed from the session |
|
377 | - * @throws InvalidArgumentException |
|
378 | - * @throws InvalidInterfaceException |
|
379 | - * @throws InvalidDataTypeException |
|
380 | - */ |
|
381 | - protected function flush_submitted_form_data_from_session() |
|
382 | - { |
|
383 | - return EE_Registry::instance()->SSN->reset_data( |
|
384 | - array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY) |
|
385 | - ); |
|
386 | - } |
|
387 | - |
|
388 | - |
|
389 | - /** |
|
390 | - * Populates this form and its subsections with data from the session. |
|
391 | - * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows |
|
392 | - * validation errors when displaying too) |
|
393 | - * Returns true if the form was populated from the session, false otherwise |
|
394 | - * |
|
395 | - * @return boolean |
|
396 | - * @throws InvalidArgumentException |
|
397 | - * @throws InvalidInterfaceException |
|
398 | - * @throws InvalidDataTypeException |
|
399 | - * @throws EE_Error |
|
400 | - */ |
|
401 | - public function populate_from_session() |
|
402 | - { |
|
403 | - $form_data_in_session = $this->get_submitted_form_data_from_session(); |
|
404 | - if (empty($form_data_in_session)) { |
|
405 | - return false; |
|
406 | - } |
|
407 | - $this->receive_form_submission($form_data_in_session); |
|
408 | - $this->flush_submitted_form_data_from_session(); |
|
409 | - if ($this->form_data_present_in($form_data_in_session)) { |
|
410 | - return true; |
|
411 | - } |
|
412 | - return false; |
|
413 | - } |
|
414 | - |
|
415 | - |
|
416 | - /** |
|
417 | - * Populates the default data for the form, given an array where keys are |
|
418 | - * the input names, and values are their values (preferably normalized to be their |
|
419 | - * proper PHP types, not all strings... although that should be ok too). |
|
420 | - * Proper subsections are sub-arrays, the key being the subsection's name, and |
|
421 | - * the value being an array formatted in teh same way |
|
422 | - * |
|
423 | - * @param array $default_data |
|
424 | - * @throws EE_Error |
|
425 | - */ |
|
426 | - public function populate_defaults($default_data) |
|
427 | - { |
|
428 | - foreach ($this->subsections(false) as $subsection_name => $subsection) { |
|
429 | - if (isset($default_data[ $subsection_name ])) { |
|
430 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
431 | - $subsection->set_default($default_data[ $subsection_name ]); |
|
432 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
433 | - $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
434 | - } |
|
435 | - } |
|
436 | - } |
|
437 | - } |
|
438 | - |
|
439 | - |
|
440 | - /** |
|
441 | - * returns true if subsection exists |
|
442 | - * |
|
443 | - * @param string $name |
|
444 | - * @return boolean |
|
445 | - */ |
|
446 | - public function subsection_exists($name) |
|
447 | - { |
|
448 | - return isset($this->_subsections[ $name ]) ? true : false; |
|
449 | - } |
|
450 | - |
|
451 | - |
|
452 | - /** |
|
453 | - * Gets the subsection specified by its name |
|
454 | - * |
|
455 | - * @param string $name |
|
456 | - * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE |
|
457 | - * so that the inputs will be properly configured. |
|
458 | - * However, some client code may be ok |
|
459 | - * with construction finalize being called later |
|
460 | - * (realizing that the subsections' html names |
|
461 | - * might not be set yet, etc.) |
|
462 | - * @return EE_Form_Section_Base |
|
463 | - * @throws EE_Error |
|
464 | - */ |
|
465 | - public function get_subsection($name, $require_construction_to_be_finalized = true) |
|
466 | - { |
|
467 | - if ($require_construction_to_be_finalized) { |
|
468 | - $this->ensure_construct_finalized_called(); |
|
469 | - } |
|
470 | - return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
471 | - } |
|
472 | - |
|
473 | - |
|
474 | - /** |
|
475 | - * Gets all the validatable subsections of this form section |
|
476 | - * |
|
477 | - * @return EE_Form_Section_Validatable[] |
|
478 | - * @throws EE_Error |
|
479 | - */ |
|
480 | - public function get_validatable_subsections() |
|
481 | - { |
|
482 | - $validatable_subsections = array(); |
|
483 | - foreach ($this->subsections() as $name => $obj) { |
|
484 | - if ($obj instanceof EE_Form_Section_Validatable) { |
|
485 | - $validatable_subsections[ $name ] = $obj; |
|
486 | - } |
|
487 | - } |
|
488 | - return $validatable_subsections; |
|
489 | - } |
|
490 | - |
|
491 | - |
|
492 | - /** |
|
493 | - * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child, |
|
494 | - * throw an EE_Error. |
|
495 | - * |
|
496 | - * @param string $name |
|
497 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
498 | - * leave this as TRUE so that the inputs will be properly |
|
499 | - * configured. However, some client code may be ok with |
|
500 | - * construction finalize being called later |
|
501 | - * (realizing that the subsections' html names might not be |
|
502 | - * set yet, etc.) |
|
503 | - * @return EE_Form_Input_Base |
|
504 | - * @throws EE_Error |
|
505 | - */ |
|
506 | - public function get_input($name, $require_construction_to_be_finalized = true) |
|
507 | - { |
|
508 | - $subsection = $this->get_subsection( |
|
509 | - $name, |
|
510 | - $require_construction_to_be_finalized |
|
511 | - ); |
|
512 | - if (! $subsection instanceof EE_Form_Input_Base) { |
|
513 | - throw new EE_Error( |
|
514 | - sprintf( |
|
515 | - esc_html__( |
|
516 | - "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", |
|
517 | - 'event_espresso' |
|
518 | - ), |
|
519 | - $name, |
|
520 | - get_class($this), |
|
521 | - $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
522 | - ) |
|
523 | - ); |
|
524 | - } |
|
525 | - return $subsection; |
|
526 | - } |
|
527 | - |
|
528 | - |
|
529 | - /** |
|
530 | - * Like get_input(), gets the proper subsection of the form given the name, |
|
531 | - * otherwise throws an EE_Error |
|
532 | - * |
|
533 | - * @param string $name |
|
534 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
535 | - * leave this as TRUE so that the inputs will be properly |
|
536 | - * configured. However, some client code may be ok with |
|
537 | - * construction finalize being called later |
|
538 | - * (realizing that the subsections' html names might not be |
|
539 | - * set yet, etc.) |
|
540 | - * @return EE_Form_Section_Proper |
|
541 | - * @throws EE_Error |
|
542 | - */ |
|
543 | - public function get_proper_subsection($name, $require_construction_to_be_finalized = true) |
|
544 | - { |
|
545 | - $subsection = $this->get_subsection( |
|
546 | - $name, |
|
547 | - $require_construction_to_be_finalized |
|
548 | - ); |
|
549 | - if (! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | - throw new EE_Error( |
|
551 | - sprintf( |
|
552 | - esc_html__( |
|
553 | - "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", |
|
554 | - 'event_espresso' |
|
555 | - ), |
|
556 | - $name, |
|
557 | - get_class($this) |
|
558 | - ) |
|
559 | - ); |
|
560 | - } |
|
561 | - return $subsection; |
|
562 | - } |
|
563 | - |
|
564 | - |
|
565 | - /** |
|
566 | - * Gets the value of the specified input. Should be called after receive_form_submission() |
|
567 | - * or populate_defaults() on the form, where the normalized value on the input is set. |
|
568 | - * |
|
569 | - * @param string $name |
|
570 | - * @return mixed depending on the input's type and its normalization strategy |
|
571 | - * @throws EE_Error |
|
572 | - */ |
|
573 | - public function get_input_value($name) |
|
574 | - { |
|
575 | - $input = $this->get_input($name); |
|
576 | - return $input->normalized_value(); |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - /** |
|
581 | - * Checks if this form section itself is valid, and then checks its subsections |
|
582 | - * |
|
583 | - * @throws EE_Error |
|
584 | - * @return boolean |
|
585 | - */ |
|
586 | - public function is_valid() |
|
587 | - { |
|
588 | - if($this->is_valid === null) { |
|
589 | - if (! $this->has_received_submission()) { |
|
590 | - throw new EE_Error( |
|
591 | - sprintf( |
|
592 | - esc_html__( |
|
593 | - 'You cannot check if a form is valid before receiving the form submission using receive_form_submission', |
|
594 | - 'event_espresso' |
|
595 | - ) |
|
596 | - ) |
|
597 | - ); |
|
598 | - } |
|
599 | - if (! parent::is_valid()) { |
|
600 | - $this->is_valid = false; |
|
601 | - } else { |
|
602 | - // ok so no general errors to this entire form section. |
|
603 | - // so let's check the subsections, but only set errors if that hasn't been done yet |
|
604 | - $this->is_valid = true; |
|
605 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
606 | - if (! $subsection->is_valid()) { |
|
607 | - $this->is_valid = false; |
|
608 | - } |
|
609 | - } |
|
610 | - } |
|
611 | - } |
|
612 | - return $this->is_valid; |
|
613 | - } |
|
614 | - |
|
615 | - |
|
616 | - /** |
|
617 | - * gets the default name of this form section if none is specified |
|
618 | - * |
|
619 | - * @return void |
|
620 | - */ |
|
621 | - protected function _set_default_name_if_empty() |
|
622 | - { |
|
623 | - if (! $this->_name) { |
|
624 | - $classname = get_class($this); |
|
625 | - $default_name = str_replace('EE_', '', $classname); |
|
626 | - $this->_name = $default_name; |
|
627 | - } |
|
628 | - } |
|
629 | - |
|
630 | - |
|
631 | - /** |
|
632 | - * Returns the HTML for the form, except for the form opening and closing tags |
|
633 | - * (as the form section doesn't know where you necessarily want to send the information to), |
|
634 | - * and except for a submit button. Enqueues JS and CSS; if called early enough we will |
|
635 | - * try to enqueue them in the header, otherwise they'll be enqueued in the footer. |
|
636 | - * Not doing_it_wrong because theoretically this CAN be used properly, |
|
637 | - * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue |
|
638 | - * any CSS. |
|
639 | - * |
|
640 | - * @throws InvalidArgumentException |
|
641 | - * @throws InvalidInterfaceException |
|
642 | - * @throws InvalidDataTypeException |
|
643 | - * @throws EE_Error |
|
644 | - */ |
|
645 | - public function get_html_and_js() |
|
646 | - { |
|
647 | - $this->enqueue_js(); |
|
648 | - return $this->get_html(); |
|
649 | - } |
|
650 | - |
|
651 | - |
|
652 | - /** |
|
653 | - * returns HTML for displaying this form section. recursively calls display_section() on all subsections |
|
654 | - * |
|
655 | - * @param bool $display_previously_submitted_data |
|
656 | - * @return string |
|
657 | - * @throws InvalidArgumentException |
|
658 | - * @throws InvalidInterfaceException |
|
659 | - * @throws InvalidDataTypeException |
|
660 | - * @throws EE_Error |
|
661 | - * @throws EE_Error |
|
662 | - * @throws EE_Error |
|
663 | - */ |
|
664 | - public function get_html($display_previously_submitted_data = true) |
|
665 | - { |
|
666 | - $this->ensure_construct_finalized_called(); |
|
667 | - if ($display_previously_submitted_data) { |
|
668 | - $this->populate_from_session(); |
|
669 | - } |
|
670 | - return $this->_form_html_filter |
|
671 | - ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this) |
|
672 | - : $this->_layout_strategy->layout_form(); |
|
673 | - } |
|
674 | - |
|
675 | - |
|
676 | - /** |
|
677 | - * enqueues JS and CSS for the form. |
|
678 | - * It is preferred to call this before wp_enqueue_scripts so the |
|
679 | - * scripts and styles can be put in the header, but if called later |
|
680 | - * they will be put in the footer (which is OK for JS, but in HTML4 CSS should |
|
681 | - * only be in the header; but in HTML5 its ok in the body. |
|
682 | - * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag. |
|
683 | - * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.) |
|
684 | - * |
|
685 | - * @return void |
|
686 | - * @throws EE_Error |
|
687 | - */ |
|
688 | - public function enqueue_js() |
|
689 | - { |
|
690 | - $this->_enqueue_and_localize_form_js(); |
|
691 | - foreach ($this->subsections() as $subsection) { |
|
692 | - $subsection->enqueue_js(); |
|
693 | - } |
|
694 | - } |
|
695 | - |
|
696 | - |
|
697 | - /** |
|
698 | - * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts(). |
|
699 | - * This must be done BEFORE wp_enqueue_scripts() gets called, which is on |
|
700 | - * the wp_enqueue_scripts hook. |
|
701 | - * However, registering the form js and localizing it can happen when we |
|
702 | - * actually output the form (which is preferred, seeing how teh form's fields |
|
703 | - * could change until it's actually outputted) |
|
704 | - * |
|
705 | - * @param boolean $init_form_validation_automatically whether or not we want the form validation |
|
706 | - * to be triggered automatically or not |
|
707 | - * @return void |
|
708 | - */ |
|
709 | - public static function wp_enqueue_scripts($init_form_validation_automatically = true) |
|
710 | - { |
|
711 | - wp_register_script( |
|
712 | - 'ee_form_section_validation', |
|
713 | - EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js', |
|
714 | - array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
|
715 | - EVENT_ESPRESSO_VERSION, |
|
716 | - true |
|
717 | - ); |
|
718 | - wp_localize_script( |
|
719 | - 'ee_form_section_validation', |
|
720 | - 'ee_form_section_validation_init', |
|
721 | - array('init' => $init_form_validation_automatically ? '1' : '0') |
|
722 | - ); |
|
723 | - } |
|
724 | - |
|
725 | - |
|
726 | - /** |
|
727 | - * gets the variables used by form_section_validation.js. |
|
728 | - * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script, |
|
729 | - * but before the wordpress hook wp_loaded |
|
730 | - * |
|
731 | - * @throws EE_Error |
|
732 | - */ |
|
733 | - public function _enqueue_and_localize_form_js() |
|
734 | - { |
|
735 | - $this->ensure_construct_finalized_called(); |
|
736 | - //actually, we don't want to localize just yet. There may be other forms on the page. |
|
737 | - //so we need to add our form section data to a static variable accessible by all form sections |
|
738 | - //and localize it just before the footer |
|
739 | - $this->localize_validation_rules(); |
|
740 | - add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2); |
|
741 | - add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms')); |
|
742 | - } |
|
743 | - |
|
744 | - |
|
745 | - /** |
|
746 | - * add our form section data to a static variable accessible by all form sections |
|
747 | - * |
|
748 | - * @param bool $return_for_subsection |
|
749 | - * @return void |
|
750 | - * @throws EE_Error |
|
751 | - */ |
|
752 | - public function localize_validation_rules($return_for_subsection = false) |
|
753 | - { |
|
754 | - // we only want to localize vars ONCE for the entire form, |
|
755 | - // so if the form section doesn't have a parent, then it must be the top dog |
|
756 | - if ($return_for_subsection || ! $this->parent_section()) { |
|
757 | - EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
758 | - 'form_section_id' => $this->html_id(true), |
|
759 | - 'validation_rules' => $this->get_jquery_validation_rules(), |
|
760 | - 'other_data' => $this->get_other_js_data(), |
|
761 | - 'errors' => $this->subsection_validation_errors_by_html_name(), |
|
762 | - ); |
|
763 | - EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | - } |
|
765 | - } |
|
766 | - |
|
767 | - |
|
768 | - /** |
|
769 | - * Gets an array of extra data that will be useful for client-side javascript. |
|
770 | - * This is primarily data added by inputs and forms in addition to any |
|
771 | - * scripts they might enqueue |
|
772 | - * |
|
773 | - * @param array $form_other_js_data |
|
774 | - * @return array |
|
775 | - * @throws EE_Error |
|
776 | - */ |
|
777 | - public function get_other_js_data($form_other_js_data = array()) |
|
778 | - { |
|
779 | - foreach ($this->subsections() as $subsection) { |
|
780 | - $form_other_js_data = $subsection->get_other_js_data($form_other_js_data); |
|
781 | - } |
|
782 | - return $form_other_js_data; |
|
783 | - } |
|
784 | - |
|
785 | - |
|
786 | - /** |
|
787 | - * Gets a flat array of inputs for this form section and its subsections. |
|
788 | - * Keys are their form names, and values are the inputs themselves |
|
789 | - * |
|
790 | - * @return EE_Form_Input_Base |
|
791 | - * @throws EE_Error |
|
792 | - */ |
|
793 | - public function inputs_in_subsections() |
|
794 | - { |
|
795 | - $inputs = array(); |
|
796 | - foreach ($this->subsections() as $subsection) { |
|
797 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
798 | - $inputs[ $subsection->html_name() ] = $subsection; |
|
799 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
800 | - $inputs += $subsection->inputs_in_subsections(); |
|
801 | - } |
|
802 | - } |
|
803 | - return $inputs; |
|
804 | - } |
|
805 | - |
|
806 | - |
|
807 | - /** |
|
808 | - * Gets a flat array of all the validation errors. |
|
809 | - * Keys are html names (because those should be unique) |
|
810 | - * and values are a string of all their validation errors |
|
811 | - * |
|
812 | - * @return string[] |
|
813 | - * @throws EE_Error |
|
814 | - */ |
|
815 | - public function subsection_validation_errors_by_html_name() |
|
816 | - { |
|
817 | - $inputs = $this->inputs(); |
|
818 | - $errors = array(); |
|
819 | - foreach ($inputs as $form_input) { |
|
820 | - if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
|
821 | - $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
822 | - } |
|
823 | - } |
|
824 | - return $errors; |
|
825 | - } |
|
826 | - |
|
827 | - |
|
828 | - /** |
|
829 | - * passes all the form data required by the JS to the JS, and enqueues the few required JS files. |
|
830 | - * Should be setup by each form during the _enqueues_and_localize_form_js |
|
831 | - * |
|
832 | - * @throws InvalidArgumentException |
|
833 | - * @throws InvalidInterfaceException |
|
834 | - * @throws InvalidDataTypeException |
|
835 | - */ |
|
836 | - public static function localize_script_for_all_forms() |
|
837 | - { |
|
838 | - //allow inputs and stuff to hook in their JS and stuff here |
|
839 | - do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin'); |
|
840 | - EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages(); |
|
841 | - $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
|
842 | - ? EE_Registry::instance()->CFG->registration->email_validation_level |
|
843 | - : 'wp_default'; |
|
844 | - EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | - wp_enqueue_script('ee_form_section_validation'); |
|
846 | - wp_localize_script( |
|
847 | - 'ee_form_section_validation', |
|
848 | - 'ee_form_section_vars', |
|
849 | - EE_Form_Section_Proper::$_js_localization |
|
850 | - ); |
|
851 | - } |
|
852 | - |
|
853 | - |
|
854 | - /** |
|
855 | - * ensure_scripts_localized |
|
856 | - * |
|
857 | - * @throws EE_Error |
|
858 | - */ |
|
859 | - public function ensure_scripts_localized() |
|
860 | - { |
|
861 | - if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | - $this->_enqueue_and_localize_form_js(); |
|
863 | - } |
|
864 | - } |
|
865 | - |
|
866 | - |
|
867 | - /** |
|
868 | - * Gets the hard-coded validation error messages to be used in the JS. The convention |
|
869 | - * is that the key here should be the same as the custom validation rule put in the JS file |
|
870 | - * |
|
871 | - * @return array keys are custom validation rules, and values are internationalized strings |
|
872 | - */ |
|
873 | - private static function _get_localized_error_messages() |
|
874 | - { |
|
875 | - return array( |
|
876 | - 'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'), |
|
877 | - 'regex' => esc_html__('Please check your input', 'event_espresso'), |
|
878 | - ); |
|
879 | - } |
|
880 | - |
|
881 | - |
|
882 | - /** |
|
883 | - * @return array |
|
884 | - */ |
|
885 | - public static function js_localization() |
|
886 | - { |
|
887 | - return self::$_js_localization; |
|
888 | - } |
|
889 | - |
|
890 | - |
|
891 | - /** |
|
892 | - * @return void |
|
893 | - */ |
|
894 | - public static function reset_js_localization() |
|
895 | - { |
|
896 | - self::$_js_localization = array(); |
|
897 | - } |
|
898 | - |
|
899 | - |
|
900 | - /** |
|
901 | - * Gets the JS to put inside the jquery validation rules for subsection of this form section. |
|
902 | - * See parent function for more... |
|
903 | - * |
|
904 | - * @return array |
|
905 | - * @throws EE_Error |
|
906 | - */ |
|
907 | - public function get_jquery_validation_rules() |
|
908 | - { |
|
909 | - $jquery_validation_rules = array(); |
|
910 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
911 | - $jquery_validation_rules = array_merge( |
|
912 | - $jquery_validation_rules, |
|
913 | - $subsection->get_jquery_validation_rules() |
|
914 | - ); |
|
915 | - } |
|
916 | - return $jquery_validation_rules; |
|
917 | - } |
|
918 | - |
|
919 | - |
|
920 | - /** |
|
921 | - * Sanitizes all the data and sets the sanitized value of each field |
|
922 | - * |
|
923 | - * @param array $req_data like $_POST |
|
924 | - * @return void |
|
925 | - * @throws EE_Error |
|
926 | - */ |
|
927 | - protected function _normalize($req_data) |
|
928 | - { |
|
929 | - $this->_received_submission = true; |
|
930 | - $this->_validation_errors = array(); |
|
931 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
932 | - try { |
|
933 | - $subsection->_normalize($req_data); |
|
934 | - } catch (EE_Validation_Error $e) { |
|
935 | - $subsection->add_validation_error($e); |
|
936 | - } |
|
937 | - } |
|
938 | - } |
|
939 | - |
|
940 | - |
|
941 | - /** |
|
942 | - * Performs validation on this form section and its subsections. |
|
943 | - * For each subsection, |
|
944 | - * calls _validate_{subsection_name} on THIS form (if the function exists) |
|
945 | - * and passes it the subsection, then calls _validate on that subsection. |
|
946 | - * If you need to perform validation on the form as a whole (considering multiple) |
|
947 | - * you would be best to override this _validate method, |
|
948 | - * calling parent::_validate() first. |
|
949 | - * |
|
950 | - * @throws EE_Error |
|
951 | - */ |
|
952 | - protected function _validate() |
|
953 | - { |
|
954 | - //reset the cache of whether this form is valid or not- we're re-validating it now |
|
955 | - $this->is_valid = null; |
|
956 | - foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
|
957 | - if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | - call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
959 | - } |
|
960 | - $subsection->_validate(); |
|
961 | - } |
|
962 | - } |
|
963 | - |
|
964 | - |
|
965 | - /** |
|
966 | - * Gets all the validated inputs for the form section |
|
967 | - * |
|
968 | - * @return array |
|
969 | - * @throws EE_Error |
|
970 | - */ |
|
971 | - public function valid_data() |
|
972 | - { |
|
973 | - $inputs = array(); |
|
974 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
975 | - if ($subsection instanceof EE_Form_Section_Proper) { |
|
976 | - $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
977 | - } elseif ($subsection instanceof EE_Form_Input_Base) { |
|
978 | - $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
979 | - } |
|
980 | - } |
|
981 | - return $inputs; |
|
982 | - } |
|
983 | - |
|
984 | - |
|
985 | - /** |
|
986 | - * Gets all the inputs on this form section |
|
987 | - * |
|
988 | - * @return EE_Form_Input_Base[] |
|
989 | - * @throws EE_Error |
|
990 | - */ |
|
991 | - public function inputs() |
|
992 | - { |
|
993 | - $inputs = array(); |
|
994 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
995 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
996 | - $inputs[ $subsection_name ] = $subsection; |
|
997 | - } |
|
998 | - } |
|
999 | - return $inputs; |
|
1000 | - } |
|
1001 | - |
|
1002 | - |
|
1003 | - /** |
|
1004 | - * Gets all the subsections which are a proper form |
|
1005 | - * |
|
1006 | - * @return EE_Form_Section_Proper[] |
|
1007 | - * @throws EE_Error |
|
1008 | - */ |
|
1009 | - public function subforms() |
|
1010 | - { |
|
1011 | - $form_sections = array(); |
|
1012 | - foreach ($this->subsections() as $name => $obj) { |
|
1013 | - if ($obj instanceof EE_Form_Section_Proper) { |
|
1014 | - $form_sections[ $name ] = $obj; |
|
1015 | - } |
|
1016 | - } |
|
1017 | - return $form_sections; |
|
1018 | - } |
|
1019 | - |
|
1020 | - |
|
1021 | - /** |
|
1022 | - * Gets all the subsections (inputs, proper subsections, or html-only sections). |
|
1023 | - * Consider using inputs() or subforms() |
|
1024 | - * if you only want form inputs or proper form sections. |
|
1025 | - * |
|
1026 | - * @param boolean $require_construction_to_be_finalized most client code should |
|
1027 | - * leave this as TRUE so that the inputs will be properly |
|
1028 | - * configured. However, some client code may be ok with |
|
1029 | - * construction finalize being called later |
|
1030 | - * (realizing that the subsections' html names might not be |
|
1031 | - * set yet, etc.) |
|
1032 | - * @return EE_Form_Section_Proper[] |
|
1033 | - * @throws EE_Error |
|
1034 | - */ |
|
1035 | - public function subsections($require_construction_to_be_finalized = true) |
|
1036 | - { |
|
1037 | - if ($require_construction_to_be_finalized) { |
|
1038 | - $this->ensure_construct_finalized_called(); |
|
1039 | - } |
|
1040 | - return $this->_subsections; |
|
1041 | - } |
|
1042 | - |
|
1043 | - |
|
1044 | - /** |
|
1045 | - * Returns whether this form has any subforms or inputs |
|
1046 | - * @return bool |
|
1047 | - */ |
|
1048 | - public function hasSubsections() |
|
1049 | - { |
|
1050 | - return ! empty($this->_subsections); |
|
1051 | - } |
|
1052 | - |
|
1053 | - |
|
1054 | - /** |
|
1055 | - * Returns a simple array where keys are input names, and values are their normalized |
|
1056 | - * values. (Similar to calling get_input_value on inputs) |
|
1057 | - * |
|
1058 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1059 | - * or just this forms' direct children inputs |
|
1060 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1061 | - * or allow multidimensional array |
|
1062 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1063 | - * with array keys being input names |
|
1064 | - * (regardless of whether they are from a subsection or not), |
|
1065 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1066 | - * where keys are always subsection names and values are either |
|
1067 | - * the input's normalized value, or an array like the top-level array |
|
1068 | - * @throws EE_Error |
|
1069 | - */ |
|
1070 | - public function input_values($include_subform_inputs = false, $flatten = false) |
|
1071 | - { |
|
1072 | - return $this->_input_values(false, $include_subform_inputs, $flatten); |
|
1073 | - } |
|
1074 | - |
|
1075 | - |
|
1076 | - /** |
|
1077 | - * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value' |
|
1078 | - * of each input. On some inputs (especially radio boxes or checkboxes), the value stored |
|
1079 | - * is not necessarily the value we want to display to users. This creates an array |
|
1080 | - * where keys are the input names, and values are their display values |
|
1081 | - * |
|
1082 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1083 | - * or just this forms' direct children inputs |
|
1084 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1085 | - * or allow multidimensional array |
|
1086 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1087 | - * with array keys being input names |
|
1088 | - * (regardless of whether they are from a subsection or not), |
|
1089 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1090 | - * where keys are always subsection names and values are either |
|
1091 | - * the input's normalized value, or an array like the top-level array |
|
1092 | - * @throws EE_Error |
|
1093 | - */ |
|
1094 | - public function input_pretty_values($include_subform_inputs = false, $flatten = false) |
|
1095 | - { |
|
1096 | - return $this->_input_values(true, $include_subform_inputs, $flatten); |
|
1097 | - } |
|
1098 | - |
|
1099 | - |
|
1100 | - /** |
|
1101 | - * Gets the input values from the form |
|
1102 | - * |
|
1103 | - * @param boolean $pretty Whether to retrieve the pretty value, |
|
1104 | - * or just the normalized value |
|
1105 | - * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1106 | - * or just this forms' direct children inputs |
|
1107 | - * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1108 | - * or allow multidimensional array |
|
1109 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being |
|
1110 | - * input names (regardless of whether they are from a subsection or not), |
|
1111 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1112 | - * where keys are always subsection names and values are either |
|
1113 | - * the input's normalized value, or an array like the top-level array |
|
1114 | - * @throws EE_Error |
|
1115 | - */ |
|
1116 | - public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) |
|
1117 | - { |
|
1118 | - $input_values = array(); |
|
1119 | - foreach ($this->subsections() as $subsection_name => $subsection) { |
|
1120 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1121 | - $input_values[ $subsection_name ] = $pretty |
|
1122 | - ? $subsection->pretty_value() |
|
1123 | - : $subsection->normalized_value(); |
|
1124 | - } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
|
1125 | - $subform_input_values = $subsection->_input_values( |
|
1126 | - $pretty, |
|
1127 | - $include_subform_inputs, |
|
1128 | - $flatten |
|
1129 | - ); |
|
1130 | - if ($flatten) { |
|
1131 | - $input_values = array_merge($input_values, $subform_input_values); |
|
1132 | - } else { |
|
1133 | - $input_values[ $subsection_name ] = $subform_input_values; |
|
1134 | - } |
|
1135 | - } |
|
1136 | - } |
|
1137 | - return $input_values; |
|
1138 | - } |
|
1139 | - |
|
1140 | - |
|
1141 | - /** |
|
1142 | - * Gets the originally submitted input values from the form |
|
1143 | - * |
|
1144 | - * @param boolean $include_subforms Whether to include inputs from subforms, |
|
1145 | - * or just this forms' direct children inputs |
|
1146 | - * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1147 | - * with array keys being input names |
|
1148 | - * (regardless of whether they are from a subsection or not), |
|
1149 | - * and if $flatten is FALSE it can be a multidimensional array |
|
1150 | - * where keys are always subsection names and values are either |
|
1151 | - * the input's normalized value, or an array like the top-level array |
|
1152 | - * @throws EE_Error |
|
1153 | - */ |
|
1154 | - public function submitted_values($include_subforms = false) |
|
1155 | - { |
|
1156 | - $submitted_values = array(); |
|
1157 | - foreach ($this->subsections() as $subsection) { |
|
1158 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1159 | - // is this input part of an array of inputs? |
|
1160 | - if (strpos($subsection->html_name(), '[') !== false) { |
|
1161 | - $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | - explode( |
|
1163 | - '[', |
|
1164 | - str_replace(']', '', $subsection->html_name()) |
|
1165 | - ), |
|
1166 | - $subsection->raw_value() |
|
1167 | - ); |
|
1168 | - $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
|
1169 | - } else { |
|
1170 | - $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1171 | - } |
|
1172 | - } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
|
1173 | - $subform_input_values = $subsection->submitted_values($include_subforms); |
|
1174 | - $submitted_values = array_replace_recursive($submitted_values, $subform_input_values); |
|
1175 | - } |
|
1176 | - } |
|
1177 | - return $submitted_values; |
|
1178 | - } |
|
1179 | - |
|
1180 | - |
|
1181 | - /** |
|
1182 | - * Indicates whether or not this form has received a submission yet |
|
1183 | - * (ie, had receive_form_submission called on it yet) |
|
1184 | - * |
|
1185 | - * @return boolean |
|
1186 | - * @throws EE_Error |
|
1187 | - */ |
|
1188 | - public function has_received_submission() |
|
1189 | - { |
|
1190 | - $this->ensure_construct_finalized_called(); |
|
1191 | - return $this->_received_submission; |
|
1192 | - } |
|
1193 | - |
|
1194 | - |
|
1195 | - /** |
|
1196 | - * Equivalent to passing 'exclude' in the constructor's options array. |
|
1197 | - * Removes the listed inputs from the form |
|
1198 | - * |
|
1199 | - * @param array $inputs_to_exclude values are the input names |
|
1200 | - * @return void |
|
1201 | - */ |
|
1202 | - public function exclude(array $inputs_to_exclude = array()) |
|
1203 | - { |
|
1204 | - foreach ($inputs_to_exclude as $input_to_exclude_name) { |
|
1205 | - unset($this->_subsections[ $input_to_exclude_name ]); |
|
1206 | - } |
|
1207 | - } |
|
1208 | - |
|
1209 | - |
|
1210 | - /** |
|
1211 | - * @param array $inputs_to_hide |
|
1212 | - * @throws EE_Error |
|
1213 | - */ |
|
1214 | - public function hide(array $inputs_to_hide = array()) |
|
1215 | - { |
|
1216 | - foreach ($inputs_to_hide as $input_to_hide) { |
|
1217 | - $input = $this->get_input($input_to_hide); |
|
1218 | - $input->set_display_strategy(new EE_Hidden_Display_Strategy()); |
|
1219 | - } |
|
1220 | - } |
|
1221 | - |
|
1222 | - |
|
1223 | - /** |
|
1224 | - * add_subsections |
|
1225 | - * Adds the listed subsections to the form section. |
|
1226 | - * If $subsection_name_to_target is provided, |
|
1227 | - * then new subsections are added before or after that subsection, |
|
1228 | - * otherwise to the start or end of the entire subsections array. |
|
1229 | - * |
|
1230 | - * @param EE_Form_Section_Base[] $new_subsections array of new form subsections |
|
1231 | - * where keys are their names |
|
1232 | - * @param string $subsection_name_to_target an existing for section that $new_subsections |
|
1233 | - * should be added before or after |
|
1234 | - * IF $subsection_name_to_target is null, |
|
1235 | - * then $new_subsections will be added to |
|
1236 | - * the beginning or end of the entire subsections array |
|
1237 | - * @param boolean $add_before whether to add $new_subsections, before or after |
|
1238 | - * $subsection_name_to_target, |
|
1239 | - * or if $subsection_name_to_target is null, |
|
1240 | - * before or after entire subsections array |
|
1241 | - * @return void |
|
1242 | - * @throws EE_Error |
|
1243 | - */ |
|
1244 | - public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
|
1245 | - { |
|
1246 | - foreach ($new_subsections as $subsection_name => $subsection) { |
|
1247 | - if (! $subsection instanceof EE_Form_Section_Base) { |
|
1248 | - EE_Error::add_error( |
|
1249 | - sprintf( |
|
1250 | - esc_html__( |
|
1251 | - "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", |
|
1252 | - 'event_espresso' |
|
1253 | - ), |
|
1254 | - get_class($subsection), |
|
1255 | - $subsection_name, |
|
1256 | - $this->name() |
|
1257 | - ) |
|
1258 | - ); |
|
1259 | - unset($new_subsections[ $subsection_name ]); |
|
1260 | - } |
|
1261 | - } |
|
1262 | - $this->_subsections = EEH_Array::insert_into_array( |
|
1263 | - $this->_subsections, |
|
1264 | - $new_subsections, |
|
1265 | - $subsection_name_to_target, |
|
1266 | - $add_before |
|
1267 | - ); |
|
1268 | - if ($this->_construction_finalized) { |
|
1269 | - foreach ($this->_subsections as $name => $subsection) { |
|
1270 | - $subsection->_construct_finalize($this, $name); |
|
1271 | - } |
|
1272 | - } |
|
1273 | - } |
|
1274 | - |
|
1275 | - |
|
1276 | - /** |
|
1277 | - * Just gets all validatable subsections to clean their sensitive data |
|
1278 | - * |
|
1279 | - * @throws EE_Error |
|
1280 | - */ |
|
1281 | - public function clean_sensitive_data() |
|
1282 | - { |
|
1283 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
1284 | - $subsection->clean_sensitive_data(); |
|
1285 | - } |
|
1286 | - } |
|
1287 | - |
|
1288 | - |
|
1289 | - /** |
|
1290 | - * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
|
1291 | - * @param string $form_submission_error_message |
|
1292 | - * @param EE_Form_Section_Validatable $form_section unused |
|
1293 | - * @throws EE_Error |
|
1294 | - */ |
|
1295 | - public function set_submission_error_message( |
|
1296 | - $form_submission_error_message = '' |
|
1297 | - ) { |
|
1298 | - $this->_form_submission_error_message = ! empty($form_submission_error_message) |
|
1299 | - ? $form_submission_error_message |
|
1300 | - : $this->getValidationErrorsAccumulatedString(); |
|
1301 | - } |
|
1302 | - |
|
1303 | - |
|
1304 | - /** |
|
1305 | - * Returns the cached error message. A default value is set for this during _validate(), |
|
1306 | - * (called during receive_form_submission) but it can be explicitly set using |
|
1307 | - * set_submission_error_message |
|
1308 | - * |
|
1309 | - * @return string |
|
1310 | - */ |
|
1311 | - public function submission_error_message() |
|
1312 | - { |
|
1313 | - return $this->_form_submission_error_message; |
|
1314 | - } |
|
1315 | - |
|
1316 | - |
|
1317 | - /** |
|
1318 | - * Sets a message to display if the data submitted to the form was valid. |
|
1319 | - * @param string $form_submission_success_message |
|
1320 | - */ |
|
1321 | - public function set_submission_success_message($form_submission_success_message = '') |
|
1322 | - { |
|
1323 | - $this->_form_submission_success_message = ! empty($form_submission_success_message) |
|
1324 | - ? $form_submission_success_message |
|
1325 | - : esc_html__('Form submitted successfully', 'event_espresso'); |
|
1326 | - } |
|
1327 | - |
|
1328 | - |
|
1329 | - /** |
|
1330 | - * Gets a message appropriate for display when the form is correctly submitted |
|
1331 | - * @return string |
|
1332 | - */ |
|
1333 | - public function submission_success_message() |
|
1334 | - { |
|
1335 | - return $this->_form_submission_success_message; |
|
1336 | - } |
|
1337 | - |
|
1338 | - |
|
1339 | - /** |
|
1340 | - * Returns the prefix that should be used on child of this form section for |
|
1341 | - * their html names. If this form section itself has a parent, prepends ITS |
|
1342 | - * prefix onto this form section's prefix. Used primarily by |
|
1343 | - * EE_Form_Input_Base::_set_default_html_name_if_empty |
|
1344 | - * |
|
1345 | - * @return string |
|
1346 | - * @throws EE_Error |
|
1347 | - */ |
|
1348 | - public function html_name_prefix() |
|
1349 | - { |
|
1350 | - if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
|
1351 | - return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1352 | - } |
|
1353 | - return $this->name(); |
|
1354 | - } |
|
1355 | - |
|
1356 | - |
|
1357 | - /** |
|
1358 | - * Gets the name, but first checks _construct_finalize has been called. If not, |
|
1359 | - * calls it (assumes there is no parent and that we want the name to be whatever |
|
1360 | - * was set, which is probably nothing, or the classname) |
|
1361 | - * |
|
1362 | - * @return string |
|
1363 | - * @throws EE_Error |
|
1364 | - */ |
|
1365 | - public function name() |
|
1366 | - { |
|
1367 | - $this->ensure_construct_finalized_called(); |
|
1368 | - return parent::name(); |
|
1369 | - } |
|
1370 | - |
|
1371 | - |
|
1372 | - /** |
|
1373 | - * @return EE_Form_Section_Proper |
|
1374 | - * @throws EE_Error |
|
1375 | - */ |
|
1376 | - public function parent_section() |
|
1377 | - { |
|
1378 | - $this->ensure_construct_finalized_called(); |
|
1379 | - return parent::parent_section(); |
|
1380 | - } |
|
1381 | - |
|
1382 | - |
|
1383 | - /** |
|
1384 | - * make sure construction finalized was called, otherwise children might not be ready |
|
1385 | - * |
|
1386 | - * @return void |
|
1387 | - * @throws EE_Error |
|
1388 | - */ |
|
1389 | - public function ensure_construct_finalized_called() |
|
1390 | - { |
|
1391 | - if (! $this->_construction_finalized) { |
|
1392 | - $this->_construct_finalize($this->_parent_section, $this->_name); |
|
1393 | - } |
|
1394 | - } |
|
1395 | - |
|
1396 | - |
|
1397 | - /** |
|
1398 | - * Checks if any of this form section's inputs, or any of its children's inputs, |
|
1399 | - * are in teh form data. If any are found, returns true. Else false |
|
1400 | - * |
|
1401 | - * @param array $req_data |
|
1402 | - * @return boolean |
|
1403 | - * @throws EE_Error |
|
1404 | - */ |
|
1405 | - public function form_data_present_in($req_data = null) |
|
1406 | - { |
|
1407 | - $req_data = $this->getCachedRequest($req_data); |
|
1408 | - foreach ($this->subsections() as $subsection) { |
|
1409 | - if ($subsection instanceof EE_Form_Input_Base) { |
|
1410 | - if ($subsection->form_data_present_in($req_data)) { |
|
1411 | - return true; |
|
1412 | - } |
|
1413 | - } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
1414 | - if ($subsection->form_data_present_in($req_data)) { |
|
1415 | - return true; |
|
1416 | - } |
|
1417 | - } |
|
1418 | - } |
|
1419 | - return false; |
|
1420 | - } |
|
1421 | - |
|
1422 | - |
|
1423 | - /** |
|
1424 | - * Gets validation errors for this form section and subsections |
|
1425 | - * Similar to EE_Form_Section_Validatable::get_validation_errors() except this |
|
1426 | - * gets the validation errors for ALL subsection |
|
1427 | - * |
|
1428 | - * @return EE_Validation_Error[] |
|
1429 | - * @throws EE_Error |
|
1430 | - */ |
|
1431 | - public function get_validation_errors_accumulated() |
|
1432 | - { |
|
1433 | - $validation_errors = $this->get_validation_errors(); |
|
1434 | - foreach ($this->get_validatable_subsections() as $subsection) { |
|
1435 | - if ($subsection instanceof EE_Form_Section_Proper) { |
|
1436 | - $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated(); |
|
1437 | - } else { |
|
1438 | - $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1439 | - } |
|
1440 | - if ($validation_errors_on_this_subsection) { |
|
1441 | - $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection); |
|
1442 | - } |
|
1443 | - } |
|
1444 | - return $validation_errors; |
|
1445 | - } |
|
1446 | - |
|
1447 | - /** |
|
1448 | - * Fetch validation errors from children and grandchildren and puts them in a single string. |
|
1449 | - * This traverses the form section tree to generate this, but you probably want to instead use |
|
1450 | - * get_form_submission_error_message() which is usually this message cached (or a custom validation error message) |
|
1451 | - * |
|
1452 | - * @return string |
|
1453 | - */ |
|
1454 | - protected function getValidationErrorsAccumulatedString() |
|
1455 | - { |
|
1456 | - $submission_error_messages = array(); |
|
1457 | - // bad, bad, bad registrant |
|
1458 | - foreach ($this->get_validation_errors_accumulated() as $validation_error) { |
|
1459 | - if ($validation_error instanceof EE_Validation_Error) { |
|
1460 | - $form_section = $validation_error->get_form_section(); |
|
1461 | - if ($form_section instanceof EE_Form_Input_Base) { |
|
1462 | - $label = $validation_error->get_form_section()->html_label_text(); |
|
1463 | - } elseif($form_section instanceof EE_Form_Section_Validatable) { |
|
1464 | - $label = $validation_error->get_form_section()->name(); |
|
1465 | - } else { |
|
1466 | - $label = esc_html__('Unknown', 'event_espresso'); |
|
1467 | - } |
|
1468 | - $submission_error_messages[] = sprintf( |
|
1469 | - __('%s : %s', 'event_espresso'), |
|
1470 | - $label, |
|
1471 | - $validation_error->getMessage() |
|
1472 | - ); |
|
1473 | - } |
|
1474 | - } |
|
1475 | - return implode('<br', $submission_error_messages); |
|
1476 | - } |
|
1477 | - |
|
1478 | - |
|
1479 | - /** |
|
1480 | - * This isn't just the name of an input, it's a path pointing to an input. The |
|
1481 | - * path is similar to a folder path: slash (/) means to descend into a subsection, |
|
1482 | - * dot-dot-slash (../) means to ascend into the parent section. |
|
1483 | - * After a series of slashes and dot-dot-slashes, there should be the name of an input, |
|
1484 | - * which will be returned. |
|
1485 | - * Eg, if you want the related input to be conditional on a sibling input name 'foobar' |
|
1486 | - * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name |
|
1487 | - * 'baz', use '../baz'. If you want it to be conditional on a cousin input, |
|
1488 | - * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'. |
|
1489 | - * Etc |
|
1490 | - * |
|
1491 | - * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false |
|
1492 | - * @return EE_Form_Section_Base |
|
1493 | - * @throws EE_Error |
|
1494 | - */ |
|
1495 | - public function find_section_from_path($form_section_path) |
|
1496 | - { |
|
1497 | - //check if we can find the input from purely going straight up the tree |
|
1498 | - $input = parent::find_section_from_path($form_section_path); |
|
1499 | - if ($input instanceof EE_Form_Section_Base) { |
|
1500 | - return $input; |
|
1501 | - } |
|
1502 | - $next_slash_pos = strpos($form_section_path, '/'); |
|
1503 | - if ($next_slash_pos !== false) { |
|
1504 | - $child_section_name = substr($form_section_path, 0, $next_slash_pos); |
|
1505 | - $subpath = substr($form_section_path, $next_slash_pos + 1); |
|
1506 | - } else { |
|
1507 | - $child_section_name = $form_section_path; |
|
1508 | - $subpath = ''; |
|
1509 | - } |
|
1510 | - $child_section = $this->get_subsection($child_section_name); |
|
1511 | - if ($child_section instanceof EE_Form_Section_Base) { |
|
1512 | - return $child_section->find_section_from_path($subpath); |
|
1513 | - } |
|
1514 | - return null; |
|
1515 | - } |
|
17 | + const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data'; |
|
18 | + |
|
19 | + /** |
|
20 | + * Subsections |
|
21 | + * |
|
22 | + * @var EE_Form_Section_Validatable[] |
|
23 | + */ |
|
24 | + protected $_subsections = array(); |
|
25 | + |
|
26 | + /** |
|
27 | + * Strategy for laying out the form |
|
28 | + * |
|
29 | + * @var EE_Form_Section_Layout_Base |
|
30 | + */ |
|
31 | + protected $_layout_strategy; |
|
32 | + |
|
33 | + /** |
|
34 | + * Whether or not this form has received and validated a form submission yet |
|
35 | + * |
|
36 | + * @var boolean |
|
37 | + */ |
|
38 | + protected $_received_submission = false; |
|
39 | + |
|
40 | + /** |
|
41 | + * message displayed to users upon successful form submission |
|
42 | + * |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + protected $_form_submission_success_message = ''; |
|
46 | + |
|
47 | + /** |
|
48 | + * message displayed to users upon unsuccessful form submission |
|
49 | + * |
|
50 | + * @var string |
|
51 | + */ |
|
52 | + protected $_form_submission_error_message = ''; |
|
53 | + |
|
54 | + /** |
|
55 | + * @var array like $_REQUEST |
|
56 | + */ |
|
57 | + protected $cached_request_data; |
|
58 | + |
|
59 | + /** |
|
60 | + * Stores whether this form (and its sub-sections) were found to be valid or not. |
|
61 | + * Starts off as null, but once the form is validated, it set to either true or false |
|
62 | + * @var boolean|null |
|
63 | + */ |
|
64 | + protected $is_valid; |
|
65 | + |
|
66 | + /** |
|
67 | + * Stores all the data that will localized for form validation |
|
68 | + * |
|
69 | + * @var array |
|
70 | + */ |
|
71 | + static protected $_js_localization = array(); |
|
72 | + |
|
73 | + /** |
|
74 | + * whether or not the form's localized validation JS vars have been set |
|
75 | + * |
|
76 | + * @type boolean |
|
77 | + */ |
|
78 | + static protected $_scripts_localized = false; |
|
79 | + |
|
80 | + |
|
81 | + /** |
|
82 | + * when constructing a proper form section, calls _construct_finalize on children |
|
83 | + * so that they know who their parent is, and what name they've been given. |
|
84 | + * |
|
85 | + * @param array[] $options_array { |
|
86 | + * @type $subsections EE_Form_Section_Validatable[] where keys are the section's name |
|
87 | + * @type $include string[] numerically-indexed where values are section names to be included, |
|
88 | + * and in that order. This is handy if you want |
|
89 | + * the subsections to be ordered differently than the default, and if you override |
|
90 | + * which fields are shown |
|
91 | + * @type $exclude string[] values are subsections to be excluded. This is handy if you want |
|
92 | + * to remove certain default subsections (note: if you specify BOTH 'include' AND |
|
93 | + * 'exclude', the inclusions will be applied first, and the exclusions will exclude |
|
94 | + * items from that list of inclusions) |
|
95 | + * @type $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form |
|
96 | + * } @see EE_Form_Section_Validatable::__construct() |
|
97 | + * @throws EE_Error |
|
98 | + */ |
|
99 | + public function __construct($options_array = array()) |
|
100 | + { |
|
101 | + $options_array = (array) apply_filters( |
|
102 | + 'FHEE__EE_Form_Section_Proper___construct__options_array', |
|
103 | + $options_array, |
|
104 | + $this |
|
105 | + ); |
|
106 | + //call parent first, as it may be setting the name |
|
107 | + parent::__construct($options_array); |
|
108 | + //if they've included subsections in the constructor, add them now |
|
109 | + if (isset($options_array['include'])) { |
|
110 | + //we are going to make sure we ONLY have those subsections to include |
|
111 | + //AND we are going to make sure they're in that specified order |
|
112 | + $reordered_subsections = array(); |
|
113 | + foreach ($options_array['include'] as $input_name) { |
|
114 | + if (isset($this->_subsections[ $input_name ])) { |
|
115 | + $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
116 | + } |
|
117 | + } |
|
118 | + $this->_subsections = $reordered_subsections; |
|
119 | + } |
|
120 | + if (isset($options_array['exclude'])) { |
|
121 | + $exclude = $options_array['exclude']; |
|
122 | + $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude)); |
|
123 | + } |
|
124 | + if (isset($options_array['layout_strategy'])) { |
|
125 | + $this->_layout_strategy = $options_array['layout_strategy']; |
|
126 | + } |
|
127 | + if (! $this->_layout_strategy) { |
|
128 | + $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
|
129 | + } |
|
130 | + $this->_layout_strategy->_construct_finalize($this); |
|
131 | + //ok so we are definitely going to want the forms JS, |
|
132 | + //so enqueue it or remember to enqueue it during wp_enqueue_scripts |
|
133 | + if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) { |
|
134 | + //ok so they've constructed this object after when they should have. |
|
135 | + //just enqueue the generic form scripts and initialize the form immediately in the JS |
|
136 | + EE_Form_Section_Proper::wp_enqueue_scripts(true); |
|
137 | + } else { |
|
138 | + add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
139 | + add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts')); |
|
140 | + } |
|
141 | + add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1); |
|
142 | + /** |
|
143 | + * Gives other plugins a chance to hook in before construct finalize is called. |
|
144 | + * The form probably doesn't yet have a parent form section. |
|
145 | + * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form, |
|
146 | + * assuming you don't care what the form section's name, HTML ID, or HTML name etc are. |
|
147 | + * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end |
|
148 | + * |
|
149 | + * @since 4.9.32 |
|
150 | + * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, |
|
151 | + * except maybe calling _construct_finalize has been done |
|
152 | + * @param array $options_array options passed into the constructor |
|
153 | + */ |
|
154 | + do_action( |
|
155 | + 'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', |
|
156 | + $this, |
|
157 | + $options_array |
|
158 | + ); |
|
159 | + if (isset($options_array['name'])) { |
|
160 | + $this->_construct_finalize(null, $options_array['name']); |
|
161 | + } |
|
162 | + } |
|
163 | + |
|
164 | + |
|
165 | + /** |
|
166 | + * Finishes construction given the parent form section and this form section's name |
|
167 | + * |
|
168 | + * @param EE_Form_Section_Proper $parent_form_section |
|
169 | + * @param string $name |
|
170 | + * @throws EE_Error |
|
171 | + */ |
|
172 | + public function _construct_finalize($parent_form_section, $name) |
|
173 | + { |
|
174 | + parent::_construct_finalize($parent_form_section, $name); |
|
175 | + $this->_set_default_name_if_empty(); |
|
176 | + $this->_set_default_html_id_if_empty(); |
|
177 | + foreach ($this->_subsections as $subsection_name => $subsection) { |
|
178 | + if ($subsection instanceof EE_Form_Section_Base) { |
|
179 | + $subsection->_construct_finalize($this, $subsection_name); |
|
180 | + } else { |
|
181 | + throw new EE_Error( |
|
182 | + sprintf( |
|
183 | + esc_html__( |
|
184 | + 'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"', |
|
185 | + 'event_espresso' |
|
186 | + ), |
|
187 | + $subsection_name, |
|
188 | + get_class($this), |
|
189 | + $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
190 | + ) |
|
191 | + ); |
|
192 | + } |
|
193 | + } |
|
194 | + /** |
|
195 | + * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed. |
|
196 | + * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID |
|
197 | + * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done. |
|
198 | + * This might only happen just before displaying the form, or just before it receives form submission data. |
|
199 | + * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've |
|
200 | + * ensured it has a name, HTML IDs, etc |
|
201 | + * |
|
202 | + * @param EE_Form_Section_Proper $this |
|
203 | + * @param EE_Form_Section_Proper|null $parent_form_section |
|
204 | + * @param string $name |
|
205 | + */ |
|
206 | + do_action( |
|
207 | + 'AHEE__EE_Form_Section_Proper___construct_finalize__end', |
|
208 | + $this, |
|
209 | + $parent_form_section, |
|
210 | + $name |
|
211 | + ); |
|
212 | + } |
|
213 | + |
|
214 | + |
|
215 | + /** |
|
216 | + * Gets the layout strategy for this form section |
|
217 | + * |
|
218 | + * @return EE_Form_Section_Layout_Base |
|
219 | + */ |
|
220 | + public function get_layout_strategy() |
|
221 | + { |
|
222 | + return $this->_layout_strategy; |
|
223 | + } |
|
224 | + |
|
225 | + |
|
226 | + /** |
|
227 | + * Gets the HTML for a single input for this form section according |
|
228 | + * to the layout strategy |
|
229 | + * |
|
230 | + * @param EE_Form_Input_Base $input |
|
231 | + * @return string |
|
232 | + */ |
|
233 | + public function get_html_for_input($input) |
|
234 | + { |
|
235 | + return $this->_layout_strategy->layout_input($input); |
|
236 | + } |
|
237 | + |
|
238 | + |
|
239 | + /** |
|
240 | + * was_submitted - checks if form inputs are present in request data |
|
241 | + * Basically an alias for form_data_present_in() (which is used by both |
|
242 | + * proper form sections and form inputs) |
|
243 | + * |
|
244 | + * @param null $form_data |
|
245 | + * @return boolean |
|
246 | + * @throws EE_Error |
|
247 | + */ |
|
248 | + public function was_submitted($form_data = null) |
|
249 | + { |
|
250 | + return $this->form_data_present_in($form_data); |
|
251 | + } |
|
252 | + |
|
253 | + /** |
|
254 | + * Gets the cached request data; but if there is none, or $req_data was set with |
|
255 | + * something different, refresh the cache, and then return it |
|
256 | + * @param null $req_data |
|
257 | + * @return array |
|
258 | + */ |
|
259 | + protected function getCachedRequest($req_data = null) |
|
260 | + { |
|
261 | + if ($this->cached_request_data === null |
|
262 | + || ( |
|
263 | + $req_data !== null && |
|
264 | + $req_data !== $this->cached_request_data |
|
265 | + ) |
|
266 | + ) { |
|
267 | + $req_data = apply_filters( |
|
268 | + 'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', |
|
269 | + $req_data, |
|
270 | + $this |
|
271 | + ); |
|
272 | + if ($req_data === null) { |
|
273 | + $req_data = array_merge($_GET, $_POST); |
|
274 | + } |
|
275 | + $req_data = apply_filters( |
|
276 | + 'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', |
|
277 | + $req_data, |
|
278 | + $this |
|
279 | + ); |
|
280 | + $this->cached_request_data = (array)$req_data; |
|
281 | + } |
|
282 | + return $this->cached_request_data; |
|
283 | + } |
|
284 | + |
|
285 | + |
|
286 | + /** |
|
287 | + * After the form section is initially created, call this to sanitize the data in the submission |
|
288 | + * which relates to this form section, validate it, and set it as properties on the form. |
|
289 | + * |
|
290 | + * @param array|null $req_data should usually be $_POST (the default). |
|
291 | + * However, you CAN supply a different array. |
|
292 | + * Consider using set_defaults() instead however. |
|
293 | + * (If you rendered the form in the page using echo $form_x->get_html() |
|
294 | + * the inputs will have the correct name in the request data for this function |
|
295 | + * to find them and populate the form with them. |
|
296 | + * If you have a flat form (with only input subsections), |
|
297 | + * you can supply a flat array where keys |
|
298 | + * are the form input names and values are their values) |
|
299 | + * @param boolean $validate whether or not to perform validation on this data. Default is, |
|
300 | + * of course, to validate that data, and set errors on the invalid values. |
|
301 | + * But if the data has already been validated |
|
302 | + * (eg you validated the data then stored it in the DB) |
|
303 | + * you may want to skip this step. |
|
304 | + * @throws InvalidArgumentException |
|
305 | + * @throws InvalidInterfaceException |
|
306 | + * @throws InvalidDataTypeException |
|
307 | + * @throws EE_Error |
|
308 | + */ |
|
309 | + public function receive_form_submission($req_data = null, $validate = true) |
|
310 | + { |
|
311 | + $req_data = $this->getCachedRequest($req_data); |
|
312 | + $this->_normalize($req_data); |
|
313 | + if ($validate) { |
|
314 | + $this->_validate(); |
|
315 | + //if it's invalid, we're going to want to re-display so remember what they submitted |
|
316 | + if (! $this->is_valid()) { |
|
317 | + $this->store_submitted_form_data_in_session(); |
|
318 | + } |
|
319 | + } |
|
320 | + if ($this->submission_error_message() === '' && ! $this->is_valid()) { |
|
321 | + $this->set_submission_error_message(); |
|
322 | + } |
|
323 | + do_action( |
|
324 | + 'AHEE__EE_Form_Section_Proper__receive_form_submission__end', |
|
325 | + $req_data, |
|
326 | + $this, |
|
327 | + $validate |
|
328 | + ); |
|
329 | + } |
|
330 | + |
|
331 | + |
|
332 | + /** |
|
333 | + * caches the originally submitted input values in the session |
|
334 | + * so that they can be used to repopulate the form if it failed validation |
|
335 | + * |
|
336 | + * @return boolean whether or not the data was successfully stored in the session |
|
337 | + * @throws InvalidArgumentException |
|
338 | + * @throws InvalidInterfaceException |
|
339 | + * @throws InvalidDataTypeException |
|
340 | + * @throws EE_Error |
|
341 | + */ |
|
342 | + protected function store_submitted_form_data_in_session() |
|
343 | + { |
|
344 | + return EE_Registry::instance()->SSN->set_session_data( |
|
345 | + array( |
|
346 | + EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true), |
|
347 | + ) |
|
348 | + ); |
|
349 | + } |
|
350 | + |
|
351 | + |
|
352 | + /** |
|
353 | + * retrieves the originally submitted input values in the session |
|
354 | + * so that they can be used to repopulate the form if it failed validation |
|
355 | + * |
|
356 | + * @return array |
|
357 | + * @throws InvalidArgumentException |
|
358 | + * @throws InvalidInterfaceException |
|
359 | + * @throws InvalidDataTypeException |
|
360 | + */ |
|
361 | + protected function get_submitted_form_data_from_session() |
|
362 | + { |
|
363 | + $session = EE_Registry::instance()->SSN; |
|
364 | + if ($session instanceof EE_Session) { |
|
365 | + return $session->get_session_data( |
|
366 | + EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY |
|
367 | + ); |
|
368 | + } |
|
369 | + return array(); |
|
370 | + } |
|
371 | + |
|
372 | + |
|
373 | + /** |
|
374 | + * flushed the originally submitted input values from the session |
|
375 | + * |
|
376 | + * @return boolean whether or not the data was successfully removed from the session |
|
377 | + * @throws InvalidArgumentException |
|
378 | + * @throws InvalidInterfaceException |
|
379 | + * @throws InvalidDataTypeException |
|
380 | + */ |
|
381 | + protected function flush_submitted_form_data_from_session() |
|
382 | + { |
|
383 | + return EE_Registry::instance()->SSN->reset_data( |
|
384 | + array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY) |
|
385 | + ); |
|
386 | + } |
|
387 | + |
|
388 | + |
|
389 | + /** |
|
390 | + * Populates this form and its subsections with data from the session. |
|
391 | + * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows |
|
392 | + * validation errors when displaying too) |
|
393 | + * Returns true if the form was populated from the session, false otherwise |
|
394 | + * |
|
395 | + * @return boolean |
|
396 | + * @throws InvalidArgumentException |
|
397 | + * @throws InvalidInterfaceException |
|
398 | + * @throws InvalidDataTypeException |
|
399 | + * @throws EE_Error |
|
400 | + */ |
|
401 | + public function populate_from_session() |
|
402 | + { |
|
403 | + $form_data_in_session = $this->get_submitted_form_data_from_session(); |
|
404 | + if (empty($form_data_in_session)) { |
|
405 | + return false; |
|
406 | + } |
|
407 | + $this->receive_form_submission($form_data_in_session); |
|
408 | + $this->flush_submitted_form_data_from_session(); |
|
409 | + if ($this->form_data_present_in($form_data_in_session)) { |
|
410 | + return true; |
|
411 | + } |
|
412 | + return false; |
|
413 | + } |
|
414 | + |
|
415 | + |
|
416 | + /** |
|
417 | + * Populates the default data for the form, given an array where keys are |
|
418 | + * the input names, and values are their values (preferably normalized to be their |
|
419 | + * proper PHP types, not all strings... although that should be ok too). |
|
420 | + * Proper subsections are sub-arrays, the key being the subsection's name, and |
|
421 | + * the value being an array formatted in teh same way |
|
422 | + * |
|
423 | + * @param array $default_data |
|
424 | + * @throws EE_Error |
|
425 | + */ |
|
426 | + public function populate_defaults($default_data) |
|
427 | + { |
|
428 | + foreach ($this->subsections(false) as $subsection_name => $subsection) { |
|
429 | + if (isset($default_data[ $subsection_name ])) { |
|
430 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
431 | + $subsection->set_default($default_data[ $subsection_name ]); |
|
432 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
433 | + $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
434 | + } |
|
435 | + } |
|
436 | + } |
|
437 | + } |
|
438 | + |
|
439 | + |
|
440 | + /** |
|
441 | + * returns true if subsection exists |
|
442 | + * |
|
443 | + * @param string $name |
|
444 | + * @return boolean |
|
445 | + */ |
|
446 | + public function subsection_exists($name) |
|
447 | + { |
|
448 | + return isset($this->_subsections[ $name ]) ? true : false; |
|
449 | + } |
|
450 | + |
|
451 | + |
|
452 | + /** |
|
453 | + * Gets the subsection specified by its name |
|
454 | + * |
|
455 | + * @param string $name |
|
456 | + * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE |
|
457 | + * so that the inputs will be properly configured. |
|
458 | + * However, some client code may be ok |
|
459 | + * with construction finalize being called later |
|
460 | + * (realizing that the subsections' html names |
|
461 | + * might not be set yet, etc.) |
|
462 | + * @return EE_Form_Section_Base |
|
463 | + * @throws EE_Error |
|
464 | + */ |
|
465 | + public function get_subsection($name, $require_construction_to_be_finalized = true) |
|
466 | + { |
|
467 | + if ($require_construction_to_be_finalized) { |
|
468 | + $this->ensure_construct_finalized_called(); |
|
469 | + } |
|
470 | + return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
471 | + } |
|
472 | + |
|
473 | + |
|
474 | + /** |
|
475 | + * Gets all the validatable subsections of this form section |
|
476 | + * |
|
477 | + * @return EE_Form_Section_Validatable[] |
|
478 | + * @throws EE_Error |
|
479 | + */ |
|
480 | + public function get_validatable_subsections() |
|
481 | + { |
|
482 | + $validatable_subsections = array(); |
|
483 | + foreach ($this->subsections() as $name => $obj) { |
|
484 | + if ($obj instanceof EE_Form_Section_Validatable) { |
|
485 | + $validatable_subsections[ $name ] = $obj; |
|
486 | + } |
|
487 | + } |
|
488 | + return $validatable_subsections; |
|
489 | + } |
|
490 | + |
|
491 | + |
|
492 | + /** |
|
493 | + * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child, |
|
494 | + * throw an EE_Error. |
|
495 | + * |
|
496 | + * @param string $name |
|
497 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
498 | + * leave this as TRUE so that the inputs will be properly |
|
499 | + * configured. However, some client code may be ok with |
|
500 | + * construction finalize being called later |
|
501 | + * (realizing that the subsections' html names might not be |
|
502 | + * set yet, etc.) |
|
503 | + * @return EE_Form_Input_Base |
|
504 | + * @throws EE_Error |
|
505 | + */ |
|
506 | + public function get_input($name, $require_construction_to_be_finalized = true) |
|
507 | + { |
|
508 | + $subsection = $this->get_subsection( |
|
509 | + $name, |
|
510 | + $require_construction_to_be_finalized |
|
511 | + ); |
|
512 | + if (! $subsection instanceof EE_Form_Input_Base) { |
|
513 | + throw new EE_Error( |
|
514 | + sprintf( |
|
515 | + esc_html__( |
|
516 | + "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'", |
|
517 | + 'event_espresso' |
|
518 | + ), |
|
519 | + $name, |
|
520 | + get_class($this), |
|
521 | + $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso') |
|
522 | + ) |
|
523 | + ); |
|
524 | + } |
|
525 | + return $subsection; |
|
526 | + } |
|
527 | + |
|
528 | + |
|
529 | + /** |
|
530 | + * Like get_input(), gets the proper subsection of the form given the name, |
|
531 | + * otherwise throws an EE_Error |
|
532 | + * |
|
533 | + * @param string $name |
|
534 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
535 | + * leave this as TRUE so that the inputs will be properly |
|
536 | + * configured. However, some client code may be ok with |
|
537 | + * construction finalize being called later |
|
538 | + * (realizing that the subsections' html names might not be |
|
539 | + * set yet, etc.) |
|
540 | + * @return EE_Form_Section_Proper |
|
541 | + * @throws EE_Error |
|
542 | + */ |
|
543 | + public function get_proper_subsection($name, $require_construction_to_be_finalized = true) |
|
544 | + { |
|
545 | + $subsection = $this->get_subsection( |
|
546 | + $name, |
|
547 | + $require_construction_to_be_finalized |
|
548 | + ); |
|
549 | + if (! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | + throw new EE_Error( |
|
551 | + sprintf( |
|
552 | + esc_html__( |
|
553 | + "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", |
|
554 | + 'event_espresso' |
|
555 | + ), |
|
556 | + $name, |
|
557 | + get_class($this) |
|
558 | + ) |
|
559 | + ); |
|
560 | + } |
|
561 | + return $subsection; |
|
562 | + } |
|
563 | + |
|
564 | + |
|
565 | + /** |
|
566 | + * Gets the value of the specified input. Should be called after receive_form_submission() |
|
567 | + * or populate_defaults() on the form, where the normalized value on the input is set. |
|
568 | + * |
|
569 | + * @param string $name |
|
570 | + * @return mixed depending on the input's type and its normalization strategy |
|
571 | + * @throws EE_Error |
|
572 | + */ |
|
573 | + public function get_input_value($name) |
|
574 | + { |
|
575 | + $input = $this->get_input($name); |
|
576 | + return $input->normalized_value(); |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + /** |
|
581 | + * Checks if this form section itself is valid, and then checks its subsections |
|
582 | + * |
|
583 | + * @throws EE_Error |
|
584 | + * @return boolean |
|
585 | + */ |
|
586 | + public function is_valid() |
|
587 | + { |
|
588 | + if($this->is_valid === null) { |
|
589 | + if (! $this->has_received_submission()) { |
|
590 | + throw new EE_Error( |
|
591 | + sprintf( |
|
592 | + esc_html__( |
|
593 | + 'You cannot check if a form is valid before receiving the form submission using receive_form_submission', |
|
594 | + 'event_espresso' |
|
595 | + ) |
|
596 | + ) |
|
597 | + ); |
|
598 | + } |
|
599 | + if (! parent::is_valid()) { |
|
600 | + $this->is_valid = false; |
|
601 | + } else { |
|
602 | + // ok so no general errors to this entire form section. |
|
603 | + // so let's check the subsections, but only set errors if that hasn't been done yet |
|
604 | + $this->is_valid = true; |
|
605 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
606 | + if (! $subsection->is_valid()) { |
|
607 | + $this->is_valid = false; |
|
608 | + } |
|
609 | + } |
|
610 | + } |
|
611 | + } |
|
612 | + return $this->is_valid; |
|
613 | + } |
|
614 | + |
|
615 | + |
|
616 | + /** |
|
617 | + * gets the default name of this form section if none is specified |
|
618 | + * |
|
619 | + * @return void |
|
620 | + */ |
|
621 | + protected function _set_default_name_if_empty() |
|
622 | + { |
|
623 | + if (! $this->_name) { |
|
624 | + $classname = get_class($this); |
|
625 | + $default_name = str_replace('EE_', '', $classname); |
|
626 | + $this->_name = $default_name; |
|
627 | + } |
|
628 | + } |
|
629 | + |
|
630 | + |
|
631 | + /** |
|
632 | + * Returns the HTML for the form, except for the form opening and closing tags |
|
633 | + * (as the form section doesn't know where you necessarily want to send the information to), |
|
634 | + * and except for a submit button. Enqueues JS and CSS; if called early enough we will |
|
635 | + * try to enqueue them in the header, otherwise they'll be enqueued in the footer. |
|
636 | + * Not doing_it_wrong because theoretically this CAN be used properly, |
|
637 | + * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue |
|
638 | + * any CSS. |
|
639 | + * |
|
640 | + * @throws InvalidArgumentException |
|
641 | + * @throws InvalidInterfaceException |
|
642 | + * @throws InvalidDataTypeException |
|
643 | + * @throws EE_Error |
|
644 | + */ |
|
645 | + public function get_html_and_js() |
|
646 | + { |
|
647 | + $this->enqueue_js(); |
|
648 | + return $this->get_html(); |
|
649 | + } |
|
650 | + |
|
651 | + |
|
652 | + /** |
|
653 | + * returns HTML for displaying this form section. recursively calls display_section() on all subsections |
|
654 | + * |
|
655 | + * @param bool $display_previously_submitted_data |
|
656 | + * @return string |
|
657 | + * @throws InvalidArgumentException |
|
658 | + * @throws InvalidInterfaceException |
|
659 | + * @throws InvalidDataTypeException |
|
660 | + * @throws EE_Error |
|
661 | + * @throws EE_Error |
|
662 | + * @throws EE_Error |
|
663 | + */ |
|
664 | + public function get_html($display_previously_submitted_data = true) |
|
665 | + { |
|
666 | + $this->ensure_construct_finalized_called(); |
|
667 | + if ($display_previously_submitted_data) { |
|
668 | + $this->populate_from_session(); |
|
669 | + } |
|
670 | + return $this->_form_html_filter |
|
671 | + ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this) |
|
672 | + : $this->_layout_strategy->layout_form(); |
|
673 | + } |
|
674 | + |
|
675 | + |
|
676 | + /** |
|
677 | + * enqueues JS and CSS for the form. |
|
678 | + * It is preferred to call this before wp_enqueue_scripts so the |
|
679 | + * scripts and styles can be put in the header, but if called later |
|
680 | + * they will be put in the footer (which is OK for JS, but in HTML4 CSS should |
|
681 | + * only be in the header; but in HTML5 its ok in the body. |
|
682 | + * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag. |
|
683 | + * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.) |
|
684 | + * |
|
685 | + * @return void |
|
686 | + * @throws EE_Error |
|
687 | + */ |
|
688 | + public function enqueue_js() |
|
689 | + { |
|
690 | + $this->_enqueue_and_localize_form_js(); |
|
691 | + foreach ($this->subsections() as $subsection) { |
|
692 | + $subsection->enqueue_js(); |
|
693 | + } |
|
694 | + } |
|
695 | + |
|
696 | + |
|
697 | + /** |
|
698 | + * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts(). |
|
699 | + * This must be done BEFORE wp_enqueue_scripts() gets called, which is on |
|
700 | + * the wp_enqueue_scripts hook. |
|
701 | + * However, registering the form js and localizing it can happen when we |
|
702 | + * actually output the form (which is preferred, seeing how teh form's fields |
|
703 | + * could change until it's actually outputted) |
|
704 | + * |
|
705 | + * @param boolean $init_form_validation_automatically whether or not we want the form validation |
|
706 | + * to be triggered automatically or not |
|
707 | + * @return void |
|
708 | + */ |
|
709 | + public static function wp_enqueue_scripts($init_form_validation_automatically = true) |
|
710 | + { |
|
711 | + wp_register_script( |
|
712 | + 'ee_form_section_validation', |
|
713 | + EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js', |
|
714 | + array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
|
715 | + EVENT_ESPRESSO_VERSION, |
|
716 | + true |
|
717 | + ); |
|
718 | + wp_localize_script( |
|
719 | + 'ee_form_section_validation', |
|
720 | + 'ee_form_section_validation_init', |
|
721 | + array('init' => $init_form_validation_automatically ? '1' : '0') |
|
722 | + ); |
|
723 | + } |
|
724 | + |
|
725 | + |
|
726 | + /** |
|
727 | + * gets the variables used by form_section_validation.js. |
|
728 | + * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script, |
|
729 | + * but before the wordpress hook wp_loaded |
|
730 | + * |
|
731 | + * @throws EE_Error |
|
732 | + */ |
|
733 | + public function _enqueue_and_localize_form_js() |
|
734 | + { |
|
735 | + $this->ensure_construct_finalized_called(); |
|
736 | + //actually, we don't want to localize just yet. There may be other forms on the page. |
|
737 | + //so we need to add our form section data to a static variable accessible by all form sections |
|
738 | + //and localize it just before the footer |
|
739 | + $this->localize_validation_rules(); |
|
740 | + add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2); |
|
741 | + add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms')); |
|
742 | + } |
|
743 | + |
|
744 | + |
|
745 | + /** |
|
746 | + * add our form section data to a static variable accessible by all form sections |
|
747 | + * |
|
748 | + * @param bool $return_for_subsection |
|
749 | + * @return void |
|
750 | + * @throws EE_Error |
|
751 | + */ |
|
752 | + public function localize_validation_rules($return_for_subsection = false) |
|
753 | + { |
|
754 | + // we only want to localize vars ONCE for the entire form, |
|
755 | + // so if the form section doesn't have a parent, then it must be the top dog |
|
756 | + if ($return_for_subsection || ! $this->parent_section()) { |
|
757 | + EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
758 | + 'form_section_id' => $this->html_id(true), |
|
759 | + 'validation_rules' => $this->get_jquery_validation_rules(), |
|
760 | + 'other_data' => $this->get_other_js_data(), |
|
761 | + 'errors' => $this->subsection_validation_errors_by_html_name(), |
|
762 | + ); |
|
763 | + EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | + } |
|
765 | + } |
|
766 | + |
|
767 | + |
|
768 | + /** |
|
769 | + * Gets an array of extra data that will be useful for client-side javascript. |
|
770 | + * This is primarily data added by inputs and forms in addition to any |
|
771 | + * scripts they might enqueue |
|
772 | + * |
|
773 | + * @param array $form_other_js_data |
|
774 | + * @return array |
|
775 | + * @throws EE_Error |
|
776 | + */ |
|
777 | + public function get_other_js_data($form_other_js_data = array()) |
|
778 | + { |
|
779 | + foreach ($this->subsections() as $subsection) { |
|
780 | + $form_other_js_data = $subsection->get_other_js_data($form_other_js_data); |
|
781 | + } |
|
782 | + return $form_other_js_data; |
|
783 | + } |
|
784 | + |
|
785 | + |
|
786 | + /** |
|
787 | + * Gets a flat array of inputs for this form section and its subsections. |
|
788 | + * Keys are their form names, and values are the inputs themselves |
|
789 | + * |
|
790 | + * @return EE_Form_Input_Base |
|
791 | + * @throws EE_Error |
|
792 | + */ |
|
793 | + public function inputs_in_subsections() |
|
794 | + { |
|
795 | + $inputs = array(); |
|
796 | + foreach ($this->subsections() as $subsection) { |
|
797 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
798 | + $inputs[ $subsection->html_name() ] = $subsection; |
|
799 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
800 | + $inputs += $subsection->inputs_in_subsections(); |
|
801 | + } |
|
802 | + } |
|
803 | + return $inputs; |
|
804 | + } |
|
805 | + |
|
806 | + |
|
807 | + /** |
|
808 | + * Gets a flat array of all the validation errors. |
|
809 | + * Keys are html names (because those should be unique) |
|
810 | + * and values are a string of all their validation errors |
|
811 | + * |
|
812 | + * @return string[] |
|
813 | + * @throws EE_Error |
|
814 | + */ |
|
815 | + public function subsection_validation_errors_by_html_name() |
|
816 | + { |
|
817 | + $inputs = $this->inputs(); |
|
818 | + $errors = array(); |
|
819 | + foreach ($inputs as $form_input) { |
|
820 | + if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
|
821 | + $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
822 | + } |
|
823 | + } |
|
824 | + return $errors; |
|
825 | + } |
|
826 | + |
|
827 | + |
|
828 | + /** |
|
829 | + * passes all the form data required by the JS to the JS, and enqueues the few required JS files. |
|
830 | + * Should be setup by each form during the _enqueues_and_localize_form_js |
|
831 | + * |
|
832 | + * @throws InvalidArgumentException |
|
833 | + * @throws InvalidInterfaceException |
|
834 | + * @throws InvalidDataTypeException |
|
835 | + */ |
|
836 | + public static function localize_script_for_all_forms() |
|
837 | + { |
|
838 | + //allow inputs and stuff to hook in their JS and stuff here |
|
839 | + do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin'); |
|
840 | + EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages(); |
|
841 | + $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
|
842 | + ? EE_Registry::instance()->CFG->registration->email_validation_level |
|
843 | + : 'wp_default'; |
|
844 | + EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | + wp_enqueue_script('ee_form_section_validation'); |
|
846 | + wp_localize_script( |
|
847 | + 'ee_form_section_validation', |
|
848 | + 'ee_form_section_vars', |
|
849 | + EE_Form_Section_Proper::$_js_localization |
|
850 | + ); |
|
851 | + } |
|
852 | + |
|
853 | + |
|
854 | + /** |
|
855 | + * ensure_scripts_localized |
|
856 | + * |
|
857 | + * @throws EE_Error |
|
858 | + */ |
|
859 | + public function ensure_scripts_localized() |
|
860 | + { |
|
861 | + if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | + $this->_enqueue_and_localize_form_js(); |
|
863 | + } |
|
864 | + } |
|
865 | + |
|
866 | + |
|
867 | + /** |
|
868 | + * Gets the hard-coded validation error messages to be used in the JS. The convention |
|
869 | + * is that the key here should be the same as the custom validation rule put in the JS file |
|
870 | + * |
|
871 | + * @return array keys are custom validation rules, and values are internationalized strings |
|
872 | + */ |
|
873 | + private static function _get_localized_error_messages() |
|
874 | + { |
|
875 | + return array( |
|
876 | + 'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'), |
|
877 | + 'regex' => esc_html__('Please check your input', 'event_espresso'), |
|
878 | + ); |
|
879 | + } |
|
880 | + |
|
881 | + |
|
882 | + /** |
|
883 | + * @return array |
|
884 | + */ |
|
885 | + public static function js_localization() |
|
886 | + { |
|
887 | + return self::$_js_localization; |
|
888 | + } |
|
889 | + |
|
890 | + |
|
891 | + /** |
|
892 | + * @return void |
|
893 | + */ |
|
894 | + public static function reset_js_localization() |
|
895 | + { |
|
896 | + self::$_js_localization = array(); |
|
897 | + } |
|
898 | + |
|
899 | + |
|
900 | + /** |
|
901 | + * Gets the JS to put inside the jquery validation rules for subsection of this form section. |
|
902 | + * See parent function for more... |
|
903 | + * |
|
904 | + * @return array |
|
905 | + * @throws EE_Error |
|
906 | + */ |
|
907 | + public function get_jquery_validation_rules() |
|
908 | + { |
|
909 | + $jquery_validation_rules = array(); |
|
910 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
911 | + $jquery_validation_rules = array_merge( |
|
912 | + $jquery_validation_rules, |
|
913 | + $subsection->get_jquery_validation_rules() |
|
914 | + ); |
|
915 | + } |
|
916 | + return $jquery_validation_rules; |
|
917 | + } |
|
918 | + |
|
919 | + |
|
920 | + /** |
|
921 | + * Sanitizes all the data and sets the sanitized value of each field |
|
922 | + * |
|
923 | + * @param array $req_data like $_POST |
|
924 | + * @return void |
|
925 | + * @throws EE_Error |
|
926 | + */ |
|
927 | + protected function _normalize($req_data) |
|
928 | + { |
|
929 | + $this->_received_submission = true; |
|
930 | + $this->_validation_errors = array(); |
|
931 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
932 | + try { |
|
933 | + $subsection->_normalize($req_data); |
|
934 | + } catch (EE_Validation_Error $e) { |
|
935 | + $subsection->add_validation_error($e); |
|
936 | + } |
|
937 | + } |
|
938 | + } |
|
939 | + |
|
940 | + |
|
941 | + /** |
|
942 | + * Performs validation on this form section and its subsections. |
|
943 | + * For each subsection, |
|
944 | + * calls _validate_{subsection_name} on THIS form (if the function exists) |
|
945 | + * and passes it the subsection, then calls _validate on that subsection. |
|
946 | + * If you need to perform validation on the form as a whole (considering multiple) |
|
947 | + * you would be best to override this _validate method, |
|
948 | + * calling parent::_validate() first. |
|
949 | + * |
|
950 | + * @throws EE_Error |
|
951 | + */ |
|
952 | + protected function _validate() |
|
953 | + { |
|
954 | + //reset the cache of whether this form is valid or not- we're re-validating it now |
|
955 | + $this->is_valid = null; |
|
956 | + foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
|
957 | + if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | + call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
959 | + } |
|
960 | + $subsection->_validate(); |
|
961 | + } |
|
962 | + } |
|
963 | + |
|
964 | + |
|
965 | + /** |
|
966 | + * Gets all the validated inputs for the form section |
|
967 | + * |
|
968 | + * @return array |
|
969 | + * @throws EE_Error |
|
970 | + */ |
|
971 | + public function valid_data() |
|
972 | + { |
|
973 | + $inputs = array(); |
|
974 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
975 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
976 | + $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
977 | + } elseif ($subsection instanceof EE_Form_Input_Base) { |
|
978 | + $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
979 | + } |
|
980 | + } |
|
981 | + return $inputs; |
|
982 | + } |
|
983 | + |
|
984 | + |
|
985 | + /** |
|
986 | + * Gets all the inputs on this form section |
|
987 | + * |
|
988 | + * @return EE_Form_Input_Base[] |
|
989 | + * @throws EE_Error |
|
990 | + */ |
|
991 | + public function inputs() |
|
992 | + { |
|
993 | + $inputs = array(); |
|
994 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
995 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
996 | + $inputs[ $subsection_name ] = $subsection; |
|
997 | + } |
|
998 | + } |
|
999 | + return $inputs; |
|
1000 | + } |
|
1001 | + |
|
1002 | + |
|
1003 | + /** |
|
1004 | + * Gets all the subsections which are a proper form |
|
1005 | + * |
|
1006 | + * @return EE_Form_Section_Proper[] |
|
1007 | + * @throws EE_Error |
|
1008 | + */ |
|
1009 | + public function subforms() |
|
1010 | + { |
|
1011 | + $form_sections = array(); |
|
1012 | + foreach ($this->subsections() as $name => $obj) { |
|
1013 | + if ($obj instanceof EE_Form_Section_Proper) { |
|
1014 | + $form_sections[ $name ] = $obj; |
|
1015 | + } |
|
1016 | + } |
|
1017 | + return $form_sections; |
|
1018 | + } |
|
1019 | + |
|
1020 | + |
|
1021 | + /** |
|
1022 | + * Gets all the subsections (inputs, proper subsections, or html-only sections). |
|
1023 | + * Consider using inputs() or subforms() |
|
1024 | + * if you only want form inputs or proper form sections. |
|
1025 | + * |
|
1026 | + * @param boolean $require_construction_to_be_finalized most client code should |
|
1027 | + * leave this as TRUE so that the inputs will be properly |
|
1028 | + * configured. However, some client code may be ok with |
|
1029 | + * construction finalize being called later |
|
1030 | + * (realizing that the subsections' html names might not be |
|
1031 | + * set yet, etc.) |
|
1032 | + * @return EE_Form_Section_Proper[] |
|
1033 | + * @throws EE_Error |
|
1034 | + */ |
|
1035 | + public function subsections($require_construction_to_be_finalized = true) |
|
1036 | + { |
|
1037 | + if ($require_construction_to_be_finalized) { |
|
1038 | + $this->ensure_construct_finalized_called(); |
|
1039 | + } |
|
1040 | + return $this->_subsections; |
|
1041 | + } |
|
1042 | + |
|
1043 | + |
|
1044 | + /** |
|
1045 | + * Returns whether this form has any subforms or inputs |
|
1046 | + * @return bool |
|
1047 | + */ |
|
1048 | + public function hasSubsections() |
|
1049 | + { |
|
1050 | + return ! empty($this->_subsections); |
|
1051 | + } |
|
1052 | + |
|
1053 | + |
|
1054 | + /** |
|
1055 | + * Returns a simple array where keys are input names, and values are their normalized |
|
1056 | + * values. (Similar to calling get_input_value on inputs) |
|
1057 | + * |
|
1058 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1059 | + * or just this forms' direct children inputs |
|
1060 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1061 | + * or allow multidimensional array |
|
1062 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1063 | + * with array keys being input names |
|
1064 | + * (regardless of whether they are from a subsection or not), |
|
1065 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1066 | + * where keys are always subsection names and values are either |
|
1067 | + * the input's normalized value, or an array like the top-level array |
|
1068 | + * @throws EE_Error |
|
1069 | + */ |
|
1070 | + public function input_values($include_subform_inputs = false, $flatten = false) |
|
1071 | + { |
|
1072 | + return $this->_input_values(false, $include_subform_inputs, $flatten); |
|
1073 | + } |
|
1074 | + |
|
1075 | + |
|
1076 | + /** |
|
1077 | + * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value' |
|
1078 | + * of each input. On some inputs (especially radio boxes or checkboxes), the value stored |
|
1079 | + * is not necessarily the value we want to display to users. This creates an array |
|
1080 | + * where keys are the input names, and values are their display values |
|
1081 | + * |
|
1082 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1083 | + * or just this forms' direct children inputs |
|
1084 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1085 | + * or allow multidimensional array |
|
1086 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1087 | + * with array keys being input names |
|
1088 | + * (regardless of whether they are from a subsection or not), |
|
1089 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1090 | + * where keys are always subsection names and values are either |
|
1091 | + * the input's normalized value, or an array like the top-level array |
|
1092 | + * @throws EE_Error |
|
1093 | + */ |
|
1094 | + public function input_pretty_values($include_subform_inputs = false, $flatten = false) |
|
1095 | + { |
|
1096 | + return $this->_input_values(true, $include_subform_inputs, $flatten); |
|
1097 | + } |
|
1098 | + |
|
1099 | + |
|
1100 | + /** |
|
1101 | + * Gets the input values from the form |
|
1102 | + * |
|
1103 | + * @param boolean $pretty Whether to retrieve the pretty value, |
|
1104 | + * or just the normalized value |
|
1105 | + * @param boolean $include_subform_inputs Whether to include inputs from subforms, |
|
1106 | + * or just this forms' direct children inputs |
|
1107 | + * @param boolean $flatten Whether to force the results into 1-dimensional array, |
|
1108 | + * or allow multidimensional array |
|
1109 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being |
|
1110 | + * input names (regardless of whether they are from a subsection or not), |
|
1111 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1112 | + * where keys are always subsection names and values are either |
|
1113 | + * the input's normalized value, or an array like the top-level array |
|
1114 | + * @throws EE_Error |
|
1115 | + */ |
|
1116 | + public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false) |
|
1117 | + { |
|
1118 | + $input_values = array(); |
|
1119 | + foreach ($this->subsections() as $subsection_name => $subsection) { |
|
1120 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1121 | + $input_values[ $subsection_name ] = $pretty |
|
1122 | + ? $subsection->pretty_value() |
|
1123 | + : $subsection->normalized_value(); |
|
1124 | + } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
|
1125 | + $subform_input_values = $subsection->_input_values( |
|
1126 | + $pretty, |
|
1127 | + $include_subform_inputs, |
|
1128 | + $flatten |
|
1129 | + ); |
|
1130 | + if ($flatten) { |
|
1131 | + $input_values = array_merge($input_values, $subform_input_values); |
|
1132 | + } else { |
|
1133 | + $input_values[ $subsection_name ] = $subform_input_values; |
|
1134 | + } |
|
1135 | + } |
|
1136 | + } |
|
1137 | + return $input_values; |
|
1138 | + } |
|
1139 | + |
|
1140 | + |
|
1141 | + /** |
|
1142 | + * Gets the originally submitted input values from the form |
|
1143 | + * |
|
1144 | + * @param boolean $include_subforms Whether to include inputs from subforms, |
|
1145 | + * or just this forms' direct children inputs |
|
1146 | + * @return array if $flatten is TRUE it will always be a 1-dimensional array |
|
1147 | + * with array keys being input names |
|
1148 | + * (regardless of whether they are from a subsection or not), |
|
1149 | + * and if $flatten is FALSE it can be a multidimensional array |
|
1150 | + * where keys are always subsection names and values are either |
|
1151 | + * the input's normalized value, or an array like the top-level array |
|
1152 | + * @throws EE_Error |
|
1153 | + */ |
|
1154 | + public function submitted_values($include_subforms = false) |
|
1155 | + { |
|
1156 | + $submitted_values = array(); |
|
1157 | + foreach ($this->subsections() as $subsection) { |
|
1158 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1159 | + // is this input part of an array of inputs? |
|
1160 | + if (strpos($subsection->html_name(), '[') !== false) { |
|
1161 | + $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | + explode( |
|
1163 | + '[', |
|
1164 | + str_replace(']', '', $subsection->html_name()) |
|
1165 | + ), |
|
1166 | + $subsection->raw_value() |
|
1167 | + ); |
|
1168 | + $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
|
1169 | + } else { |
|
1170 | + $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1171 | + } |
|
1172 | + } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
|
1173 | + $subform_input_values = $subsection->submitted_values($include_subforms); |
|
1174 | + $submitted_values = array_replace_recursive($submitted_values, $subform_input_values); |
|
1175 | + } |
|
1176 | + } |
|
1177 | + return $submitted_values; |
|
1178 | + } |
|
1179 | + |
|
1180 | + |
|
1181 | + /** |
|
1182 | + * Indicates whether or not this form has received a submission yet |
|
1183 | + * (ie, had receive_form_submission called on it yet) |
|
1184 | + * |
|
1185 | + * @return boolean |
|
1186 | + * @throws EE_Error |
|
1187 | + */ |
|
1188 | + public function has_received_submission() |
|
1189 | + { |
|
1190 | + $this->ensure_construct_finalized_called(); |
|
1191 | + return $this->_received_submission; |
|
1192 | + } |
|
1193 | + |
|
1194 | + |
|
1195 | + /** |
|
1196 | + * Equivalent to passing 'exclude' in the constructor's options array. |
|
1197 | + * Removes the listed inputs from the form |
|
1198 | + * |
|
1199 | + * @param array $inputs_to_exclude values are the input names |
|
1200 | + * @return void |
|
1201 | + */ |
|
1202 | + public function exclude(array $inputs_to_exclude = array()) |
|
1203 | + { |
|
1204 | + foreach ($inputs_to_exclude as $input_to_exclude_name) { |
|
1205 | + unset($this->_subsections[ $input_to_exclude_name ]); |
|
1206 | + } |
|
1207 | + } |
|
1208 | + |
|
1209 | + |
|
1210 | + /** |
|
1211 | + * @param array $inputs_to_hide |
|
1212 | + * @throws EE_Error |
|
1213 | + */ |
|
1214 | + public function hide(array $inputs_to_hide = array()) |
|
1215 | + { |
|
1216 | + foreach ($inputs_to_hide as $input_to_hide) { |
|
1217 | + $input = $this->get_input($input_to_hide); |
|
1218 | + $input->set_display_strategy(new EE_Hidden_Display_Strategy()); |
|
1219 | + } |
|
1220 | + } |
|
1221 | + |
|
1222 | + |
|
1223 | + /** |
|
1224 | + * add_subsections |
|
1225 | + * Adds the listed subsections to the form section. |
|
1226 | + * If $subsection_name_to_target is provided, |
|
1227 | + * then new subsections are added before or after that subsection, |
|
1228 | + * otherwise to the start or end of the entire subsections array. |
|
1229 | + * |
|
1230 | + * @param EE_Form_Section_Base[] $new_subsections array of new form subsections |
|
1231 | + * where keys are their names |
|
1232 | + * @param string $subsection_name_to_target an existing for section that $new_subsections |
|
1233 | + * should be added before or after |
|
1234 | + * IF $subsection_name_to_target is null, |
|
1235 | + * then $new_subsections will be added to |
|
1236 | + * the beginning or end of the entire subsections array |
|
1237 | + * @param boolean $add_before whether to add $new_subsections, before or after |
|
1238 | + * $subsection_name_to_target, |
|
1239 | + * or if $subsection_name_to_target is null, |
|
1240 | + * before or after entire subsections array |
|
1241 | + * @return void |
|
1242 | + * @throws EE_Error |
|
1243 | + */ |
|
1244 | + public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
|
1245 | + { |
|
1246 | + foreach ($new_subsections as $subsection_name => $subsection) { |
|
1247 | + if (! $subsection instanceof EE_Form_Section_Base) { |
|
1248 | + EE_Error::add_error( |
|
1249 | + sprintf( |
|
1250 | + esc_html__( |
|
1251 | + "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.", |
|
1252 | + 'event_espresso' |
|
1253 | + ), |
|
1254 | + get_class($subsection), |
|
1255 | + $subsection_name, |
|
1256 | + $this->name() |
|
1257 | + ) |
|
1258 | + ); |
|
1259 | + unset($new_subsections[ $subsection_name ]); |
|
1260 | + } |
|
1261 | + } |
|
1262 | + $this->_subsections = EEH_Array::insert_into_array( |
|
1263 | + $this->_subsections, |
|
1264 | + $new_subsections, |
|
1265 | + $subsection_name_to_target, |
|
1266 | + $add_before |
|
1267 | + ); |
|
1268 | + if ($this->_construction_finalized) { |
|
1269 | + foreach ($this->_subsections as $name => $subsection) { |
|
1270 | + $subsection->_construct_finalize($this, $name); |
|
1271 | + } |
|
1272 | + } |
|
1273 | + } |
|
1274 | + |
|
1275 | + |
|
1276 | + /** |
|
1277 | + * Just gets all validatable subsections to clean their sensitive data |
|
1278 | + * |
|
1279 | + * @throws EE_Error |
|
1280 | + */ |
|
1281 | + public function clean_sensitive_data() |
|
1282 | + { |
|
1283 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1284 | + $subsection->clean_sensitive_data(); |
|
1285 | + } |
|
1286 | + } |
|
1287 | + |
|
1288 | + |
|
1289 | + /** |
|
1290 | + * Sets the submission error message (aka validation error message for this form section and all sub-sections) |
|
1291 | + * @param string $form_submission_error_message |
|
1292 | + * @param EE_Form_Section_Validatable $form_section unused |
|
1293 | + * @throws EE_Error |
|
1294 | + */ |
|
1295 | + public function set_submission_error_message( |
|
1296 | + $form_submission_error_message = '' |
|
1297 | + ) { |
|
1298 | + $this->_form_submission_error_message = ! empty($form_submission_error_message) |
|
1299 | + ? $form_submission_error_message |
|
1300 | + : $this->getValidationErrorsAccumulatedString(); |
|
1301 | + } |
|
1302 | + |
|
1303 | + |
|
1304 | + /** |
|
1305 | + * Returns the cached error message. A default value is set for this during _validate(), |
|
1306 | + * (called during receive_form_submission) but it can be explicitly set using |
|
1307 | + * set_submission_error_message |
|
1308 | + * |
|
1309 | + * @return string |
|
1310 | + */ |
|
1311 | + public function submission_error_message() |
|
1312 | + { |
|
1313 | + return $this->_form_submission_error_message; |
|
1314 | + } |
|
1315 | + |
|
1316 | + |
|
1317 | + /** |
|
1318 | + * Sets a message to display if the data submitted to the form was valid. |
|
1319 | + * @param string $form_submission_success_message |
|
1320 | + */ |
|
1321 | + public function set_submission_success_message($form_submission_success_message = '') |
|
1322 | + { |
|
1323 | + $this->_form_submission_success_message = ! empty($form_submission_success_message) |
|
1324 | + ? $form_submission_success_message |
|
1325 | + : esc_html__('Form submitted successfully', 'event_espresso'); |
|
1326 | + } |
|
1327 | + |
|
1328 | + |
|
1329 | + /** |
|
1330 | + * Gets a message appropriate for display when the form is correctly submitted |
|
1331 | + * @return string |
|
1332 | + */ |
|
1333 | + public function submission_success_message() |
|
1334 | + { |
|
1335 | + return $this->_form_submission_success_message; |
|
1336 | + } |
|
1337 | + |
|
1338 | + |
|
1339 | + /** |
|
1340 | + * Returns the prefix that should be used on child of this form section for |
|
1341 | + * their html names. If this form section itself has a parent, prepends ITS |
|
1342 | + * prefix onto this form section's prefix. Used primarily by |
|
1343 | + * EE_Form_Input_Base::_set_default_html_name_if_empty |
|
1344 | + * |
|
1345 | + * @return string |
|
1346 | + * @throws EE_Error |
|
1347 | + */ |
|
1348 | + public function html_name_prefix() |
|
1349 | + { |
|
1350 | + if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
|
1351 | + return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1352 | + } |
|
1353 | + return $this->name(); |
|
1354 | + } |
|
1355 | + |
|
1356 | + |
|
1357 | + /** |
|
1358 | + * Gets the name, but first checks _construct_finalize has been called. If not, |
|
1359 | + * calls it (assumes there is no parent and that we want the name to be whatever |
|
1360 | + * was set, which is probably nothing, or the classname) |
|
1361 | + * |
|
1362 | + * @return string |
|
1363 | + * @throws EE_Error |
|
1364 | + */ |
|
1365 | + public function name() |
|
1366 | + { |
|
1367 | + $this->ensure_construct_finalized_called(); |
|
1368 | + return parent::name(); |
|
1369 | + } |
|
1370 | + |
|
1371 | + |
|
1372 | + /** |
|
1373 | + * @return EE_Form_Section_Proper |
|
1374 | + * @throws EE_Error |
|
1375 | + */ |
|
1376 | + public function parent_section() |
|
1377 | + { |
|
1378 | + $this->ensure_construct_finalized_called(); |
|
1379 | + return parent::parent_section(); |
|
1380 | + } |
|
1381 | + |
|
1382 | + |
|
1383 | + /** |
|
1384 | + * make sure construction finalized was called, otherwise children might not be ready |
|
1385 | + * |
|
1386 | + * @return void |
|
1387 | + * @throws EE_Error |
|
1388 | + */ |
|
1389 | + public function ensure_construct_finalized_called() |
|
1390 | + { |
|
1391 | + if (! $this->_construction_finalized) { |
|
1392 | + $this->_construct_finalize($this->_parent_section, $this->_name); |
|
1393 | + } |
|
1394 | + } |
|
1395 | + |
|
1396 | + |
|
1397 | + /** |
|
1398 | + * Checks if any of this form section's inputs, or any of its children's inputs, |
|
1399 | + * are in teh form data. If any are found, returns true. Else false |
|
1400 | + * |
|
1401 | + * @param array $req_data |
|
1402 | + * @return boolean |
|
1403 | + * @throws EE_Error |
|
1404 | + */ |
|
1405 | + public function form_data_present_in($req_data = null) |
|
1406 | + { |
|
1407 | + $req_data = $this->getCachedRequest($req_data); |
|
1408 | + foreach ($this->subsections() as $subsection) { |
|
1409 | + if ($subsection instanceof EE_Form_Input_Base) { |
|
1410 | + if ($subsection->form_data_present_in($req_data)) { |
|
1411 | + return true; |
|
1412 | + } |
|
1413 | + } elseif ($subsection instanceof EE_Form_Section_Proper) { |
|
1414 | + if ($subsection->form_data_present_in($req_data)) { |
|
1415 | + return true; |
|
1416 | + } |
|
1417 | + } |
|
1418 | + } |
|
1419 | + return false; |
|
1420 | + } |
|
1421 | + |
|
1422 | + |
|
1423 | + /** |
|
1424 | + * Gets validation errors for this form section and subsections |
|
1425 | + * Similar to EE_Form_Section_Validatable::get_validation_errors() except this |
|
1426 | + * gets the validation errors for ALL subsection |
|
1427 | + * |
|
1428 | + * @return EE_Validation_Error[] |
|
1429 | + * @throws EE_Error |
|
1430 | + */ |
|
1431 | + public function get_validation_errors_accumulated() |
|
1432 | + { |
|
1433 | + $validation_errors = $this->get_validation_errors(); |
|
1434 | + foreach ($this->get_validatable_subsections() as $subsection) { |
|
1435 | + if ($subsection instanceof EE_Form_Section_Proper) { |
|
1436 | + $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated(); |
|
1437 | + } else { |
|
1438 | + $validation_errors_on_this_subsection = $subsection->get_validation_errors(); |
|
1439 | + } |
|
1440 | + if ($validation_errors_on_this_subsection) { |
|
1441 | + $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection); |
|
1442 | + } |
|
1443 | + } |
|
1444 | + return $validation_errors; |
|
1445 | + } |
|
1446 | + |
|
1447 | + /** |
|
1448 | + * Fetch validation errors from children and grandchildren and puts them in a single string. |
|
1449 | + * This traverses the form section tree to generate this, but you probably want to instead use |
|
1450 | + * get_form_submission_error_message() which is usually this message cached (or a custom validation error message) |
|
1451 | + * |
|
1452 | + * @return string |
|
1453 | + */ |
|
1454 | + protected function getValidationErrorsAccumulatedString() |
|
1455 | + { |
|
1456 | + $submission_error_messages = array(); |
|
1457 | + // bad, bad, bad registrant |
|
1458 | + foreach ($this->get_validation_errors_accumulated() as $validation_error) { |
|
1459 | + if ($validation_error instanceof EE_Validation_Error) { |
|
1460 | + $form_section = $validation_error->get_form_section(); |
|
1461 | + if ($form_section instanceof EE_Form_Input_Base) { |
|
1462 | + $label = $validation_error->get_form_section()->html_label_text(); |
|
1463 | + } elseif($form_section instanceof EE_Form_Section_Validatable) { |
|
1464 | + $label = $validation_error->get_form_section()->name(); |
|
1465 | + } else { |
|
1466 | + $label = esc_html__('Unknown', 'event_espresso'); |
|
1467 | + } |
|
1468 | + $submission_error_messages[] = sprintf( |
|
1469 | + __('%s : %s', 'event_espresso'), |
|
1470 | + $label, |
|
1471 | + $validation_error->getMessage() |
|
1472 | + ); |
|
1473 | + } |
|
1474 | + } |
|
1475 | + return implode('<br', $submission_error_messages); |
|
1476 | + } |
|
1477 | + |
|
1478 | + |
|
1479 | + /** |
|
1480 | + * This isn't just the name of an input, it's a path pointing to an input. The |
|
1481 | + * path is similar to a folder path: slash (/) means to descend into a subsection, |
|
1482 | + * dot-dot-slash (../) means to ascend into the parent section. |
|
1483 | + * After a series of slashes and dot-dot-slashes, there should be the name of an input, |
|
1484 | + * which will be returned. |
|
1485 | + * Eg, if you want the related input to be conditional on a sibling input name 'foobar' |
|
1486 | + * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name |
|
1487 | + * 'baz', use '../baz'. If you want it to be conditional on a cousin input, |
|
1488 | + * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'. |
|
1489 | + * Etc |
|
1490 | + * |
|
1491 | + * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false |
|
1492 | + * @return EE_Form_Section_Base |
|
1493 | + * @throws EE_Error |
|
1494 | + */ |
|
1495 | + public function find_section_from_path($form_section_path) |
|
1496 | + { |
|
1497 | + //check if we can find the input from purely going straight up the tree |
|
1498 | + $input = parent::find_section_from_path($form_section_path); |
|
1499 | + if ($input instanceof EE_Form_Section_Base) { |
|
1500 | + return $input; |
|
1501 | + } |
|
1502 | + $next_slash_pos = strpos($form_section_path, '/'); |
|
1503 | + if ($next_slash_pos !== false) { |
|
1504 | + $child_section_name = substr($form_section_path, 0, $next_slash_pos); |
|
1505 | + $subpath = substr($form_section_path, $next_slash_pos + 1); |
|
1506 | + } else { |
|
1507 | + $child_section_name = $form_section_path; |
|
1508 | + $subpath = ''; |
|
1509 | + } |
|
1510 | + $child_section = $this->get_subsection($child_section_name); |
|
1511 | + if ($child_section instanceof EE_Form_Section_Base) { |
|
1512 | + return $child_section->find_section_from_path($subpath); |
|
1513 | + } |
|
1514 | + return null; |
|
1515 | + } |
|
1516 | 1516 | } |
1517 | 1517 |
@@ -111,8 +111,8 @@ discard block |
||
111 | 111 | //AND we are going to make sure they're in that specified order |
112 | 112 | $reordered_subsections = array(); |
113 | 113 | foreach ($options_array['include'] as $input_name) { |
114 | - if (isset($this->_subsections[ $input_name ])) { |
|
115 | - $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ]; |
|
114 | + if (isset($this->_subsections[$input_name])) { |
|
115 | + $reordered_subsections[$input_name] = $this->_subsections[$input_name]; |
|
116 | 116 | } |
117 | 117 | } |
118 | 118 | $this->_subsections = $reordered_subsections; |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | if (isset($options_array['layout_strategy'])) { |
125 | 125 | $this->_layout_strategy = $options_array['layout_strategy']; |
126 | 126 | } |
127 | - if (! $this->_layout_strategy) { |
|
127 | + if ( ! $this->_layout_strategy) { |
|
128 | 128 | $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout(); |
129 | 129 | } |
130 | 130 | $this->_layout_strategy->_construct_finalize($this); |
@@ -277,7 +277,7 @@ discard block |
||
277 | 277 | $req_data, |
278 | 278 | $this |
279 | 279 | ); |
280 | - $this->cached_request_data = (array)$req_data; |
|
280 | + $this->cached_request_data = (array) $req_data; |
|
281 | 281 | } |
282 | 282 | return $this->cached_request_data; |
283 | 283 | } |
@@ -313,7 +313,7 @@ discard block |
||
313 | 313 | if ($validate) { |
314 | 314 | $this->_validate(); |
315 | 315 | //if it's invalid, we're going to want to re-display so remember what they submitted |
316 | - if (! $this->is_valid()) { |
|
316 | + if ( ! $this->is_valid()) { |
|
317 | 317 | $this->store_submitted_form_data_in_session(); |
318 | 318 | } |
319 | 319 | } |
@@ -426,11 +426,11 @@ discard block |
||
426 | 426 | public function populate_defaults($default_data) |
427 | 427 | { |
428 | 428 | foreach ($this->subsections(false) as $subsection_name => $subsection) { |
429 | - if (isset($default_data[ $subsection_name ])) { |
|
429 | + if (isset($default_data[$subsection_name])) { |
|
430 | 430 | if ($subsection instanceof EE_Form_Input_Base) { |
431 | - $subsection->set_default($default_data[ $subsection_name ]); |
|
431 | + $subsection->set_default($default_data[$subsection_name]); |
|
432 | 432 | } elseif ($subsection instanceof EE_Form_Section_Proper) { |
433 | - $subsection->populate_defaults($default_data[ $subsection_name ]); |
|
433 | + $subsection->populate_defaults($default_data[$subsection_name]); |
|
434 | 434 | } |
435 | 435 | } |
436 | 436 | } |
@@ -445,7 +445,7 @@ discard block |
||
445 | 445 | */ |
446 | 446 | public function subsection_exists($name) |
447 | 447 | { |
448 | - return isset($this->_subsections[ $name ]) ? true : false; |
|
448 | + return isset($this->_subsections[$name]) ? true : false; |
|
449 | 449 | } |
450 | 450 | |
451 | 451 | |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | if ($require_construction_to_be_finalized) { |
468 | 468 | $this->ensure_construct_finalized_called(); |
469 | 469 | } |
470 | - return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null; |
|
470 | + return $this->subsection_exists($name) ? $this->_subsections[$name] : null; |
|
471 | 471 | } |
472 | 472 | |
473 | 473 | |
@@ -482,7 +482,7 @@ discard block |
||
482 | 482 | $validatable_subsections = array(); |
483 | 483 | foreach ($this->subsections() as $name => $obj) { |
484 | 484 | if ($obj instanceof EE_Form_Section_Validatable) { |
485 | - $validatable_subsections[ $name ] = $obj; |
|
485 | + $validatable_subsections[$name] = $obj; |
|
486 | 486 | } |
487 | 487 | } |
488 | 488 | return $validatable_subsections; |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | $name, |
510 | 510 | $require_construction_to_be_finalized |
511 | 511 | ); |
512 | - if (! $subsection instanceof EE_Form_Input_Base) { |
|
512 | + if ( ! $subsection instanceof EE_Form_Input_Base) { |
|
513 | 513 | throw new EE_Error( |
514 | 514 | sprintf( |
515 | 515 | esc_html__( |
@@ -546,7 +546,7 @@ discard block |
||
546 | 546 | $name, |
547 | 547 | $require_construction_to_be_finalized |
548 | 548 | ); |
549 | - if (! $subsection instanceof EE_Form_Section_Proper) { |
|
549 | + if ( ! $subsection instanceof EE_Form_Section_Proper) { |
|
550 | 550 | throw new EE_Error( |
551 | 551 | sprintf( |
552 | 552 | esc_html__( |
@@ -585,8 +585,8 @@ discard block |
||
585 | 585 | */ |
586 | 586 | public function is_valid() |
587 | 587 | { |
588 | - if($this->is_valid === null) { |
|
589 | - if (! $this->has_received_submission()) { |
|
588 | + if ($this->is_valid === null) { |
|
589 | + if ( ! $this->has_received_submission()) { |
|
590 | 590 | throw new EE_Error( |
591 | 591 | sprintf( |
592 | 592 | esc_html__( |
@@ -596,14 +596,14 @@ discard block |
||
596 | 596 | ) |
597 | 597 | ); |
598 | 598 | } |
599 | - if (! parent::is_valid()) { |
|
599 | + if ( ! parent::is_valid()) { |
|
600 | 600 | $this->is_valid = false; |
601 | 601 | } else { |
602 | 602 | // ok so no general errors to this entire form section. |
603 | 603 | // so let's check the subsections, but only set errors if that hasn't been done yet |
604 | 604 | $this->is_valid = true; |
605 | 605 | foreach ($this->get_validatable_subsections() as $subsection) { |
606 | - if (! $subsection->is_valid()) { |
|
606 | + if ( ! $subsection->is_valid()) { |
|
607 | 607 | $this->is_valid = false; |
608 | 608 | } |
609 | 609 | } |
@@ -620,7 +620,7 @@ discard block |
||
620 | 620 | */ |
621 | 621 | protected function _set_default_name_if_empty() |
622 | 622 | { |
623 | - if (! $this->_name) { |
|
623 | + if ( ! $this->_name) { |
|
624 | 624 | $classname = get_class($this); |
625 | 625 | $default_name = str_replace('EE_', '', $classname); |
626 | 626 | $this->_name = $default_name; |
@@ -710,7 +710,7 @@ discard block |
||
710 | 710 | { |
711 | 711 | wp_register_script( |
712 | 712 | 'ee_form_section_validation', |
713 | - EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js', |
|
713 | + EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js', |
|
714 | 714 | array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'), |
715 | 715 | EVENT_ESPRESSO_VERSION, |
716 | 716 | true |
@@ -754,13 +754,13 @@ discard block |
||
754 | 754 | // we only want to localize vars ONCE for the entire form, |
755 | 755 | // so if the form section doesn't have a parent, then it must be the top dog |
756 | 756 | if ($return_for_subsection || ! $this->parent_section()) { |
757 | - EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array( |
|
757 | + EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array( |
|
758 | 758 | 'form_section_id' => $this->html_id(true), |
759 | 759 | 'validation_rules' => $this->get_jquery_validation_rules(), |
760 | 760 | 'other_data' => $this->get_other_js_data(), |
761 | 761 | 'errors' => $this->subsection_validation_errors_by_html_name(), |
762 | 762 | ); |
763 | - EE_Form_Section_Proper::$_scripts_localized = true; |
|
763 | + EE_Form_Section_Proper::$_scripts_localized = true; |
|
764 | 764 | } |
765 | 765 | } |
766 | 766 | |
@@ -795,7 +795,7 @@ discard block |
||
795 | 795 | $inputs = array(); |
796 | 796 | foreach ($this->subsections() as $subsection) { |
797 | 797 | if ($subsection instanceof EE_Form_Input_Base) { |
798 | - $inputs[ $subsection->html_name() ] = $subsection; |
|
798 | + $inputs[$subsection->html_name()] = $subsection; |
|
799 | 799 | } elseif ($subsection instanceof EE_Form_Section_Proper) { |
800 | 800 | $inputs += $subsection->inputs_in_subsections(); |
801 | 801 | } |
@@ -818,7 +818,7 @@ discard block |
||
818 | 818 | $errors = array(); |
819 | 819 | foreach ($inputs as $form_input) { |
820 | 820 | if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) { |
821 | - $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string(); |
|
821 | + $errors[$form_input->html_name()] = $form_input->get_validation_error_string(); |
|
822 | 822 | } |
823 | 823 | } |
824 | 824 | return $errors; |
@@ -841,7 +841,7 @@ discard block |
||
841 | 841 | $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level) |
842 | 842 | ? EE_Registry::instance()->CFG->registration->email_validation_level |
843 | 843 | : 'wp_default'; |
844 | - EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
844 | + EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level; |
|
845 | 845 | wp_enqueue_script('ee_form_section_validation'); |
846 | 846 | wp_localize_script( |
847 | 847 | 'ee_form_section_validation', |
@@ -858,7 +858,7 @@ discard block |
||
858 | 858 | */ |
859 | 859 | public function ensure_scripts_localized() |
860 | 860 | { |
861 | - if (! EE_Form_Section_Proper::$_scripts_localized) { |
|
861 | + if ( ! EE_Form_Section_Proper::$_scripts_localized) { |
|
862 | 862 | $this->_enqueue_and_localize_form_js(); |
863 | 863 | } |
864 | 864 | } |
@@ -954,8 +954,8 @@ discard block |
||
954 | 954 | //reset the cache of whether this form is valid or not- we're re-validating it now |
955 | 955 | $this->is_valid = null; |
956 | 956 | foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) { |
957 | - if (method_exists($this, '_validate_' . $subsection_name)) { |
|
958 | - call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection)); |
|
957 | + if (method_exists($this, '_validate_'.$subsection_name)) { |
|
958 | + call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection)); |
|
959 | 959 | } |
960 | 960 | $subsection->_validate(); |
961 | 961 | } |
@@ -973,9 +973,9 @@ discard block |
||
973 | 973 | $inputs = array(); |
974 | 974 | foreach ($this->subsections() as $subsection_name => $subsection) { |
975 | 975 | if ($subsection instanceof EE_Form_Section_Proper) { |
976 | - $inputs[ $subsection_name ] = $subsection->valid_data(); |
|
976 | + $inputs[$subsection_name] = $subsection->valid_data(); |
|
977 | 977 | } elseif ($subsection instanceof EE_Form_Input_Base) { |
978 | - $inputs[ $subsection_name ] = $subsection->normalized_value(); |
|
978 | + $inputs[$subsection_name] = $subsection->normalized_value(); |
|
979 | 979 | } |
980 | 980 | } |
981 | 981 | return $inputs; |
@@ -993,7 +993,7 @@ discard block |
||
993 | 993 | $inputs = array(); |
994 | 994 | foreach ($this->subsections() as $subsection_name => $subsection) { |
995 | 995 | if ($subsection instanceof EE_Form_Input_Base) { |
996 | - $inputs[ $subsection_name ] = $subsection; |
|
996 | + $inputs[$subsection_name] = $subsection; |
|
997 | 997 | } |
998 | 998 | } |
999 | 999 | return $inputs; |
@@ -1011,7 +1011,7 @@ discard block |
||
1011 | 1011 | $form_sections = array(); |
1012 | 1012 | foreach ($this->subsections() as $name => $obj) { |
1013 | 1013 | if ($obj instanceof EE_Form_Section_Proper) { |
1014 | - $form_sections[ $name ] = $obj; |
|
1014 | + $form_sections[$name] = $obj; |
|
1015 | 1015 | } |
1016 | 1016 | } |
1017 | 1017 | return $form_sections; |
@@ -1118,7 +1118,7 @@ discard block |
||
1118 | 1118 | $input_values = array(); |
1119 | 1119 | foreach ($this->subsections() as $subsection_name => $subsection) { |
1120 | 1120 | if ($subsection instanceof EE_Form_Input_Base) { |
1121 | - $input_values[ $subsection_name ] = $pretty |
|
1121 | + $input_values[$subsection_name] = $pretty |
|
1122 | 1122 | ? $subsection->pretty_value() |
1123 | 1123 | : $subsection->normalized_value(); |
1124 | 1124 | } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) { |
@@ -1130,7 +1130,7 @@ discard block |
||
1130 | 1130 | if ($flatten) { |
1131 | 1131 | $input_values = array_merge($input_values, $subform_input_values); |
1132 | 1132 | } else { |
1133 | - $input_values[ $subsection_name ] = $subform_input_values; |
|
1133 | + $input_values[$subsection_name] = $subform_input_values; |
|
1134 | 1134 | } |
1135 | 1135 | } |
1136 | 1136 | } |
@@ -1158,7 +1158,7 @@ discard block |
||
1158 | 1158 | if ($subsection instanceof EE_Form_Input_Base) { |
1159 | 1159 | // is this input part of an array of inputs? |
1160 | 1160 | if (strpos($subsection->html_name(), '[') !== false) { |
1161 | - $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1161 | + $full_input_name = EEH_Array::convert_array_values_to_keys( |
|
1162 | 1162 | explode( |
1163 | 1163 | '[', |
1164 | 1164 | str_replace(']', '', $subsection->html_name()) |
@@ -1167,7 +1167,7 @@ discard block |
||
1167 | 1167 | ); |
1168 | 1168 | $submitted_values = array_replace_recursive($submitted_values, $full_input_name); |
1169 | 1169 | } else { |
1170 | - $submitted_values[ $subsection->html_name() ] = $subsection->raw_value(); |
|
1170 | + $submitted_values[$subsection->html_name()] = $subsection->raw_value(); |
|
1171 | 1171 | } |
1172 | 1172 | } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) { |
1173 | 1173 | $subform_input_values = $subsection->submitted_values($include_subforms); |
@@ -1202,7 +1202,7 @@ discard block |
||
1202 | 1202 | public function exclude(array $inputs_to_exclude = array()) |
1203 | 1203 | { |
1204 | 1204 | foreach ($inputs_to_exclude as $input_to_exclude_name) { |
1205 | - unset($this->_subsections[ $input_to_exclude_name ]); |
|
1205 | + unset($this->_subsections[$input_to_exclude_name]); |
|
1206 | 1206 | } |
1207 | 1207 | } |
1208 | 1208 | |
@@ -1244,7 +1244,7 @@ discard block |
||
1244 | 1244 | public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true) |
1245 | 1245 | { |
1246 | 1246 | foreach ($new_subsections as $subsection_name => $subsection) { |
1247 | - if (! $subsection instanceof EE_Form_Section_Base) { |
|
1247 | + if ( ! $subsection instanceof EE_Form_Section_Base) { |
|
1248 | 1248 | EE_Error::add_error( |
1249 | 1249 | sprintf( |
1250 | 1250 | esc_html__( |
@@ -1256,7 +1256,7 @@ discard block |
||
1256 | 1256 | $this->name() |
1257 | 1257 | ) |
1258 | 1258 | ); |
1259 | - unset($new_subsections[ $subsection_name ]); |
|
1259 | + unset($new_subsections[$subsection_name]); |
|
1260 | 1260 | } |
1261 | 1261 | } |
1262 | 1262 | $this->_subsections = EEH_Array::insert_into_array( |
@@ -1348,7 +1348,7 @@ discard block |
||
1348 | 1348 | public function html_name_prefix() |
1349 | 1349 | { |
1350 | 1350 | if ($this->parent_section() instanceof EE_Form_Section_Proper) { |
1351 | - return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']'; |
|
1351 | + return $this->parent_section()->html_name_prefix().'['.$this->name().']'; |
|
1352 | 1352 | } |
1353 | 1353 | return $this->name(); |
1354 | 1354 | } |
@@ -1388,7 +1388,7 @@ discard block |
||
1388 | 1388 | */ |
1389 | 1389 | public function ensure_construct_finalized_called() |
1390 | 1390 | { |
1391 | - if (! $this->_construction_finalized) { |
|
1391 | + if ( ! $this->_construction_finalized) { |
|
1392 | 1392 | $this->_construct_finalize($this->_parent_section, $this->_name); |
1393 | 1393 | } |
1394 | 1394 | } |
@@ -1460,7 +1460,7 @@ discard block |
||
1460 | 1460 | $form_section = $validation_error->get_form_section(); |
1461 | 1461 | if ($form_section instanceof EE_Form_Input_Base) { |
1462 | 1462 | $label = $validation_error->get_form_section()->html_label_text(); |
1463 | - } elseif($form_section instanceof EE_Form_Section_Validatable) { |
|
1463 | + } elseif ($form_section instanceof EE_Form_Section_Validatable) { |
|
1464 | 1464 | $label = $validation_error->get_form_section()->name(); |
1465 | 1465 | } else { |
1466 | 1466 | $label = esc_html__('Unknown', 'event_espresso'); |
@@ -5,7 +5,7 @@ discard block |
||
5 | 5 | use EventEspresso\core\exceptions\InvalidEntityException; |
6 | 6 | |
7 | 7 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
8 | - exit('No direct script access allowed'); |
|
8 | + exit('No direct script access allowed'); |
|
9 | 9 | } |
10 | 10 | |
11 | 11 | |
@@ -20,1850 +20,1850 @@ discard block |
||
20 | 20 | class EED_Single_Page_Checkout extends EED_Module |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * $_initialized - has the SPCO controller already been initialized ? |
|
25 | - * |
|
26 | - * @access private |
|
27 | - * @var bool $_initialized |
|
28 | - */ |
|
29 | - private static $_initialized = false; |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * $_checkout_verified - is the EE_Checkout verified as correct for this request ? |
|
34 | - * |
|
35 | - * @access private |
|
36 | - * @var bool $_valid_checkout |
|
37 | - */ |
|
38 | - private static $_checkout_verified = true; |
|
39 | - |
|
40 | - /** |
|
41 | - * $_reg_steps_array - holds initial array of reg steps |
|
42 | - * |
|
43 | - * @access private |
|
44 | - * @var array $_reg_steps_array |
|
45 | - */ |
|
46 | - private static $_reg_steps_array = array(); |
|
47 | - |
|
48 | - /** |
|
49 | - * $checkout - EE_Checkout object for handling the properties of the current checkout process |
|
50 | - * |
|
51 | - * @access public |
|
52 | - * @var EE_Checkout $checkout |
|
53 | - */ |
|
54 | - public $checkout; |
|
55 | - |
|
56 | - |
|
57 | - |
|
58 | - /** |
|
59 | - * @return EED_Module|EED_Single_Page_Checkout |
|
60 | - */ |
|
61 | - public static function instance() |
|
62 | - { |
|
63 | - add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true'); |
|
64 | - return parent::get_instance(__CLASS__); |
|
65 | - } |
|
66 | - |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @return EE_CART |
|
71 | - */ |
|
72 | - public function cart() |
|
73 | - { |
|
74 | - return $this->checkout->cart; |
|
75 | - } |
|
76 | - |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * @return EE_Transaction |
|
81 | - */ |
|
82 | - public function transaction() |
|
83 | - { |
|
84 | - return $this->checkout->transaction; |
|
85 | - } |
|
86 | - |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * set_hooks - for hooking into EE Core, other modules, etc |
|
91 | - * |
|
92 | - * @access public |
|
93 | - * @return void |
|
94 | - * @throws EE_Error |
|
95 | - */ |
|
96 | - public static function set_hooks() |
|
97 | - { |
|
98 | - EED_Single_Page_Checkout::set_definitions(); |
|
99 | - } |
|
100 | - |
|
101 | - |
|
102 | - |
|
103 | - /** |
|
104 | - * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
105 | - * |
|
106 | - * @access public |
|
107 | - * @return void |
|
108 | - * @throws EE_Error |
|
109 | - */ |
|
110 | - public static function set_hooks_admin() |
|
111 | - { |
|
112 | - EED_Single_Page_Checkout::set_definitions(); |
|
113 | - if ( ! (defined('DOING_AJAX') && DOING_AJAX)) { |
|
114 | - return; |
|
115 | - } |
|
116 | - // going to start an output buffer in case anything gets accidentally output |
|
117 | - // that might disrupt our JSON response |
|
118 | - ob_start(); |
|
119 | - EED_Single_Page_Checkout::load_request_handler(); |
|
120 | - EED_Single_Page_Checkout::load_reg_steps(); |
|
121 | - // set ajax hooks |
|
122 | - add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step')); |
|
123 | - add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step')); |
|
124 | - add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step')); |
|
125 | - add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step')); |
|
126 | - add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step')); |
|
127 | - add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step')); |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - |
|
132 | - /** |
|
133 | - * process ajax request |
|
134 | - * |
|
135 | - * @param string $ajax_action |
|
136 | - * @throws EE_Error |
|
137 | - */ |
|
138 | - public static function process_ajax_request($ajax_action) |
|
139 | - { |
|
140 | - EE_Registry::instance()->REQ->set('action', $ajax_action); |
|
141 | - EED_Single_Page_Checkout::instance()->_initialize(); |
|
142 | - } |
|
143 | - |
|
144 | - |
|
145 | - |
|
146 | - /** |
|
147 | - * ajax display registration step |
|
148 | - * |
|
149 | - * @throws EE_Error |
|
150 | - */ |
|
151 | - public static function display_reg_step() |
|
152 | - { |
|
153 | - EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step'); |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * ajax process registration step |
|
160 | - * |
|
161 | - * @throws EE_Error |
|
162 | - */ |
|
163 | - public static function process_reg_step() |
|
164 | - { |
|
165 | - EED_Single_Page_Checkout::process_ajax_request('process_reg_step'); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - |
|
170 | - /** |
|
171 | - * ajax process registration step |
|
172 | - * |
|
173 | - * @throws EE_Error |
|
174 | - */ |
|
175 | - public static function update_reg_step() |
|
176 | - { |
|
177 | - EED_Single_Page_Checkout::process_ajax_request('update_reg_step'); |
|
178 | - } |
|
179 | - |
|
180 | - |
|
181 | - |
|
182 | - /** |
|
183 | - * update_checkout |
|
184 | - * |
|
185 | - * @access public |
|
186 | - * @return void |
|
187 | - * @throws EE_Error |
|
188 | - */ |
|
189 | - public static function update_checkout() |
|
190 | - { |
|
191 | - EED_Single_Page_Checkout::process_ajax_request('update_checkout'); |
|
192 | - } |
|
193 | - |
|
194 | - |
|
195 | - |
|
196 | - /** |
|
197 | - * load_request_handler |
|
198 | - * |
|
199 | - * @access public |
|
200 | - * @return void |
|
201 | - */ |
|
202 | - public static function load_request_handler() |
|
203 | - { |
|
204 | - // load core Request_Handler class |
|
205 | - if (EE_Registry::instance()->REQ !== null) { |
|
206 | - EE_Registry::instance()->load_core('Request_Handler'); |
|
207 | - } |
|
208 | - } |
|
209 | - |
|
210 | - |
|
211 | - |
|
212 | - /** |
|
213 | - * set_definitions |
|
214 | - * |
|
215 | - * @access public |
|
216 | - * @return void |
|
217 | - * @throws EE_Error |
|
218 | - */ |
|
219 | - public static function set_definitions() |
|
220 | - { |
|
221 | - if(defined('SPCO_BASE_PATH')) { |
|
222 | - return; |
|
223 | - } |
|
224 | - define( |
|
225 | - 'SPCO_BASE_PATH', |
|
226 | - rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS |
|
227 | - ); |
|
228 | - define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS); |
|
229 | - define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS); |
|
230 | - define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS); |
|
231 | - define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS); |
|
232 | - define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS); |
|
233 | - define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS); |
|
234 | - EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true); |
|
235 | - EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf( |
|
236 | - __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s', |
|
237 | - 'event_espresso'), |
|
238 | - '<h4 class="important-notice">', |
|
239 | - '</h4>', |
|
240 | - '<br />', |
|
241 | - '<p>', |
|
242 | - '<a href="' . get_post_type_archive_link('espresso_events') . '" title="', |
|
243 | - '">', |
|
244 | - '</a>', |
|
245 | - '</p>' |
|
246 | - ); |
|
247 | - } |
|
248 | - |
|
249 | - |
|
250 | - |
|
251 | - /** |
|
252 | - * load_reg_steps |
|
253 | - * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array |
|
254 | - * |
|
255 | - * @access private |
|
256 | - * @throws EE_Error |
|
257 | - */ |
|
258 | - public static function load_reg_steps() |
|
259 | - { |
|
260 | - static $reg_steps_loaded = false; |
|
261 | - if ($reg_steps_loaded) { |
|
262 | - return; |
|
263 | - } |
|
264 | - // filter list of reg_steps |
|
265 | - $reg_steps_to_load = (array)apply_filters( |
|
266 | - 'AHEE__SPCO__load_reg_steps__reg_steps_to_load', |
|
267 | - EED_Single_Page_Checkout::get_reg_steps() |
|
268 | - ); |
|
269 | - // sort by key (order) |
|
270 | - ksort($reg_steps_to_load); |
|
271 | - // loop through folders |
|
272 | - foreach ($reg_steps_to_load as $order => $reg_step) { |
|
273 | - // we need a |
|
274 | - if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) { |
|
275 | - // copy over to the reg_steps_array |
|
276 | - EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step; |
|
277 | - // register custom key route for each reg step |
|
278 | - // ie: step=>"slug" - this is the entire reason we load the reg steps array now |
|
279 | - EE_Config::register_route( |
|
280 | - $reg_step['slug'], |
|
281 | - 'EED_Single_Page_Checkout', |
|
282 | - 'run', |
|
283 | - 'step' |
|
284 | - ); |
|
285 | - // add AJAX or other hooks |
|
286 | - if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) { |
|
287 | - // setup autoloaders if necessary |
|
288 | - if ( ! class_exists($reg_step['class_name'])) { |
|
289 | - EEH_Autoloader::register_autoloaders_for_each_file_in_folder( |
|
290 | - $reg_step['file_path'], |
|
291 | - true |
|
292 | - ); |
|
293 | - } |
|
294 | - if (is_callable($reg_step['class_name'], 'set_hooks')) { |
|
295 | - call_user_func(array($reg_step['class_name'], 'set_hooks')); |
|
296 | - } |
|
297 | - } |
|
298 | - } |
|
299 | - } |
|
300 | - $reg_steps_loaded = true; |
|
301 | - } |
|
302 | - |
|
303 | - |
|
304 | - |
|
305 | - /** |
|
306 | - * get_reg_steps |
|
307 | - * |
|
308 | - * @access public |
|
309 | - * @return array |
|
310 | - */ |
|
311 | - public static function get_reg_steps() |
|
312 | - { |
|
313 | - $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps; |
|
314 | - if (empty($reg_steps)) { |
|
315 | - $reg_steps = array( |
|
316 | - 10 => array( |
|
317 | - 'file_path' => SPCO_REG_STEPS_PATH . 'attendee_information', |
|
318 | - 'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information', |
|
319 | - 'slug' => 'attendee_information', |
|
320 | - 'has_hooks' => false, |
|
321 | - ), |
|
322 | - 20 => array( |
|
323 | - 'file_path' => SPCO_REG_STEPS_PATH . 'registration_confirmation', |
|
324 | - 'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation', |
|
325 | - 'slug' => 'registration_confirmation', |
|
326 | - 'has_hooks' => false, |
|
327 | - ), |
|
328 | - 30 => array( |
|
329 | - 'file_path' => SPCO_REG_STEPS_PATH . 'payment_options', |
|
330 | - 'class_name' => 'EE_SPCO_Reg_Step_Payment_Options', |
|
331 | - 'slug' => 'payment_options', |
|
332 | - 'has_hooks' => true, |
|
333 | - ), |
|
334 | - 999 => array( |
|
335 | - 'file_path' => SPCO_REG_STEPS_PATH . 'finalize_registration', |
|
336 | - 'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration', |
|
337 | - 'slug' => 'finalize_registration', |
|
338 | - 'has_hooks' => false, |
|
339 | - ), |
|
340 | - ); |
|
341 | - } |
|
342 | - return $reg_steps; |
|
343 | - } |
|
344 | - |
|
345 | - |
|
346 | - |
|
347 | - /** |
|
348 | - * registration_checkout_for_admin |
|
349 | - * |
|
350 | - * @access public |
|
351 | - * @return string |
|
352 | - * @throws EE_Error |
|
353 | - */ |
|
354 | - public static function registration_checkout_for_admin() |
|
355 | - { |
|
356 | - EED_Single_Page_Checkout::load_request_handler(); |
|
357 | - EE_Registry::instance()->REQ->set('step', 'attendee_information'); |
|
358 | - EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step'); |
|
359 | - EE_Registry::instance()->REQ->set('process_form_submission', false); |
|
360 | - EED_Single_Page_Checkout::instance()->_initialize(); |
|
361 | - EED_Single_Page_Checkout::instance()->_display_spco_reg_form(); |
|
362 | - return EE_Registry::instance()->REQ->get_output(); |
|
363 | - } |
|
364 | - |
|
365 | - |
|
366 | - |
|
367 | - /** |
|
368 | - * process_registration_from_admin |
|
369 | - * |
|
370 | - * @access public |
|
371 | - * @return \EE_Transaction |
|
372 | - * @throws EE_Error |
|
373 | - */ |
|
374 | - public static function process_registration_from_admin() |
|
375 | - { |
|
376 | - EED_Single_Page_Checkout::load_request_handler(); |
|
377 | - EE_Registry::instance()->REQ->set('step', 'attendee_information'); |
|
378 | - EE_Registry::instance()->REQ->set('action', 'process_reg_step'); |
|
379 | - EE_Registry::instance()->REQ->set('process_form_submission', true); |
|
380 | - EED_Single_Page_Checkout::instance()->_initialize(); |
|
381 | - if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) { |
|
382 | - $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps); |
|
383 | - if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) { |
|
384 | - EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step); |
|
385 | - if ($final_reg_step->process_reg_step()) { |
|
386 | - $final_reg_step->set_completed(); |
|
387 | - EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array(); |
|
388 | - return EED_Single_Page_Checkout::instance()->checkout->transaction; |
|
389 | - } |
|
390 | - } |
|
391 | - } |
|
392 | - return null; |
|
393 | - } |
|
394 | - |
|
395 | - |
|
396 | - |
|
397 | - /** |
|
398 | - * run |
|
399 | - * |
|
400 | - * @access public |
|
401 | - * @param WP_Query $WP_Query |
|
402 | - * @return void |
|
403 | - * @throws EE_Error |
|
404 | - */ |
|
405 | - public function run($WP_Query) |
|
406 | - { |
|
407 | - if ( |
|
408 | - $WP_Query instanceof WP_Query |
|
409 | - && $WP_Query->is_main_query() |
|
410 | - && apply_filters('FHEE__EED_Single_Page_Checkout__run', true) |
|
411 | - && $this->_is_reg_checkout() |
|
412 | - ) { |
|
413 | - $this->_initialize(); |
|
414 | - } |
|
415 | - } |
|
416 | - |
|
417 | - |
|
418 | - |
|
419 | - /** |
|
420 | - * determines whether current url matches reg page url |
|
421 | - * |
|
422 | - * @return bool |
|
423 | - */ |
|
424 | - protected function _is_reg_checkout() |
|
425 | - { |
|
426 | - // get current permalink for reg page without any extra query args |
|
427 | - $reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id); |
|
428 | - // get request URI for current request, but without the scheme or host |
|
429 | - $current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI'); |
|
430 | - $current_request_uri = html_entity_decode($current_request_uri); |
|
431 | - // get array of query args from the current request URI |
|
432 | - $query_args = \EEH_URL::get_query_string($current_request_uri); |
|
433 | - // grab page id if it is set |
|
434 | - $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0; |
|
435 | - // and remove the page id from the query args (we will re-add it later) |
|
436 | - unset($query_args['page_id']); |
|
437 | - // now strip all query args from current request URI |
|
438 | - $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri); |
|
439 | - // and re-add the page id if it was set |
|
440 | - if ($page_id) { |
|
441 | - $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri); |
|
442 | - } |
|
443 | - // remove slashes and ? |
|
444 | - $current_request_uri = trim($current_request_uri, '?/'); |
|
445 | - // is current request URI part of the known full reg page URL ? |
|
446 | - return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false; |
|
447 | - } |
|
448 | - |
|
449 | - |
|
450 | - |
|
451 | - /** |
|
452 | - * @param WP_Query $wp_query |
|
453 | - * @return void |
|
454 | - * @throws EE_Error |
|
455 | - */ |
|
456 | - public static function init($wp_query) |
|
457 | - { |
|
458 | - EED_Single_Page_Checkout::instance()->run($wp_query); |
|
459 | - } |
|
460 | - |
|
461 | - |
|
462 | - |
|
463 | - /** |
|
464 | - * _initialize - initial module setup |
|
465 | - * |
|
466 | - * @access private |
|
467 | - * @throws EE_Error |
|
468 | - * @return void |
|
469 | - */ |
|
470 | - private function _initialize() |
|
471 | - { |
|
472 | - // ensure SPCO doesn't run twice |
|
473 | - if (EED_Single_Page_Checkout::$_initialized) { |
|
474 | - return; |
|
475 | - } |
|
476 | - try { |
|
477 | - EED_Single_Page_Checkout::load_reg_steps(); |
|
478 | - $this->_verify_session(); |
|
479 | - // setup the EE_Checkout object |
|
480 | - $this->checkout = $this->_initialize_checkout(); |
|
481 | - // filter checkout |
|
482 | - $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout); |
|
483 | - // get the $_GET |
|
484 | - $this->_get_request_vars(); |
|
485 | - if ($this->_block_bots()) { |
|
486 | - return; |
|
487 | - } |
|
488 | - // filter continue_reg |
|
489 | - $this->checkout->continue_reg = apply_filters( |
|
490 | - 'FHEE__EED_Single_Page_Checkout__init___continue_reg', |
|
491 | - true, |
|
492 | - $this->checkout |
|
493 | - ); |
|
494 | - // load the reg steps array |
|
495 | - if ( ! $this->_load_and_instantiate_reg_steps()) { |
|
496 | - EED_Single_Page_Checkout::$_initialized = true; |
|
497 | - return; |
|
498 | - } |
|
499 | - // set the current step |
|
500 | - $this->checkout->set_current_step($this->checkout->step); |
|
501 | - // and the next step |
|
502 | - $this->checkout->set_next_step(); |
|
503 | - // verify that everything has been setup correctly |
|
504 | - if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) { |
|
505 | - EED_Single_Page_Checkout::$_initialized = true; |
|
506 | - return; |
|
507 | - } |
|
508 | - // lock the transaction |
|
509 | - $this->checkout->transaction->lock(); |
|
510 | - // make sure all of our cached objects are added to their respective model entity mappers |
|
511 | - $this->checkout->refresh_all_entities(); |
|
512 | - // set amount owing |
|
513 | - $this->checkout->amount_owing = $this->checkout->transaction->remaining(); |
|
514 | - // initialize each reg step, which gives them the chance to potentially alter the process |
|
515 | - $this->_initialize_reg_steps(); |
|
516 | - // DEBUG LOG |
|
517 | - //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ ); |
|
518 | - // get reg form |
|
519 | - if( ! $this->_check_form_submission()) { |
|
520 | - EED_Single_Page_Checkout::$_initialized = true; |
|
521 | - return; |
|
522 | - } |
|
523 | - // checkout the action!!! |
|
524 | - $this->_process_form_action(); |
|
525 | - // add some style and make it dance |
|
526 | - $this->add_styles_and_scripts(); |
|
527 | - // kk... SPCO has successfully run |
|
528 | - EED_Single_Page_Checkout::$_initialized = true; |
|
529 | - // set no cache headers and constants |
|
530 | - EE_System::do_not_cache(); |
|
531 | - // add anchor |
|
532 | - add_action('loop_start', array($this, 'set_checkout_anchor'), 1); |
|
533 | - // remove transaction lock |
|
534 | - add_action('shutdown', array($this, 'unlock_transaction'), 1); |
|
535 | - } catch (Exception $e) { |
|
536 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
537 | - } |
|
538 | - } |
|
539 | - |
|
540 | - |
|
541 | - |
|
542 | - /** |
|
543 | - * _verify_session |
|
544 | - * checks that the session is valid and not expired |
|
545 | - * |
|
546 | - * @access private |
|
547 | - * @throws EE_Error |
|
548 | - */ |
|
549 | - private function _verify_session() |
|
550 | - { |
|
551 | - if ( ! EE_Registry::instance()->SSN instanceof EE_Session) { |
|
552 | - throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso')); |
|
553 | - } |
|
554 | - $clear_session_requested = filter_var( |
|
555 | - EE_Registry::instance()->REQ->get('clear_session', false), |
|
556 | - FILTER_VALIDATE_BOOLEAN |
|
557 | - ); |
|
558 | - // is session still valid ? |
|
559 | - if ($clear_session_requested |
|
560 | - || ( EE_Registry::instance()->SSN->expired() |
|
561 | - && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === '' |
|
562 | - ) |
|
563 | - ) { |
|
564 | - $this->checkout = new EE_Checkout(); |
|
565 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
566 | - // EE_Registry::instance()->SSN->reset_cart(); |
|
567 | - // EE_Registry::instance()->SSN->reset_checkout(); |
|
568 | - // EE_Registry::instance()->SSN->reset_transaction(); |
|
569 | - if (! $clear_session_requested) { |
|
570 | - EE_Error::add_attention( |
|
571 | - EE_Registry::$i18n_js_strings['registration_expiration_notice'], |
|
572 | - __FILE__, __FUNCTION__, __LINE__ |
|
573 | - ); |
|
574 | - } |
|
575 | - // EE_Registry::instance()->SSN->reset_expired(); |
|
576 | - } |
|
577 | - } |
|
578 | - |
|
579 | - |
|
580 | - |
|
581 | - /** |
|
582 | - * _initialize_checkout |
|
583 | - * loads and instantiates EE_Checkout |
|
584 | - * |
|
585 | - * @access private |
|
586 | - * @throws EE_Error |
|
587 | - * @return EE_Checkout |
|
588 | - */ |
|
589 | - private function _initialize_checkout() |
|
590 | - { |
|
591 | - // look in session for existing checkout |
|
592 | - /** @type EE_Checkout $checkout */ |
|
593 | - $checkout = EE_Registry::instance()->SSN->checkout(); |
|
594 | - // verify |
|
595 | - if ( ! $checkout instanceof EE_Checkout) { |
|
596 | - // instantiate EE_Checkout object for handling the properties of the current checkout process |
|
597 | - $checkout = EE_Registry::instance()->load_file( |
|
598 | - SPCO_INC_PATH, |
|
599 | - 'EE_Checkout', |
|
600 | - 'class', array(), |
|
601 | - false |
|
602 | - ); |
|
603 | - } else { |
|
604 | - if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) { |
|
605 | - $this->unlock_transaction(); |
|
606 | - wp_safe_redirect($checkout->redirect_url); |
|
607 | - exit(); |
|
608 | - } |
|
609 | - } |
|
610 | - $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout); |
|
611 | - // verify again |
|
612 | - if ( ! $checkout instanceof EE_Checkout) { |
|
613 | - throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso')); |
|
614 | - } |
|
615 | - // reset anything that needs a clean slate for each request |
|
616 | - $checkout->reset_for_current_request(); |
|
617 | - return $checkout; |
|
618 | - } |
|
619 | - |
|
620 | - |
|
621 | - |
|
622 | - /** |
|
623 | - * _get_request_vars |
|
624 | - * |
|
625 | - * @access private |
|
626 | - * @return void |
|
627 | - * @throws EE_Error |
|
628 | - */ |
|
629 | - private function _get_request_vars() |
|
630 | - { |
|
631 | - // load classes |
|
632 | - EED_Single_Page_Checkout::load_request_handler(); |
|
633 | - //make sure this request is marked as belonging to EE |
|
634 | - EE_Registry::instance()->REQ->set_espresso_page(true); |
|
635 | - // which step is being requested ? |
|
636 | - $this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step()); |
|
637 | - // which step is being edited ? |
|
638 | - $this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', ''); |
|
639 | - // and what we're doing on the current step |
|
640 | - $this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step'); |
|
641 | - // timestamp |
|
642 | - $this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0); |
|
643 | - // returning to edit ? |
|
644 | - $this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', ''); |
|
645 | - // add reg url link to registration query params |
|
646 | - if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) { |
|
647 | - $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link; |
|
648 | - } |
|
649 | - // or some other kind of revisit ? |
|
650 | - $this->checkout->revisit = filter_var( |
|
651 | - EE_Registry::instance()->REQ->get('revisit', false), |
|
652 | - FILTER_VALIDATE_BOOLEAN |
|
653 | - ); |
|
654 | - // and whether or not to generate a reg form for this request |
|
655 | - $this->checkout->generate_reg_form = filter_var( |
|
656 | - EE_Registry::instance()->REQ->get('generate_reg_form', true), |
|
657 | - FILTER_VALIDATE_BOOLEAN |
|
658 | - ); |
|
659 | - // and whether or not to process a reg form submission for this request |
|
660 | - $this->checkout->process_form_submission = filter_var( |
|
661 | - EE_Registry::instance()->REQ->get( |
|
662 | - 'process_form_submission', |
|
663 | - $this->checkout->action === 'process_reg_step' |
|
664 | - ), |
|
665 | - FILTER_VALIDATE_BOOLEAN |
|
666 | - ); |
|
667 | - $this->checkout->process_form_submission = filter_var( |
|
668 | - $this->checkout->action !== 'display_spco_reg_step' |
|
669 | - ? $this->checkout->process_form_submission |
|
670 | - : false, |
|
671 | - FILTER_VALIDATE_BOOLEAN |
|
672 | - ); |
|
673 | - // $this->_display_request_vars(); |
|
674 | - } |
|
675 | - |
|
676 | - |
|
677 | - |
|
678 | - /** |
|
679 | - * _display_request_vars |
|
680 | - * |
|
681 | - * @access protected |
|
682 | - * @return void |
|
683 | - */ |
|
684 | - protected function _display_request_vars() |
|
685 | - { |
|
686 | - if ( ! WP_DEBUG) { |
|
687 | - return; |
|
688 | - } |
|
689 | - EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__); |
|
690 | - EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__); |
|
691 | - EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__); |
|
692 | - EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__); |
|
693 | - EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__); |
|
694 | - EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__); |
|
695 | - EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__); |
|
696 | - EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__); |
|
697 | - } |
|
698 | - |
|
699 | - |
|
700 | - |
|
701 | - /** |
|
702 | - * _block_bots |
|
703 | - * checks that the incoming request has either of the following set: |
|
704 | - * a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector |
|
705 | - * a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN |
|
706 | - * so if you're not coming from the Ticket Selector nor returning for a valid IP... |
|
707 | - * then where you coming from man? |
|
708 | - * |
|
709 | - * @return boolean |
|
710 | - */ |
|
711 | - private function _block_bots() |
|
712 | - { |
|
713 | - $invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess(); |
|
714 | - if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) { |
|
715 | - return true; |
|
716 | - } |
|
717 | - return false; |
|
718 | - } |
|
719 | - |
|
720 | - |
|
721 | - |
|
722 | - /** |
|
723 | - * _get_first_step |
|
724 | - * gets slug for first step in $_reg_steps_array |
|
725 | - * |
|
726 | - * @access private |
|
727 | - * @throws EE_Error |
|
728 | - * @return string |
|
729 | - */ |
|
730 | - private function _get_first_step() |
|
731 | - { |
|
732 | - $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array); |
|
733 | - return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information'; |
|
734 | - } |
|
735 | - |
|
736 | - |
|
737 | - |
|
738 | - /** |
|
739 | - * _load_and_instantiate_reg_steps |
|
740 | - * instantiates each reg step based on the loaded reg_steps array |
|
741 | - * |
|
742 | - * @access private |
|
743 | - * @throws EE_Error |
|
744 | - * @return bool |
|
745 | - */ |
|
746 | - private function _load_and_instantiate_reg_steps() |
|
747 | - { |
|
748 | - do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout); |
|
749 | - // have reg_steps already been instantiated ? |
|
750 | - if ( |
|
751 | - empty($this->checkout->reg_steps) |
|
752 | - || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout) |
|
753 | - ) { |
|
754 | - // if not, then loop through raw reg steps array |
|
755 | - foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) { |
|
756 | - if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) { |
|
757 | - return false; |
|
758 | - } |
|
759 | - } |
|
760 | - EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true; |
|
761 | - EE_Registry::instance()->CFG->registration->reg_confirmation_last = true; |
|
762 | - // skip the registration_confirmation page ? |
|
763 | - if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) { |
|
764 | - // just remove it from the reg steps array |
|
765 | - $this->checkout->remove_reg_step('registration_confirmation', false); |
|
766 | - } else if ( |
|
767 | - isset($this->checkout->reg_steps['registration_confirmation']) |
|
768 | - && EE_Registry::instance()->CFG->registration->reg_confirmation_last |
|
769 | - ) { |
|
770 | - // set the order to something big like 100 |
|
771 | - $this->checkout->set_reg_step_order('registration_confirmation', 100); |
|
772 | - } |
|
773 | - // filter the array for good luck |
|
774 | - $this->checkout->reg_steps = apply_filters( |
|
775 | - 'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps', |
|
776 | - $this->checkout->reg_steps |
|
777 | - ); |
|
778 | - // finally re-sort based on the reg step class order properties |
|
779 | - $this->checkout->sort_reg_steps(); |
|
780 | - } else { |
|
781 | - foreach ($this->checkout->reg_steps as $reg_step) { |
|
782 | - // set all current step stati to FALSE |
|
783 | - $reg_step->set_is_current_step(false); |
|
784 | - } |
|
785 | - } |
|
786 | - if (empty($this->checkout->reg_steps)) { |
|
787 | - EE_Error::add_error( |
|
788 | - __('No Reg Steps were loaded..', 'event_espresso'), |
|
789 | - __FILE__, __FUNCTION__, __LINE__ |
|
790 | - ); |
|
791 | - return false; |
|
792 | - } |
|
793 | - // make reg step details available to JS |
|
794 | - $this->checkout->set_reg_step_JSON_info(); |
|
795 | - return true; |
|
796 | - } |
|
797 | - |
|
798 | - |
|
799 | - |
|
800 | - /** |
|
801 | - * _load_and_instantiate_reg_step |
|
802 | - * |
|
803 | - * @access private |
|
804 | - * @param array $reg_step |
|
805 | - * @param int $order |
|
806 | - * @return bool |
|
807 | - */ |
|
808 | - private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0) |
|
809 | - { |
|
810 | - // we need a file_path, class_name, and slug to add a reg step |
|
811 | - if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) { |
|
812 | - // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step) |
|
813 | - if ( |
|
814 | - $this->checkout->reg_url_link |
|
815 | - && $this->checkout->step !== $reg_step['slug'] |
|
816 | - && $reg_step['slug'] !== 'finalize_registration' |
|
817 | - // normally at this point we would NOT load the reg step, but this filter can change that |
|
818 | - && apply_filters( |
|
819 | - 'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step', |
|
820 | - true, |
|
821 | - $reg_step, |
|
822 | - $this->checkout |
|
823 | - ) |
|
824 | - ) { |
|
825 | - return true; |
|
826 | - } |
|
827 | - // instantiate step class using file path and class name |
|
828 | - $reg_step_obj = EE_Registry::instance()->load_file( |
|
829 | - $reg_step['file_path'], |
|
830 | - $reg_step['class_name'], |
|
831 | - 'class', |
|
832 | - $this->checkout, |
|
833 | - false |
|
834 | - ); |
|
835 | - // did we gets the goods ? |
|
836 | - if ($reg_step_obj instanceof EE_SPCO_Reg_Step) { |
|
837 | - // set reg step order based on config |
|
838 | - $reg_step_obj->set_order($order); |
|
839 | - // add instantiated reg step object to the master reg steps array |
|
840 | - $this->checkout->add_reg_step($reg_step_obj); |
|
841 | - } else { |
|
842 | - EE_Error::add_error( |
|
843 | - __('The current step could not be set.', 'event_espresso'), |
|
844 | - __FILE__, __FUNCTION__, __LINE__ |
|
845 | - ); |
|
846 | - return false; |
|
847 | - } |
|
848 | - } else { |
|
849 | - if (WP_DEBUG) { |
|
850 | - EE_Error::add_error( |
|
851 | - sprintf( |
|
852 | - __( |
|
853 | - 'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s', |
|
854 | - 'event_espresso' |
|
855 | - ), |
|
856 | - isset($reg_step['file_path']) ? $reg_step['file_path'] : '', |
|
857 | - isset($reg_step['class_name']) ? $reg_step['class_name'] : '', |
|
858 | - isset($reg_step['slug']) ? $reg_step['slug'] : '', |
|
859 | - '<ul>', |
|
860 | - '<li>', |
|
861 | - '</li>', |
|
862 | - '</ul>' |
|
863 | - ), |
|
864 | - __FILE__, __FUNCTION__, __LINE__ |
|
865 | - ); |
|
866 | - } |
|
867 | - return false; |
|
868 | - } |
|
869 | - return true; |
|
870 | - } |
|
871 | - |
|
872 | - |
|
873 | - /** |
|
874 | - * _verify_transaction_and_get_registrations |
|
875 | - * |
|
876 | - * @access private |
|
877 | - * @return bool |
|
878 | - * @throws InvalidDataTypeException |
|
879 | - * @throws InvalidEntityException |
|
880 | - * @throws EE_Error |
|
881 | - */ |
|
882 | - private function _verify_transaction_and_get_registrations() |
|
883 | - { |
|
884 | - // was there already a valid transaction in the checkout from the session ? |
|
885 | - if ( ! $this->checkout->transaction instanceof EE_Transaction) { |
|
886 | - // get transaction from db or session |
|
887 | - $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin() |
|
888 | - ? $this->_get_transaction_and_cart_for_previous_visit() |
|
889 | - : $this->_get_cart_for_current_session_and_setup_new_transaction(); |
|
890 | - if ( ! $this->checkout->transaction instanceof EE_Transaction) { |
|
891 | - EE_Error::add_error( |
|
892 | - __('Your Registration and Transaction information could not be retrieved from the db.', |
|
893 | - 'event_espresso'), |
|
894 | - __FILE__, __FUNCTION__, __LINE__ |
|
895 | - ); |
|
896 | - $this->checkout->transaction = EE_Transaction::new_instance(); |
|
897 | - // add some style and make it dance |
|
898 | - $this->add_styles_and_scripts(); |
|
899 | - EED_Single_Page_Checkout::$_initialized = true; |
|
900 | - return false; |
|
901 | - } |
|
902 | - // and the registrations for the transaction |
|
903 | - $this->_get_registrations($this->checkout->transaction); |
|
904 | - } |
|
905 | - return true; |
|
906 | - } |
|
907 | - |
|
908 | - |
|
909 | - |
|
910 | - /** |
|
911 | - * _get_transaction_and_cart_for_previous_visit |
|
912 | - * |
|
913 | - * @access private |
|
914 | - * @return mixed EE_Transaction|NULL |
|
915 | - */ |
|
916 | - private function _get_transaction_and_cart_for_previous_visit() |
|
917 | - { |
|
918 | - /** @var $TXN_model EEM_Transaction */ |
|
919 | - $TXN_model = EE_Registry::instance()->load_model('Transaction'); |
|
920 | - // because the reg_url_link is present in the request, |
|
921 | - // this is a return visit to SPCO, so we'll get the transaction data from the db |
|
922 | - $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link); |
|
923 | - // verify transaction |
|
924 | - if ($transaction instanceof EE_Transaction) { |
|
925 | - // and get the cart that was used for that transaction |
|
926 | - $this->checkout->cart = $this->_get_cart_for_transaction($transaction); |
|
927 | - return $transaction; |
|
928 | - } |
|
929 | - EE_Error::add_error( |
|
930 | - __('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'), |
|
931 | - __FILE__, __FUNCTION__, __LINE__ |
|
932 | - ); |
|
933 | - return null; |
|
934 | - |
|
935 | - } |
|
936 | - |
|
937 | - |
|
938 | - |
|
939 | - /** |
|
940 | - * _get_cart_for_transaction |
|
941 | - * |
|
942 | - * @access private |
|
943 | - * @param EE_Transaction $transaction |
|
944 | - * @return EE_Cart |
|
945 | - */ |
|
946 | - private function _get_cart_for_transaction($transaction) |
|
947 | - { |
|
948 | - return $this->checkout->get_cart_for_transaction($transaction); |
|
949 | - } |
|
950 | - |
|
951 | - |
|
952 | - |
|
953 | - /** |
|
954 | - * get_cart_for_transaction |
|
955 | - * |
|
956 | - * @access public |
|
957 | - * @param EE_Transaction $transaction |
|
958 | - * @return EE_Cart |
|
959 | - */ |
|
960 | - public function get_cart_for_transaction(EE_Transaction $transaction) |
|
961 | - { |
|
962 | - return $this->checkout->get_cart_for_transaction($transaction); |
|
963 | - } |
|
964 | - |
|
965 | - |
|
966 | - |
|
967 | - /** |
|
968 | - * _get_transaction_and_cart_for_current_session |
|
969 | - * generates a new EE_Transaction object and adds it to the $_transaction property. |
|
970 | - * |
|
971 | - * @access private |
|
972 | - * @return EE_Transaction |
|
973 | - * @throws EE_Error |
|
974 | - */ |
|
975 | - private function _get_cart_for_current_session_and_setup_new_transaction() |
|
976 | - { |
|
977 | - // if there's no transaction, then this is the FIRST visit to SPCO |
|
978 | - // so load up the cart ( passing nothing for the TXN because it doesn't exist yet ) |
|
979 | - $this->checkout->cart = $this->_get_cart_for_transaction(null); |
|
980 | - // and then create a new transaction |
|
981 | - $transaction = $this->_initialize_transaction(); |
|
982 | - // verify transaction |
|
983 | - if ($transaction instanceof EE_Transaction) { |
|
984 | - // save it so that we have an ID for other objects to use |
|
985 | - $transaction->save(); |
|
986 | - // and save TXN data to the cart |
|
987 | - $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID()); |
|
988 | - } else { |
|
989 | - EE_Error::add_error( |
|
990 | - __('A Valid Transaction could not be initialized.', 'event_espresso'), |
|
991 | - __FILE__, __FUNCTION__, __LINE__ |
|
992 | - ); |
|
993 | - } |
|
994 | - return $transaction; |
|
995 | - } |
|
996 | - |
|
997 | - |
|
998 | - |
|
999 | - /** |
|
1000 | - * generates a new EE_Transaction object and adds it to the $_transaction property. |
|
1001 | - * |
|
1002 | - * @access private |
|
1003 | - * @return mixed EE_Transaction|NULL |
|
1004 | - */ |
|
1005 | - private function _initialize_transaction() |
|
1006 | - { |
|
1007 | - try { |
|
1008 | - // ensure cart totals have been calculated |
|
1009 | - $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes(); |
|
1010 | - // grab the cart grand total |
|
1011 | - $cart_total = $this->checkout->cart->get_cart_grand_total(); |
|
1012 | - // create new TXN |
|
1013 | - $transaction = EE_Transaction::new_instance( |
|
1014 | - array( |
|
1015 | - 'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(), |
|
1016 | - 'TXN_total' => $cart_total > 0 ? $cart_total : 0, |
|
1017 | - 'TXN_paid' => 0, |
|
1018 | - 'STS_ID' => EEM_Transaction::failed_status_code, |
|
1019 | - ) |
|
1020 | - ); |
|
1021 | - // save it so that we have an ID for other objects to use |
|
1022 | - $transaction->save(); |
|
1023 | - // set cron job for following up on TXNs after their session has expired |
|
1024 | - EE_Cron_Tasks::schedule_expired_transaction_check( |
|
1025 | - EE_Registry::instance()->SSN->expiration() + 1, |
|
1026 | - $transaction->ID() |
|
1027 | - ); |
|
1028 | - return $transaction; |
|
1029 | - } catch (Exception $e) { |
|
1030 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1031 | - } |
|
1032 | - return null; |
|
1033 | - } |
|
1034 | - |
|
1035 | - |
|
1036 | - /** |
|
1037 | - * _get_registrations |
|
1038 | - * |
|
1039 | - * @access private |
|
1040 | - * @param EE_Transaction $transaction |
|
1041 | - * @return void |
|
1042 | - * @throws InvalidDataTypeException |
|
1043 | - * @throws InvalidEntityException |
|
1044 | - * @throws EE_Error |
|
1045 | - */ |
|
1046 | - private function _get_registrations(EE_Transaction $transaction) |
|
1047 | - { |
|
1048 | - // first step: grab the registrants { : o |
|
1049 | - $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false); |
|
1050 | - $this->checkout->total_ticket_count = count($registrations); |
|
1051 | - // verify registrations have been set |
|
1052 | - if (empty($registrations)) { |
|
1053 | - // if no cached registrations, then check the db |
|
1054 | - $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false); |
|
1055 | - // still nothing ? well as long as this isn't a revisit |
|
1056 | - if (empty($registrations) && ! $this->checkout->revisit) { |
|
1057 | - // generate new registrations from scratch |
|
1058 | - $registrations = $this->_initialize_registrations($transaction); |
|
1059 | - } |
|
1060 | - } |
|
1061 | - // sort by their original registration order |
|
1062 | - usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count')); |
|
1063 | - // then loop thru the array |
|
1064 | - foreach ($registrations as $registration) { |
|
1065 | - // verify each registration |
|
1066 | - if ($registration instanceof EE_Registration) { |
|
1067 | - // we display all attendee info for the primary registrant |
|
1068 | - if ($this->checkout->reg_url_link === $registration->reg_url_link() |
|
1069 | - && $registration->is_primary_registrant() |
|
1070 | - ) { |
|
1071 | - $this->checkout->primary_revisit = true; |
|
1072 | - break; |
|
1073 | - } |
|
1074 | - if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) { |
|
1075 | - // but hide info if it doesn't belong to you |
|
1076 | - $transaction->clear_cache('Registration', $registration->ID()); |
|
1077 | - $this->checkout->total_ticket_count--; |
|
1078 | - } |
|
1079 | - $this->checkout->set_reg_status_updated($registration->ID(), false); |
|
1080 | - } |
|
1081 | - } |
|
1082 | - } |
|
1083 | - |
|
1084 | - |
|
1085 | - /** |
|
1086 | - * adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object |
|
1087 | - * |
|
1088 | - * @access private |
|
1089 | - * @param EE_Transaction $transaction |
|
1090 | - * @return array |
|
1091 | - * @throws InvalidDataTypeException |
|
1092 | - * @throws InvalidEntityException |
|
1093 | - * @throws EE_Error |
|
1094 | - */ |
|
1095 | - private function _initialize_registrations(EE_Transaction $transaction) |
|
1096 | - { |
|
1097 | - $att_nmbr = 0; |
|
1098 | - $registrations = array(); |
|
1099 | - if ($transaction instanceof EE_Transaction) { |
|
1100 | - /** @type EE_Registration_Processor $registration_processor */ |
|
1101 | - $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
1102 | - $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count(); |
|
1103 | - // now let's add the cart items to the $transaction |
|
1104 | - foreach ($this->checkout->cart->get_tickets() as $line_item) { |
|
1105 | - //do the following for each ticket of this type they selected |
|
1106 | - for ($x = 1; $x <= $line_item->quantity(); $x++) { |
|
1107 | - $att_nmbr++; |
|
1108 | - /** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */ |
|
1109 | - $CreateRegistrationCommand = EE_Registry::instance()->create( |
|
1110 | - 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
1111 | - array( |
|
1112 | - $transaction, |
|
1113 | - $line_item, |
|
1114 | - $att_nmbr, |
|
1115 | - $this->checkout->total_ticket_count, |
|
1116 | - ) |
|
1117 | - ); |
|
1118 | - // override capabilities for frontend registrations |
|
1119 | - if ( ! is_admin()) { |
|
1120 | - $CreateRegistrationCommand->setCapCheck( |
|
1121 | - new PublicCapabilities('', 'create_new_registration') |
|
1122 | - ); |
|
1123 | - } |
|
1124 | - $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand); |
|
1125 | - if ( ! $registration instanceof EE_Registration) { |
|
1126 | - throw new InvalidEntityException($registration, 'EE_Registration'); |
|
1127 | - } |
|
1128 | - $registrations[ $registration->ID() ] = $registration; |
|
1129 | - } |
|
1130 | - } |
|
1131 | - $registration_processor->fix_reg_final_price_rounding_issue($transaction); |
|
1132 | - } |
|
1133 | - return $registrations; |
|
1134 | - } |
|
1135 | - |
|
1136 | - |
|
1137 | - |
|
1138 | - /** |
|
1139 | - * sorts registrations by REG_count |
|
1140 | - * |
|
1141 | - * @access public |
|
1142 | - * @param EE_Registration $reg_A |
|
1143 | - * @param EE_Registration $reg_B |
|
1144 | - * @return int |
|
1145 | - */ |
|
1146 | - public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B) |
|
1147 | - { |
|
1148 | - // this shouldn't ever happen within the same TXN, but oh well |
|
1149 | - if ($reg_A->count() === $reg_B->count()) { |
|
1150 | - return 0; |
|
1151 | - } |
|
1152 | - return ($reg_A->count() > $reg_B->count()) ? 1 : -1; |
|
1153 | - } |
|
1154 | - |
|
1155 | - |
|
1156 | - |
|
1157 | - /** |
|
1158 | - * _final_verifications |
|
1159 | - * just makes sure that everything is set up correctly before proceeding |
|
1160 | - * |
|
1161 | - * @access private |
|
1162 | - * @return bool |
|
1163 | - * @throws EE_Error |
|
1164 | - */ |
|
1165 | - private function _final_verifications() |
|
1166 | - { |
|
1167 | - // filter checkout |
|
1168 | - $this->checkout = apply_filters( |
|
1169 | - 'FHEE__EED_Single_Page_Checkout___final_verifications__checkout', |
|
1170 | - $this->checkout |
|
1171 | - ); |
|
1172 | - //verify that current step is still set correctly |
|
1173 | - if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) { |
|
1174 | - EE_Error::add_error( |
|
1175 | - __('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'), |
|
1176 | - __FILE__, |
|
1177 | - __FUNCTION__, |
|
1178 | - __LINE__ |
|
1179 | - ); |
|
1180 | - return false; |
|
1181 | - } |
|
1182 | - // if returning to SPCO, then verify that primary registrant is set |
|
1183 | - if ( ! empty($this->checkout->reg_url_link)) { |
|
1184 | - $valid_registrant = $this->checkout->transaction->primary_registration(); |
|
1185 | - if ( ! $valid_registrant instanceof EE_Registration) { |
|
1186 | - EE_Error::add_error( |
|
1187 | - __('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'), |
|
1188 | - __FILE__, |
|
1189 | - __FUNCTION__, |
|
1190 | - __LINE__ |
|
1191 | - ); |
|
1192 | - return false; |
|
1193 | - } |
|
1194 | - $valid_registrant = null; |
|
1195 | - foreach ( |
|
1196 | - $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration |
|
1197 | - ) { |
|
1198 | - if ( |
|
1199 | - $registration instanceof EE_Registration |
|
1200 | - && $registration->reg_url_link() === $this->checkout->reg_url_link |
|
1201 | - ) { |
|
1202 | - $valid_registrant = $registration; |
|
1203 | - } |
|
1204 | - } |
|
1205 | - if ( ! $valid_registrant instanceof EE_Registration) { |
|
1206 | - // hmmm... maybe we have the wrong session because the user is opening multiple tabs ? |
|
1207 | - if (EED_Single_Page_Checkout::$_checkout_verified) { |
|
1208 | - // clear the session, mark the checkout as unverified, and try again |
|
1209 | - EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
1210 | - EED_Single_Page_Checkout::$_initialized = false; |
|
1211 | - EED_Single_Page_Checkout::$_checkout_verified = false; |
|
1212 | - $this->_initialize(); |
|
1213 | - EE_Error::reset_notices(); |
|
1214 | - return false; |
|
1215 | - } |
|
1216 | - EE_Error::add_error( |
|
1217 | - __( |
|
1218 | - 'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.', |
|
1219 | - 'event_espresso' |
|
1220 | - ), |
|
1221 | - __FILE__, |
|
1222 | - __FUNCTION__, |
|
1223 | - __LINE__ |
|
1224 | - ); |
|
1225 | - return false; |
|
1226 | - } |
|
1227 | - } |
|
1228 | - // now that things have been kinda sufficiently verified, |
|
1229 | - // let's add the checkout to the session so that it's available to other systems |
|
1230 | - EE_Registry::instance()->SSN->set_checkout($this->checkout); |
|
1231 | - return true; |
|
1232 | - } |
|
1233 | - |
|
1234 | - |
|
1235 | - |
|
1236 | - /** |
|
1237 | - * _initialize_reg_steps |
|
1238 | - * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required |
|
1239 | - * then loops thru all of the active reg steps and calls the initialize_reg_step() method |
|
1240 | - * |
|
1241 | - * @access private |
|
1242 | - * @param bool $reinitializing |
|
1243 | - * @throws EE_Error |
|
1244 | - */ |
|
1245 | - private function _initialize_reg_steps($reinitializing = false) |
|
1246 | - { |
|
1247 | - $this->checkout->set_reg_step_initiated($this->checkout->current_step); |
|
1248 | - // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS |
|
1249 | - foreach ($this->checkout->reg_steps as $reg_step) { |
|
1250 | - if ( ! $reg_step->initialize_reg_step()) { |
|
1251 | - // if not initialized then maybe this step is being removed... |
|
1252 | - if ( ! $reinitializing && $reg_step->is_current_step()) { |
|
1253 | - // if it was the current step, then we need to start over here |
|
1254 | - $this->_initialize_reg_steps(true); |
|
1255 | - return; |
|
1256 | - } |
|
1257 | - continue; |
|
1258 | - } |
|
1259 | - // add css and JS for current step |
|
1260 | - $reg_step->enqueue_styles_and_scripts(); |
|
1261 | - // i18n |
|
1262 | - $reg_step->translate_js_strings(); |
|
1263 | - if ($reg_step->is_current_step()) { |
|
1264 | - // the text that appears on the reg step form submit button |
|
1265 | - $reg_step->set_submit_button_text(); |
|
1266 | - } |
|
1267 | - } |
|
1268 | - // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information |
|
1269 | - do_action( |
|
1270 | - "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}", |
|
1271 | - $this->checkout->current_step |
|
1272 | - ); |
|
1273 | - } |
|
1274 | - |
|
1275 | - |
|
1276 | - |
|
1277 | - /** |
|
1278 | - * _check_form_submission |
|
1279 | - * |
|
1280 | - * @access private |
|
1281 | - * @return boolean |
|
1282 | - */ |
|
1283 | - private function _check_form_submission() |
|
1284 | - { |
|
1285 | - //does this request require the reg form to be generated ? |
|
1286 | - if ($this->checkout->generate_reg_form) { |
|
1287 | - // ever heard that song by Blue Rodeo ? |
|
1288 | - try { |
|
1289 | - $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form(); |
|
1290 | - // if not displaying a form, then check for form submission |
|
1291 | - if ( |
|
1292 | - $this->checkout->process_form_submission |
|
1293 | - && $this->checkout->current_step->reg_form->was_submitted() |
|
1294 | - ) { |
|
1295 | - // clear out any old data in case this step is being run again |
|
1296 | - $this->checkout->current_step->set_valid_data(array()); |
|
1297 | - // capture submitted form data |
|
1298 | - $this->checkout->current_step->reg_form->receive_form_submission( |
|
1299 | - apply_filters( |
|
1300 | - 'FHEE__Single_Page_Checkout___check_form_submission__request_params', |
|
1301 | - EE_Registry::instance()->REQ->params(), |
|
1302 | - $this->checkout |
|
1303 | - ) |
|
1304 | - ); |
|
1305 | - // validate submitted form data |
|
1306 | - if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) { |
|
1307 | - // thou shall not pass !!! |
|
1308 | - $this->checkout->continue_reg = false; |
|
1309 | - // any form validation errors? |
|
1310 | - if ($this->checkout->current_step->reg_form->submission_error_message() !== '') { |
|
1311 | - EE_Error::add_error( |
|
1312 | - $this->checkout->current_step->reg_form->submission_error_message(), |
|
1313 | - __FILE__, __FUNCTION__, __LINE__ |
|
1314 | - ); |
|
1315 | - } |
|
1316 | - // well not really... what will happen is |
|
1317 | - // we'll just get redirected back to redo the current step |
|
1318 | - $this->go_to_next_step(); |
|
1319 | - return false; |
|
1320 | - } |
|
1321 | - } |
|
1322 | - } catch (EE_Error $e) { |
|
1323 | - $e->get_error(); |
|
1324 | - } |
|
1325 | - } |
|
1326 | - return true; |
|
1327 | - } |
|
1328 | - |
|
1329 | - |
|
1330 | - |
|
1331 | - /** |
|
1332 | - * _process_action |
|
1333 | - * |
|
1334 | - * @access private |
|
1335 | - * @return void |
|
1336 | - * @throws EE_Error |
|
1337 | - */ |
|
1338 | - private function _process_form_action() |
|
1339 | - { |
|
1340 | - // what cha wanna do? |
|
1341 | - switch ($this->checkout->action) { |
|
1342 | - // AJAX next step reg form |
|
1343 | - case 'display_spco_reg_step' : |
|
1344 | - $this->checkout->redirect = false; |
|
1345 | - if (EE_Registry::instance()->REQ->ajax) { |
|
1346 | - $this->checkout->json_response->set_reg_step_html( |
|
1347 | - $this->checkout->current_step->display_reg_form() |
|
1348 | - ); |
|
1349 | - } |
|
1350 | - break; |
|
1351 | - default : |
|
1352 | - // meh... do one of those other steps first |
|
1353 | - if ( |
|
1354 | - ! empty($this->checkout->action) |
|
1355 | - && is_callable(array($this->checkout->current_step, $this->checkout->action)) |
|
1356 | - ) { |
|
1357 | - // dynamically creates hook point like: |
|
1358 | - // AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step |
|
1359 | - do_action( |
|
1360 | - "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}", |
|
1361 | - $this->checkout->current_step |
|
1362 | - ); |
|
1363 | - // call action on current step |
|
1364 | - if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) { |
|
1365 | - // good registrant, you get to proceed |
|
1366 | - if ( |
|
1367 | - $this->checkout->current_step->success_message() !== '' |
|
1368 | - && apply_filters( |
|
1369 | - 'FHEE__Single_Page_Checkout___process_form_action__display_success', |
|
1370 | - false |
|
1371 | - ) |
|
1372 | - ) { |
|
1373 | - EE_Error::add_success( |
|
1374 | - $this->checkout->current_step->success_message() |
|
1375 | - . '<br />' . $this->checkout->next_step->_instructions() |
|
1376 | - ); |
|
1377 | - } |
|
1378 | - // pack it up, pack it in... |
|
1379 | - $this->_setup_redirect(); |
|
1380 | - } |
|
1381 | - // dynamically creates hook point like: |
|
1382 | - // AHEE__Single_Page_Checkout__after_payment_options__process_reg_step |
|
1383 | - do_action( |
|
1384 | - "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}", |
|
1385 | - $this->checkout->current_step |
|
1386 | - ); |
|
1387 | - } else { |
|
1388 | - EE_Error::add_error( |
|
1389 | - sprintf( |
|
1390 | - __( |
|
1391 | - 'The requested form action "%s" does not exist for the current "%s" registration step.', |
|
1392 | - 'event_espresso' |
|
1393 | - ), |
|
1394 | - $this->checkout->action, |
|
1395 | - $this->checkout->current_step->name() |
|
1396 | - ), |
|
1397 | - __FILE__, |
|
1398 | - __FUNCTION__, |
|
1399 | - __LINE__ |
|
1400 | - ); |
|
1401 | - } |
|
1402 | - // end default |
|
1403 | - } |
|
1404 | - // store our progress so far |
|
1405 | - $this->checkout->stash_transaction_and_checkout(); |
|
1406 | - // advance to the next step! If you pass GO, collect $200 |
|
1407 | - $this->go_to_next_step(); |
|
1408 | - } |
|
1409 | - |
|
1410 | - |
|
1411 | - |
|
1412 | - /** |
|
1413 | - * add_styles_and_scripts |
|
1414 | - * |
|
1415 | - * @access public |
|
1416 | - * @return void |
|
1417 | - */ |
|
1418 | - public function add_styles_and_scripts() |
|
1419 | - { |
|
1420 | - // i18n |
|
1421 | - $this->translate_js_strings(); |
|
1422 | - if ($this->checkout->admin_request) { |
|
1423 | - add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10); |
|
1424 | - } else { |
|
1425 | - add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10); |
|
1426 | - } |
|
1427 | - } |
|
1428 | - |
|
1429 | - |
|
1430 | - |
|
1431 | - /** |
|
1432 | - * translate_js_strings |
|
1433 | - * |
|
1434 | - * @access public |
|
1435 | - * @return void |
|
1436 | - */ |
|
1437 | - public function translate_js_strings() |
|
1438 | - { |
|
1439 | - EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit; |
|
1440 | - EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link; |
|
1441 | - EE_Registry::$i18n_js_strings['server_error'] = __( |
|
1442 | - 'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.', |
|
1443 | - 'event_espresso' |
|
1444 | - ); |
|
1445 | - EE_Registry::$i18n_js_strings['invalid_json_response'] = __( |
|
1446 | - 'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.', |
|
1447 | - 'event_espresso' |
|
1448 | - ); |
|
1449 | - EE_Registry::$i18n_js_strings['validation_error'] = __( |
|
1450 | - 'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.', |
|
1451 | - 'event_espresso' |
|
1452 | - ); |
|
1453 | - EE_Registry::$i18n_js_strings['invalid_payment_method'] = __( |
|
1454 | - 'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.', |
|
1455 | - 'event_espresso' |
|
1456 | - ); |
|
1457 | - EE_Registry::$i18n_js_strings['reg_step_error'] = __( |
|
1458 | - 'This registration step could not be completed. Please refresh the page and try again.', |
|
1459 | - 'event_espresso' |
|
1460 | - ); |
|
1461 | - EE_Registry::$i18n_js_strings['invalid_coupon'] = __( |
|
1462 | - 'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.', |
|
1463 | - 'event_espresso' |
|
1464 | - ); |
|
1465 | - EE_Registry::$i18n_js_strings['process_registration'] = sprintf( |
|
1466 | - __( |
|
1467 | - 'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.', |
|
1468 | - 'event_espresso' |
|
1469 | - ), |
|
1470 | - '<br/>', |
|
1471 | - '<br/>' |
|
1472 | - ); |
|
1473 | - EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language'); |
|
1474 | - EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id(); |
|
1475 | - EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency; |
|
1476 | - EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20'; |
|
1477 | - EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso'); |
|
1478 | - EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso'); |
|
1479 | - EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso'); |
|
1480 | - EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso'); |
|
1481 | - EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso'); |
|
1482 | - EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso'); |
|
1483 | - EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso'); |
|
1484 | - EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso'); |
|
1485 | - EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso'); |
|
1486 | - EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso'); |
|
1487 | - EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso'); |
|
1488 | - EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso'); |
|
1489 | - EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso'); |
|
1490 | - EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso'); |
|
1491 | - EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf( |
|
1492 | - __( |
|
1493 | - '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s', |
|
1494 | - 'event_espresso' |
|
1495 | - ), |
|
1496 | - '<h4 class="important-notice">', |
|
1497 | - '</h4>', |
|
1498 | - '<br />', |
|
1499 | - '<p>', |
|
1500 | - '<a href="' . get_post_type_archive_link('espresso_events') . '" title="', |
|
1501 | - '">', |
|
1502 | - '</a>', |
|
1503 | - '</p>' |
|
1504 | - ); |
|
1505 | - EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters( |
|
1506 | - 'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit', |
|
1507 | - true |
|
1508 | - ); |
|
1509 | - EE_Registry::$i18n_js_strings['session_extension'] = absint( |
|
1510 | - apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS) |
|
1511 | - ); |
|
1512 | - EE_Registry::$i18n_js_strings['session_expiration'] = gmdate( |
|
1513 | - 'M d, Y H:i:s', |
|
1514 | - EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
1515 | - ); |
|
1516 | - } |
|
1517 | - |
|
1518 | - |
|
1519 | - |
|
1520 | - /** |
|
1521 | - * enqueue_styles_and_scripts |
|
1522 | - * |
|
1523 | - * @access public |
|
1524 | - * @return void |
|
1525 | - * @throws EE_Error |
|
1526 | - */ |
|
1527 | - public function enqueue_styles_and_scripts() |
|
1528 | - { |
|
1529 | - // load css |
|
1530 | - wp_register_style( |
|
1531 | - 'single_page_checkout', |
|
1532 | - SPCO_CSS_URL . 'single_page_checkout.css', |
|
1533 | - array('espresso_default'), |
|
1534 | - EVENT_ESPRESSO_VERSION |
|
1535 | - ); |
|
1536 | - wp_enqueue_style('single_page_checkout'); |
|
1537 | - // load JS |
|
1538 | - wp_register_script( |
|
1539 | - 'jquery_plugin', |
|
1540 | - EE_THIRD_PARTY_URL . 'jquery .plugin.min.js', |
|
1541 | - array('jquery'), |
|
1542 | - '1.0.1', |
|
1543 | - true |
|
1544 | - ); |
|
1545 | - wp_register_script( |
|
1546 | - 'jquery_countdown', |
|
1547 | - EE_THIRD_PARTY_URL . 'jquery .countdown.min.js', |
|
1548 | - array('jquery_plugin'), |
|
1549 | - '2.0.2', |
|
1550 | - true |
|
1551 | - ); |
|
1552 | - wp_register_script( |
|
1553 | - 'single_page_checkout', |
|
1554 | - SPCO_JS_URL . 'single_page_checkout.js', |
|
1555 | - array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'), |
|
1556 | - EVENT_ESPRESSO_VERSION, |
|
1557 | - true |
|
1558 | - ); |
|
1559 | - if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) { |
|
1560 | - $this->checkout->registration_form->enqueue_js(); |
|
1561 | - } |
|
1562 | - if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) { |
|
1563 | - $this->checkout->current_step->reg_form->enqueue_js(); |
|
1564 | - } |
|
1565 | - wp_enqueue_script('single_page_checkout'); |
|
1566 | - /** |
|
1567 | - * global action hook for enqueueing styles and scripts with |
|
1568 | - * spco calls. |
|
1569 | - */ |
|
1570 | - do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this); |
|
1571 | - /** |
|
1572 | - * dynamic action hook for enqueueing styles and scripts with spco calls. |
|
1573 | - * The hook will end up being something like: |
|
1574 | - * AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information |
|
1575 | - */ |
|
1576 | - do_action( |
|
1577 | - 'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(), |
|
1578 | - $this |
|
1579 | - ); |
|
1580 | - } |
|
1581 | - |
|
1582 | - |
|
1583 | - |
|
1584 | - /** |
|
1585 | - * display the Registration Single Page Checkout Form |
|
1586 | - * |
|
1587 | - * @access private |
|
1588 | - * @return void |
|
1589 | - * @throws EE_Error |
|
1590 | - */ |
|
1591 | - private function _display_spco_reg_form() |
|
1592 | - { |
|
1593 | - // if registering via the admin, just display the reg form for the current step |
|
1594 | - if ($this->checkout->admin_request) { |
|
1595 | - EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form()); |
|
1596 | - } else { |
|
1597 | - // add powered by EE msg |
|
1598 | - add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer')); |
|
1599 | - $empty_cart = count( |
|
1600 | - $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) |
|
1601 | - ) < 1; |
|
1602 | - EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart; |
|
1603 | - $cookies_not_set_msg = ''; |
|
1604 | - if ($empty_cart) { |
|
1605 | - $cookies_not_set_msg = apply_filters( |
|
1606 | - 'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg', |
|
1607 | - sprintf( |
|
1608 | - __( |
|
1609 | - '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s', |
|
1610 | - 'event_espresso' |
|
1611 | - ), |
|
1612 | - '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">', |
|
1613 | - '</div>', |
|
1614 | - '<h6 class="important-notice">', |
|
1615 | - '</h6>', |
|
1616 | - '<p>', |
|
1617 | - '</p>', |
|
1618 | - '<br />', |
|
1619 | - '<a href="http://www.whatarecookies.com/enable.asp" target="_blank">', |
|
1620 | - '</a>' |
|
1621 | - ) |
|
1622 | - ); |
|
1623 | - } |
|
1624 | - $this->checkout->registration_form = new EE_Form_Section_Proper( |
|
1625 | - array( |
|
1626 | - 'name' => 'single-page-checkout', |
|
1627 | - 'html_id' => 'ee-single-page-checkout-dv', |
|
1628 | - 'layout_strategy' => |
|
1629 | - new EE_Template_Layout( |
|
1630 | - array( |
|
1631 | - 'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php', |
|
1632 | - 'template_args' => array( |
|
1633 | - 'empty_cart' => $empty_cart, |
|
1634 | - 'revisit' => $this->checkout->revisit, |
|
1635 | - 'reg_steps' => $this->checkout->reg_steps, |
|
1636 | - 'next_step' => $this->checkout->next_step instanceof EE_SPCO_Reg_Step |
|
1637 | - ? $this->checkout->next_step->slug() |
|
1638 | - : '', |
|
1639 | - 'empty_msg' => apply_filters( |
|
1640 | - 'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg', |
|
1641 | - sprintf( |
|
1642 | - __( |
|
1643 | - 'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.', |
|
1644 | - 'event_espresso' |
|
1645 | - ), |
|
1646 | - '<a href="' |
|
1647 | - . get_post_type_archive_link('espresso_events') |
|
1648 | - . '" title="', |
|
1649 | - '">', |
|
1650 | - '</a>' |
|
1651 | - ) |
|
1652 | - ), |
|
1653 | - 'cookies_not_set_msg' => $cookies_not_set_msg, |
|
1654 | - 'registration_time_limit' => $this->checkout->get_registration_time_limit(), |
|
1655 | - 'session_expiration' => gmdate( |
|
1656 | - 'M d, Y H:i:s', |
|
1657 | - EE_Registry::instance()->SSN->expiration() |
|
1658 | - + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
1659 | - ), |
|
1660 | - ), |
|
1661 | - ) |
|
1662 | - ), |
|
1663 | - ) |
|
1664 | - ); |
|
1665 | - // load template and add to output sent that gets filtered into the_content() |
|
1666 | - EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html()); |
|
1667 | - } |
|
1668 | - } |
|
1669 | - |
|
1670 | - |
|
1671 | - |
|
1672 | - /** |
|
1673 | - * add_extra_finalize_registration_inputs |
|
1674 | - * |
|
1675 | - * @access public |
|
1676 | - * @param $next_step |
|
1677 | - * @internal param string $label |
|
1678 | - * @return void |
|
1679 | - */ |
|
1680 | - public function add_extra_finalize_registration_inputs($next_step) |
|
1681 | - { |
|
1682 | - if ($next_step === 'finalize_registration') { |
|
1683 | - echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>'; |
|
1684 | - } |
|
1685 | - } |
|
1686 | - |
|
1687 | - |
|
1688 | - |
|
1689 | - /** |
|
1690 | - * display_registration_footer |
|
1691 | - * |
|
1692 | - * @access public |
|
1693 | - * @return string |
|
1694 | - */ |
|
1695 | - public static function display_registration_footer() |
|
1696 | - { |
|
1697 | - if ( |
|
1698 | - apply_filters( |
|
1699 | - 'FHEE__EE_Front__Controller__show_reg_footer', |
|
1700 | - EE_Registry::instance()->CFG->admin->show_reg_footer |
|
1701 | - ) |
|
1702 | - ) { |
|
1703 | - add_filter( |
|
1704 | - 'FHEE__EEH_Template__powered_by_event_espresso__url', |
|
1705 | - function ($url) { |
|
1706 | - return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url); |
|
1707 | - } |
|
1708 | - ); |
|
1709 | - echo apply_filters( |
|
1710 | - 'FHEE__EE_Front_Controller__display_registration_footer', |
|
1711 | - \EEH_Template::powered_by_event_espresso( |
|
1712 | - '', |
|
1713 | - 'espresso-registration-footer-dv', |
|
1714 | - array('utm_content' => 'registration_checkout') |
|
1715 | - ) |
|
1716 | - ); |
|
1717 | - } |
|
1718 | - return ''; |
|
1719 | - } |
|
1720 | - |
|
1721 | - |
|
1722 | - |
|
1723 | - /** |
|
1724 | - * unlock_transaction |
|
1725 | - * |
|
1726 | - * @access public |
|
1727 | - * @return void |
|
1728 | - * @throws EE_Error |
|
1729 | - */ |
|
1730 | - public function unlock_transaction() |
|
1731 | - { |
|
1732 | - if ($this->checkout->transaction instanceof EE_Transaction) { |
|
1733 | - $this->checkout->transaction->unlock(); |
|
1734 | - } |
|
1735 | - } |
|
1736 | - |
|
1737 | - |
|
1738 | - |
|
1739 | - /** |
|
1740 | - * _setup_redirect |
|
1741 | - * |
|
1742 | - * @access private |
|
1743 | - * @return void |
|
1744 | - */ |
|
1745 | - private function _setup_redirect() |
|
1746 | - { |
|
1747 | - if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
1748 | - $this->checkout->redirect = true; |
|
1749 | - if (empty($this->checkout->redirect_url)) { |
|
1750 | - $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url(); |
|
1751 | - } |
|
1752 | - $this->checkout->redirect_url = apply_filters( |
|
1753 | - 'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url', |
|
1754 | - $this->checkout->redirect_url, |
|
1755 | - $this->checkout |
|
1756 | - ); |
|
1757 | - } |
|
1758 | - } |
|
1759 | - |
|
1760 | - |
|
1761 | - |
|
1762 | - /** |
|
1763 | - * handle ajax message responses and redirects |
|
1764 | - * |
|
1765 | - * @access public |
|
1766 | - * @return void |
|
1767 | - * @throws EE_Error |
|
1768 | - */ |
|
1769 | - public function go_to_next_step() |
|
1770 | - { |
|
1771 | - if (EE_Registry::instance()->REQ->ajax) { |
|
1772 | - // capture contents of output buffer we started earlier in the request, and insert into JSON response |
|
1773 | - $this->checkout->json_response->set_unexpected_errors(ob_get_clean()); |
|
1774 | - } |
|
1775 | - $this->unlock_transaction(); |
|
1776 | - // just return for these conditions |
|
1777 | - if ( |
|
1778 | - $this->checkout->admin_request |
|
1779 | - || $this->checkout->action === 'redirect_form' |
|
1780 | - || $this->checkout->action === 'update_checkout' |
|
1781 | - ) { |
|
1782 | - return; |
|
1783 | - } |
|
1784 | - // AJAX response |
|
1785 | - $this->_handle_json_response(); |
|
1786 | - // redirect to next step or the Thank You page |
|
1787 | - $this->_handle_html_redirects(); |
|
1788 | - // hmmm... must be something wrong, so let's just display the form again ! |
|
1789 | - $this->_display_spco_reg_form(); |
|
1790 | - } |
|
1791 | - |
|
1792 | - |
|
1793 | - |
|
1794 | - /** |
|
1795 | - * _handle_json_response |
|
1796 | - * |
|
1797 | - * @access protected |
|
1798 | - * @return void |
|
1799 | - */ |
|
1800 | - protected function _handle_json_response() |
|
1801 | - { |
|
1802 | - // if this is an ajax request |
|
1803 | - if (EE_Registry::instance()->REQ->ajax) { |
|
1804 | - // DEBUG LOG |
|
1805 | - //$this->checkout->log( |
|
1806 | - // __CLASS__, __FUNCTION__, __LINE__, |
|
1807 | - // array( |
|
1808 | - // 'json_response_redirect_url' => $this->checkout->json_response->redirect_url(), |
|
1809 | - // 'redirect' => $this->checkout->redirect, |
|
1810 | - // 'continue_reg' => $this->checkout->continue_reg, |
|
1811 | - // ) |
|
1812 | - //); |
|
1813 | - $this->checkout->json_response->set_registration_time_limit( |
|
1814 | - $this->checkout->get_registration_time_limit() |
|
1815 | - ); |
|
1816 | - $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing); |
|
1817 | - // just send the ajax ( |
|
1818 | - $json_response = apply_filters( |
|
1819 | - 'FHEE__EE_Single_Page_Checkout__JSON_response', |
|
1820 | - $this->checkout->json_response |
|
1821 | - ); |
|
1822 | - echo $json_response; |
|
1823 | - exit(); |
|
1824 | - } |
|
1825 | - } |
|
1826 | - |
|
1827 | - |
|
1828 | - |
|
1829 | - /** |
|
1830 | - * _handle_redirects |
|
1831 | - * |
|
1832 | - * @access protected |
|
1833 | - * @return void |
|
1834 | - */ |
|
1835 | - protected function _handle_html_redirects() |
|
1836 | - { |
|
1837 | - // going somewhere ? |
|
1838 | - if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) { |
|
1839 | - // store notices in a transient |
|
1840 | - EE_Error::get_notices(false, true, true); |
|
1841 | - // DEBUG LOG |
|
1842 | - //$this->checkout->log( |
|
1843 | - // __CLASS__, __FUNCTION__, __LINE__, |
|
1844 | - // array( |
|
1845 | - // 'headers_sent' => headers_sent(), |
|
1846 | - // 'redirect_url' => $this->checkout->redirect_url, |
|
1847 | - // 'headers_list' => headers_list(), |
|
1848 | - // ) |
|
1849 | - //); |
|
1850 | - wp_safe_redirect($this->checkout->redirect_url); |
|
1851 | - exit(); |
|
1852 | - } |
|
1853 | - } |
|
1854 | - |
|
1855 | - |
|
1856 | - |
|
1857 | - /** |
|
1858 | - * set_checkout_anchor |
|
1859 | - * |
|
1860 | - * @access public |
|
1861 | - * @return void |
|
1862 | - */ |
|
1863 | - public function set_checkout_anchor() |
|
1864 | - { |
|
1865 | - echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>'; |
|
1866 | - } |
|
23 | + /** |
|
24 | + * $_initialized - has the SPCO controller already been initialized ? |
|
25 | + * |
|
26 | + * @access private |
|
27 | + * @var bool $_initialized |
|
28 | + */ |
|
29 | + private static $_initialized = false; |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * $_checkout_verified - is the EE_Checkout verified as correct for this request ? |
|
34 | + * |
|
35 | + * @access private |
|
36 | + * @var bool $_valid_checkout |
|
37 | + */ |
|
38 | + private static $_checkout_verified = true; |
|
39 | + |
|
40 | + /** |
|
41 | + * $_reg_steps_array - holds initial array of reg steps |
|
42 | + * |
|
43 | + * @access private |
|
44 | + * @var array $_reg_steps_array |
|
45 | + */ |
|
46 | + private static $_reg_steps_array = array(); |
|
47 | + |
|
48 | + /** |
|
49 | + * $checkout - EE_Checkout object for handling the properties of the current checkout process |
|
50 | + * |
|
51 | + * @access public |
|
52 | + * @var EE_Checkout $checkout |
|
53 | + */ |
|
54 | + public $checkout; |
|
55 | + |
|
56 | + |
|
57 | + |
|
58 | + /** |
|
59 | + * @return EED_Module|EED_Single_Page_Checkout |
|
60 | + */ |
|
61 | + public static function instance() |
|
62 | + { |
|
63 | + add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true'); |
|
64 | + return parent::get_instance(__CLASS__); |
|
65 | + } |
|
66 | + |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @return EE_CART |
|
71 | + */ |
|
72 | + public function cart() |
|
73 | + { |
|
74 | + return $this->checkout->cart; |
|
75 | + } |
|
76 | + |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * @return EE_Transaction |
|
81 | + */ |
|
82 | + public function transaction() |
|
83 | + { |
|
84 | + return $this->checkout->transaction; |
|
85 | + } |
|
86 | + |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * set_hooks - for hooking into EE Core, other modules, etc |
|
91 | + * |
|
92 | + * @access public |
|
93 | + * @return void |
|
94 | + * @throws EE_Error |
|
95 | + */ |
|
96 | + public static function set_hooks() |
|
97 | + { |
|
98 | + EED_Single_Page_Checkout::set_definitions(); |
|
99 | + } |
|
100 | + |
|
101 | + |
|
102 | + |
|
103 | + /** |
|
104 | + * set_hooks_admin - for hooking into EE Admin Core, other modules, etc |
|
105 | + * |
|
106 | + * @access public |
|
107 | + * @return void |
|
108 | + * @throws EE_Error |
|
109 | + */ |
|
110 | + public static function set_hooks_admin() |
|
111 | + { |
|
112 | + EED_Single_Page_Checkout::set_definitions(); |
|
113 | + if ( ! (defined('DOING_AJAX') && DOING_AJAX)) { |
|
114 | + return; |
|
115 | + } |
|
116 | + // going to start an output buffer in case anything gets accidentally output |
|
117 | + // that might disrupt our JSON response |
|
118 | + ob_start(); |
|
119 | + EED_Single_Page_Checkout::load_request_handler(); |
|
120 | + EED_Single_Page_Checkout::load_reg_steps(); |
|
121 | + // set ajax hooks |
|
122 | + add_action('wp_ajax_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step')); |
|
123 | + add_action('wp_ajax_nopriv_process_reg_step', array('EED_Single_Page_Checkout', 'process_reg_step')); |
|
124 | + add_action('wp_ajax_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step')); |
|
125 | + add_action('wp_ajax_nopriv_display_spco_reg_step', array('EED_Single_Page_Checkout', 'display_reg_step')); |
|
126 | + add_action('wp_ajax_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step')); |
|
127 | + add_action('wp_ajax_nopriv_update_reg_step', array('EED_Single_Page_Checkout', 'update_reg_step')); |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + |
|
132 | + /** |
|
133 | + * process ajax request |
|
134 | + * |
|
135 | + * @param string $ajax_action |
|
136 | + * @throws EE_Error |
|
137 | + */ |
|
138 | + public static function process_ajax_request($ajax_action) |
|
139 | + { |
|
140 | + EE_Registry::instance()->REQ->set('action', $ajax_action); |
|
141 | + EED_Single_Page_Checkout::instance()->_initialize(); |
|
142 | + } |
|
143 | + |
|
144 | + |
|
145 | + |
|
146 | + /** |
|
147 | + * ajax display registration step |
|
148 | + * |
|
149 | + * @throws EE_Error |
|
150 | + */ |
|
151 | + public static function display_reg_step() |
|
152 | + { |
|
153 | + EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step'); |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * ajax process registration step |
|
160 | + * |
|
161 | + * @throws EE_Error |
|
162 | + */ |
|
163 | + public static function process_reg_step() |
|
164 | + { |
|
165 | + EED_Single_Page_Checkout::process_ajax_request('process_reg_step'); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + |
|
170 | + /** |
|
171 | + * ajax process registration step |
|
172 | + * |
|
173 | + * @throws EE_Error |
|
174 | + */ |
|
175 | + public static function update_reg_step() |
|
176 | + { |
|
177 | + EED_Single_Page_Checkout::process_ajax_request('update_reg_step'); |
|
178 | + } |
|
179 | + |
|
180 | + |
|
181 | + |
|
182 | + /** |
|
183 | + * update_checkout |
|
184 | + * |
|
185 | + * @access public |
|
186 | + * @return void |
|
187 | + * @throws EE_Error |
|
188 | + */ |
|
189 | + public static function update_checkout() |
|
190 | + { |
|
191 | + EED_Single_Page_Checkout::process_ajax_request('update_checkout'); |
|
192 | + } |
|
193 | + |
|
194 | + |
|
195 | + |
|
196 | + /** |
|
197 | + * load_request_handler |
|
198 | + * |
|
199 | + * @access public |
|
200 | + * @return void |
|
201 | + */ |
|
202 | + public static function load_request_handler() |
|
203 | + { |
|
204 | + // load core Request_Handler class |
|
205 | + if (EE_Registry::instance()->REQ !== null) { |
|
206 | + EE_Registry::instance()->load_core('Request_Handler'); |
|
207 | + } |
|
208 | + } |
|
209 | + |
|
210 | + |
|
211 | + |
|
212 | + /** |
|
213 | + * set_definitions |
|
214 | + * |
|
215 | + * @access public |
|
216 | + * @return void |
|
217 | + * @throws EE_Error |
|
218 | + */ |
|
219 | + public static function set_definitions() |
|
220 | + { |
|
221 | + if(defined('SPCO_BASE_PATH')) { |
|
222 | + return; |
|
223 | + } |
|
224 | + define( |
|
225 | + 'SPCO_BASE_PATH', |
|
226 | + rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS |
|
227 | + ); |
|
228 | + define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS); |
|
229 | + define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS); |
|
230 | + define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS); |
|
231 | + define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS); |
|
232 | + define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS); |
|
233 | + define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS); |
|
234 | + EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true); |
|
235 | + EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf( |
|
236 | + __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s', |
|
237 | + 'event_espresso'), |
|
238 | + '<h4 class="important-notice">', |
|
239 | + '</h4>', |
|
240 | + '<br />', |
|
241 | + '<p>', |
|
242 | + '<a href="' . get_post_type_archive_link('espresso_events') . '" title="', |
|
243 | + '">', |
|
244 | + '</a>', |
|
245 | + '</p>' |
|
246 | + ); |
|
247 | + } |
|
248 | + |
|
249 | + |
|
250 | + |
|
251 | + /** |
|
252 | + * load_reg_steps |
|
253 | + * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array |
|
254 | + * |
|
255 | + * @access private |
|
256 | + * @throws EE_Error |
|
257 | + */ |
|
258 | + public static function load_reg_steps() |
|
259 | + { |
|
260 | + static $reg_steps_loaded = false; |
|
261 | + if ($reg_steps_loaded) { |
|
262 | + return; |
|
263 | + } |
|
264 | + // filter list of reg_steps |
|
265 | + $reg_steps_to_load = (array)apply_filters( |
|
266 | + 'AHEE__SPCO__load_reg_steps__reg_steps_to_load', |
|
267 | + EED_Single_Page_Checkout::get_reg_steps() |
|
268 | + ); |
|
269 | + // sort by key (order) |
|
270 | + ksort($reg_steps_to_load); |
|
271 | + // loop through folders |
|
272 | + foreach ($reg_steps_to_load as $order => $reg_step) { |
|
273 | + // we need a |
|
274 | + if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) { |
|
275 | + // copy over to the reg_steps_array |
|
276 | + EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step; |
|
277 | + // register custom key route for each reg step |
|
278 | + // ie: step=>"slug" - this is the entire reason we load the reg steps array now |
|
279 | + EE_Config::register_route( |
|
280 | + $reg_step['slug'], |
|
281 | + 'EED_Single_Page_Checkout', |
|
282 | + 'run', |
|
283 | + 'step' |
|
284 | + ); |
|
285 | + // add AJAX or other hooks |
|
286 | + if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) { |
|
287 | + // setup autoloaders if necessary |
|
288 | + if ( ! class_exists($reg_step['class_name'])) { |
|
289 | + EEH_Autoloader::register_autoloaders_for_each_file_in_folder( |
|
290 | + $reg_step['file_path'], |
|
291 | + true |
|
292 | + ); |
|
293 | + } |
|
294 | + if (is_callable($reg_step['class_name'], 'set_hooks')) { |
|
295 | + call_user_func(array($reg_step['class_name'], 'set_hooks')); |
|
296 | + } |
|
297 | + } |
|
298 | + } |
|
299 | + } |
|
300 | + $reg_steps_loaded = true; |
|
301 | + } |
|
302 | + |
|
303 | + |
|
304 | + |
|
305 | + /** |
|
306 | + * get_reg_steps |
|
307 | + * |
|
308 | + * @access public |
|
309 | + * @return array |
|
310 | + */ |
|
311 | + public static function get_reg_steps() |
|
312 | + { |
|
313 | + $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps; |
|
314 | + if (empty($reg_steps)) { |
|
315 | + $reg_steps = array( |
|
316 | + 10 => array( |
|
317 | + 'file_path' => SPCO_REG_STEPS_PATH . 'attendee_information', |
|
318 | + 'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information', |
|
319 | + 'slug' => 'attendee_information', |
|
320 | + 'has_hooks' => false, |
|
321 | + ), |
|
322 | + 20 => array( |
|
323 | + 'file_path' => SPCO_REG_STEPS_PATH . 'registration_confirmation', |
|
324 | + 'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation', |
|
325 | + 'slug' => 'registration_confirmation', |
|
326 | + 'has_hooks' => false, |
|
327 | + ), |
|
328 | + 30 => array( |
|
329 | + 'file_path' => SPCO_REG_STEPS_PATH . 'payment_options', |
|
330 | + 'class_name' => 'EE_SPCO_Reg_Step_Payment_Options', |
|
331 | + 'slug' => 'payment_options', |
|
332 | + 'has_hooks' => true, |
|
333 | + ), |
|
334 | + 999 => array( |
|
335 | + 'file_path' => SPCO_REG_STEPS_PATH . 'finalize_registration', |
|
336 | + 'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration', |
|
337 | + 'slug' => 'finalize_registration', |
|
338 | + 'has_hooks' => false, |
|
339 | + ), |
|
340 | + ); |
|
341 | + } |
|
342 | + return $reg_steps; |
|
343 | + } |
|
344 | + |
|
345 | + |
|
346 | + |
|
347 | + /** |
|
348 | + * registration_checkout_for_admin |
|
349 | + * |
|
350 | + * @access public |
|
351 | + * @return string |
|
352 | + * @throws EE_Error |
|
353 | + */ |
|
354 | + public static function registration_checkout_for_admin() |
|
355 | + { |
|
356 | + EED_Single_Page_Checkout::load_request_handler(); |
|
357 | + EE_Registry::instance()->REQ->set('step', 'attendee_information'); |
|
358 | + EE_Registry::instance()->REQ->set('action', 'display_spco_reg_step'); |
|
359 | + EE_Registry::instance()->REQ->set('process_form_submission', false); |
|
360 | + EED_Single_Page_Checkout::instance()->_initialize(); |
|
361 | + EED_Single_Page_Checkout::instance()->_display_spco_reg_form(); |
|
362 | + return EE_Registry::instance()->REQ->get_output(); |
|
363 | + } |
|
364 | + |
|
365 | + |
|
366 | + |
|
367 | + /** |
|
368 | + * process_registration_from_admin |
|
369 | + * |
|
370 | + * @access public |
|
371 | + * @return \EE_Transaction |
|
372 | + * @throws EE_Error |
|
373 | + */ |
|
374 | + public static function process_registration_from_admin() |
|
375 | + { |
|
376 | + EED_Single_Page_Checkout::load_request_handler(); |
|
377 | + EE_Registry::instance()->REQ->set('step', 'attendee_information'); |
|
378 | + EE_Registry::instance()->REQ->set('action', 'process_reg_step'); |
|
379 | + EE_Registry::instance()->REQ->set('process_form_submission', true); |
|
380 | + EED_Single_Page_Checkout::instance()->_initialize(); |
|
381 | + if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) { |
|
382 | + $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps); |
|
383 | + if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) { |
|
384 | + EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step); |
|
385 | + if ($final_reg_step->process_reg_step()) { |
|
386 | + $final_reg_step->set_completed(); |
|
387 | + EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array(); |
|
388 | + return EED_Single_Page_Checkout::instance()->checkout->transaction; |
|
389 | + } |
|
390 | + } |
|
391 | + } |
|
392 | + return null; |
|
393 | + } |
|
394 | + |
|
395 | + |
|
396 | + |
|
397 | + /** |
|
398 | + * run |
|
399 | + * |
|
400 | + * @access public |
|
401 | + * @param WP_Query $WP_Query |
|
402 | + * @return void |
|
403 | + * @throws EE_Error |
|
404 | + */ |
|
405 | + public function run($WP_Query) |
|
406 | + { |
|
407 | + if ( |
|
408 | + $WP_Query instanceof WP_Query |
|
409 | + && $WP_Query->is_main_query() |
|
410 | + && apply_filters('FHEE__EED_Single_Page_Checkout__run', true) |
|
411 | + && $this->_is_reg_checkout() |
|
412 | + ) { |
|
413 | + $this->_initialize(); |
|
414 | + } |
|
415 | + } |
|
416 | + |
|
417 | + |
|
418 | + |
|
419 | + /** |
|
420 | + * determines whether current url matches reg page url |
|
421 | + * |
|
422 | + * @return bool |
|
423 | + */ |
|
424 | + protected function _is_reg_checkout() |
|
425 | + { |
|
426 | + // get current permalink for reg page without any extra query args |
|
427 | + $reg_page_url = \get_permalink(EE_Config::instance()->core->reg_page_id); |
|
428 | + // get request URI for current request, but without the scheme or host |
|
429 | + $current_request_uri = \EEH_URL::filter_input_server_url('REQUEST_URI'); |
|
430 | + $current_request_uri = html_entity_decode($current_request_uri); |
|
431 | + // get array of query args from the current request URI |
|
432 | + $query_args = \EEH_URL::get_query_string($current_request_uri); |
|
433 | + // grab page id if it is set |
|
434 | + $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0; |
|
435 | + // and remove the page id from the query args (we will re-add it later) |
|
436 | + unset($query_args['page_id']); |
|
437 | + // now strip all query args from current request URI |
|
438 | + $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri); |
|
439 | + // and re-add the page id if it was set |
|
440 | + if ($page_id) { |
|
441 | + $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri); |
|
442 | + } |
|
443 | + // remove slashes and ? |
|
444 | + $current_request_uri = trim($current_request_uri, '?/'); |
|
445 | + // is current request URI part of the known full reg page URL ? |
|
446 | + return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false; |
|
447 | + } |
|
448 | + |
|
449 | + |
|
450 | + |
|
451 | + /** |
|
452 | + * @param WP_Query $wp_query |
|
453 | + * @return void |
|
454 | + * @throws EE_Error |
|
455 | + */ |
|
456 | + public static function init($wp_query) |
|
457 | + { |
|
458 | + EED_Single_Page_Checkout::instance()->run($wp_query); |
|
459 | + } |
|
460 | + |
|
461 | + |
|
462 | + |
|
463 | + /** |
|
464 | + * _initialize - initial module setup |
|
465 | + * |
|
466 | + * @access private |
|
467 | + * @throws EE_Error |
|
468 | + * @return void |
|
469 | + */ |
|
470 | + private function _initialize() |
|
471 | + { |
|
472 | + // ensure SPCO doesn't run twice |
|
473 | + if (EED_Single_Page_Checkout::$_initialized) { |
|
474 | + return; |
|
475 | + } |
|
476 | + try { |
|
477 | + EED_Single_Page_Checkout::load_reg_steps(); |
|
478 | + $this->_verify_session(); |
|
479 | + // setup the EE_Checkout object |
|
480 | + $this->checkout = $this->_initialize_checkout(); |
|
481 | + // filter checkout |
|
482 | + $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout); |
|
483 | + // get the $_GET |
|
484 | + $this->_get_request_vars(); |
|
485 | + if ($this->_block_bots()) { |
|
486 | + return; |
|
487 | + } |
|
488 | + // filter continue_reg |
|
489 | + $this->checkout->continue_reg = apply_filters( |
|
490 | + 'FHEE__EED_Single_Page_Checkout__init___continue_reg', |
|
491 | + true, |
|
492 | + $this->checkout |
|
493 | + ); |
|
494 | + // load the reg steps array |
|
495 | + if ( ! $this->_load_and_instantiate_reg_steps()) { |
|
496 | + EED_Single_Page_Checkout::$_initialized = true; |
|
497 | + return; |
|
498 | + } |
|
499 | + // set the current step |
|
500 | + $this->checkout->set_current_step($this->checkout->step); |
|
501 | + // and the next step |
|
502 | + $this->checkout->set_next_step(); |
|
503 | + // verify that everything has been setup correctly |
|
504 | + if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) { |
|
505 | + EED_Single_Page_Checkout::$_initialized = true; |
|
506 | + return; |
|
507 | + } |
|
508 | + // lock the transaction |
|
509 | + $this->checkout->transaction->lock(); |
|
510 | + // make sure all of our cached objects are added to their respective model entity mappers |
|
511 | + $this->checkout->refresh_all_entities(); |
|
512 | + // set amount owing |
|
513 | + $this->checkout->amount_owing = $this->checkout->transaction->remaining(); |
|
514 | + // initialize each reg step, which gives them the chance to potentially alter the process |
|
515 | + $this->_initialize_reg_steps(); |
|
516 | + // DEBUG LOG |
|
517 | + //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ ); |
|
518 | + // get reg form |
|
519 | + if( ! $this->_check_form_submission()) { |
|
520 | + EED_Single_Page_Checkout::$_initialized = true; |
|
521 | + return; |
|
522 | + } |
|
523 | + // checkout the action!!! |
|
524 | + $this->_process_form_action(); |
|
525 | + // add some style and make it dance |
|
526 | + $this->add_styles_and_scripts(); |
|
527 | + // kk... SPCO has successfully run |
|
528 | + EED_Single_Page_Checkout::$_initialized = true; |
|
529 | + // set no cache headers and constants |
|
530 | + EE_System::do_not_cache(); |
|
531 | + // add anchor |
|
532 | + add_action('loop_start', array($this, 'set_checkout_anchor'), 1); |
|
533 | + // remove transaction lock |
|
534 | + add_action('shutdown', array($this, 'unlock_transaction'), 1); |
|
535 | + } catch (Exception $e) { |
|
536 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
537 | + } |
|
538 | + } |
|
539 | + |
|
540 | + |
|
541 | + |
|
542 | + /** |
|
543 | + * _verify_session |
|
544 | + * checks that the session is valid and not expired |
|
545 | + * |
|
546 | + * @access private |
|
547 | + * @throws EE_Error |
|
548 | + */ |
|
549 | + private function _verify_session() |
|
550 | + { |
|
551 | + if ( ! EE_Registry::instance()->SSN instanceof EE_Session) { |
|
552 | + throw new EE_Error(__('The EE_Session class could not be loaded.', 'event_espresso')); |
|
553 | + } |
|
554 | + $clear_session_requested = filter_var( |
|
555 | + EE_Registry::instance()->REQ->get('clear_session', false), |
|
556 | + FILTER_VALIDATE_BOOLEAN |
|
557 | + ); |
|
558 | + // is session still valid ? |
|
559 | + if ($clear_session_requested |
|
560 | + || ( EE_Registry::instance()->SSN->expired() |
|
561 | + && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === '' |
|
562 | + ) |
|
563 | + ) { |
|
564 | + $this->checkout = new EE_Checkout(); |
|
565 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
566 | + // EE_Registry::instance()->SSN->reset_cart(); |
|
567 | + // EE_Registry::instance()->SSN->reset_checkout(); |
|
568 | + // EE_Registry::instance()->SSN->reset_transaction(); |
|
569 | + if (! $clear_session_requested) { |
|
570 | + EE_Error::add_attention( |
|
571 | + EE_Registry::$i18n_js_strings['registration_expiration_notice'], |
|
572 | + __FILE__, __FUNCTION__, __LINE__ |
|
573 | + ); |
|
574 | + } |
|
575 | + // EE_Registry::instance()->SSN->reset_expired(); |
|
576 | + } |
|
577 | + } |
|
578 | + |
|
579 | + |
|
580 | + |
|
581 | + /** |
|
582 | + * _initialize_checkout |
|
583 | + * loads and instantiates EE_Checkout |
|
584 | + * |
|
585 | + * @access private |
|
586 | + * @throws EE_Error |
|
587 | + * @return EE_Checkout |
|
588 | + */ |
|
589 | + private function _initialize_checkout() |
|
590 | + { |
|
591 | + // look in session for existing checkout |
|
592 | + /** @type EE_Checkout $checkout */ |
|
593 | + $checkout = EE_Registry::instance()->SSN->checkout(); |
|
594 | + // verify |
|
595 | + if ( ! $checkout instanceof EE_Checkout) { |
|
596 | + // instantiate EE_Checkout object for handling the properties of the current checkout process |
|
597 | + $checkout = EE_Registry::instance()->load_file( |
|
598 | + SPCO_INC_PATH, |
|
599 | + 'EE_Checkout', |
|
600 | + 'class', array(), |
|
601 | + false |
|
602 | + ); |
|
603 | + } else { |
|
604 | + if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) { |
|
605 | + $this->unlock_transaction(); |
|
606 | + wp_safe_redirect($checkout->redirect_url); |
|
607 | + exit(); |
|
608 | + } |
|
609 | + } |
|
610 | + $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout); |
|
611 | + // verify again |
|
612 | + if ( ! $checkout instanceof EE_Checkout) { |
|
613 | + throw new EE_Error(__('The EE_Checkout class could not be loaded.', 'event_espresso')); |
|
614 | + } |
|
615 | + // reset anything that needs a clean slate for each request |
|
616 | + $checkout->reset_for_current_request(); |
|
617 | + return $checkout; |
|
618 | + } |
|
619 | + |
|
620 | + |
|
621 | + |
|
622 | + /** |
|
623 | + * _get_request_vars |
|
624 | + * |
|
625 | + * @access private |
|
626 | + * @return void |
|
627 | + * @throws EE_Error |
|
628 | + */ |
|
629 | + private function _get_request_vars() |
|
630 | + { |
|
631 | + // load classes |
|
632 | + EED_Single_Page_Checkout::load_request_handler(); |
|
633 | + //make sure this request is marked as belonging to EE |
|
634 | + EE_Registry::instance()->REQ->set_espresso_page(true); |
|
635 | + // which step is being requested ? |
|
636 | + $this->checkout->step = EE_Registry::instance()->REQ->get('step', $this->_get_first_step()); |
|
637 | + // which step is being edited ? |
|
638 | + $this->checkout->edit_step = EE_Registry::instance()->REQ->get('edit_step', ''); |
|
639 | + // and what we're doing on the current step |
|
640 | + $this->checkout->action = EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step'); |
|
641 | + // timestamp |
|
642 | + $this->checkout->uts = EE_Registry::instance()->REQ->get('uts', 0); |
|
643 | + // returning to edit ? |
|
644 | + $this->checkout->reg_url_link = EE_Registry::instance()->REQ->get('e_reg_url_link', ''); |
|
645 | + // add reg url link to registration query params |
|
646 | + if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) { |
|
647 | + $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link; |
|
648 | + } |
|
649 | + // or some other kind of revisit ? |
|
650 | + $this->checkout->revisit = filter_var( |
|
651 | + EE_Registry::instance()->REQ->get('revisit', false), |
|
652 | + FILTER_VALIDATE_BOOLEAN |
|
653 | + ); |
|
654 | + // and whether or not to generate a reg form for this request |
|
655 | + $this->checkout->generate_reg_form = filter_var( |
|
656 | + EE_Registry::instance()->REQ->get('generate_reg_form', true), |
|
657 | + FILTER_VALIDATE_BOOLEAN |
|
658 | + ); |
|
659 | + // and whether or not to process a reg form submission for this request |
|
660 | + $this->checkout->process_form_submission = filter_var( |
|
661 | + EE_Registry::instance()->REQ->get( |
|
662 | + 'process_form_submission', |
|
663 | + $this->checkout->action === 'process_reg_step' |
|
664 | + ), |
|
665 | + FILTER_VALIDATE_BOOLEAN |
|
666 | + ); |
|
667 | + $this->checkout->process_form_submission = filter_var( |
|
668 | + $this->checkout->action !== 'display_spco_reg_step' |
|
669 | + ? $this->checkout->process_form_submission |
|
670 | + : false, |
|
671 | + FILTER_VALIDATE_BOOLEAN |
|
672 | + ); |
|
673 | + // $this->_display_request_vars(); |
|
674 | + } |
|
675 | + |
|
676 | + |
|
677 | + |
|
678 | + /** |
|
679 | + * _display_request_vars |
|
680 | + * |
|
681 | + * @access protected |
|
682 | + * @return void |
|
683 | + */ |
|
684 | + protected function _display_request_vars() |
|
685 | + { |
|
686 | + if ( ! WP_DEBUG) { |
|
687 | + return; |
|
688 | + } |
|
689 | + EEH_Debug_Tools::printr($_REQUEST, '$_REQUEST', __FILE__, __LINE__); |
|
690 | + EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__); |
|
691 | + EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__); |
|
692 | + EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__); |
|
693 | + EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__); |
|
694 | + EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__); |
|
695 | + EEH_Debug_Tools::printr($this->checkout->generate_reg_form, '$this->checkout->generate_reg_form', __FILE__, __LINE__); |
|
696 | + EEH_Debug_Tools::printr($this->checkout->process_form_submission, '$this->checkout->process_form_submission', __FILE__, __LINE__); |
|
697 | + } |
|
698 | + |
|
699 | + |
|
700 | + |
|
701 | + /** |
|
702 | + * _block_bots |
|
703 | + * checks that the incoming request has either of the following set: |
|
704 | + * a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector |
|
705 | + * a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN |
|
706 | + * so if you're not coming from the Ticket Selector nor returning for a valid IP... |
|
707 | + * then where you coming from man? |
|
708 | + * |
|
709 | + * @return boolean |
|
710 | + */ |
|
711 | + private function _block_bots() |
|
712 | + { |
|
713 | + $invalid_checkout_access = EED_Invalid_Checkout_Access::getInvalidCheckoutAccess(); |
|
714 | + if ($invalid_checkout_access->checkoutAccessIsInvalid($this->checkout)) { |
|
715 | + return true; |
|
716 | + } |
|
717 | + return false; |
|
718 | + } |
|
719 | + |
|
720 | + |
|
721 | + |
|
722 | + /** |
|
723 | + * _get_first_step |
|
724 | + * gets slug for first step in $_reg_steps_array |
|
725 | + * |
|
726 | + * @access private |
|
727 | + * @throws EE_Error |
|
728 | + * @return string |
|
729 | + */ |
|
730 | + private function _get_first_step() |
|
731 | + { |
|
732 | + $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array); |
|
733 | + return isset($first_step['slug']) ? $first_step['slug'] : 'attendee_information'; |
|
734 | + } |
|
735 | + |
|
736 | + |
|
737 | + |
|
738 | + /** |
|
739 | + * _load_and_instantiate_reg_steps |
|
740 | + * instantiates each reg step based on the loaded reg_steps array |
|
741 | + * |
|
742 | + * @access private |
|
743 | + * @throws EE_Error |
|
744 | + * @return bool |
|
745 | + */ |
|
746 | + private function _load_and_instantiate_reg_steps() |
|
747 | + { |
|
748 | + do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout); |
|
749 | + // have reg_steps already been instantiated ? |
|
750 | + if ( |
|
751 | + empty($this->checkout->reg_steps) |
|
752 | + || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout) |
|
753 | + ) { |
|
754 | + // if not, then loop through raw reg steps array |
|
755 | + foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) { |
|
756 | + if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) { |
|
757 | + return false; |
|
758 | + } |
|
759 | + } |
|
760 | + EE_Registry::instance()->CFG->registration->skip_reg_confirmation = true; |
|
761 | + EE_Registry::instance()->CFG->registration->reg_confirmation_last = true; |
|
762 | + // skip the registration_confirmation page ? |
|
763 | + if (EE_Registry::instance()->CFG->registration->skip_reg_confirmation) { |
|
764 | + // just remove it from the reg steps array |
|
765 | + $this->checkout->remove_reg_step('registration_confirmation', false); |
|
766 | + } else if ( |
|
767 | + isset($this->checkout->reg_steps['registration_confirmation']) |
|
768 | + && EE_Registry::instance()->CFG->registration->reg_confirmation_last |
|
769 | + ) { |
|
770 | + // set the order to something big like 100 |
|
771 | + $this->checkout->set_reg_step_order('registration_confirmation', 100); |
|
772 | + } |
|
773 | + // filter the array for good luck |
|
774 | + $this->checkout->reg_steps = apply_filters( |
|
775 | + 'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps', |
|
776 | + $this->checkout->reg_steps |
|
777 | + ); |
|
778 | + // finally re-sort based on the reg step class order properties |
|
779 | + $this->checkout->sort_reg_steps(); |
|
780 | + } else { |
|
781 | + foreach ($this->checkout->reg_steps as $reg_step) { |
|
782 | + // set all current step stati to FALSE |
|
783 | + $reg_step->set_is_current_step(false); |
|
784 | + } |
|
785 | + } |
|
786 | + if (empty($this->checkout->reg_steps)) { |
|
787 | + EE_Error::add_error( |
|
788 | + __('No Reg Steps were loaded..', 'event_espresso'), |
|
789 | + __FILE__, __FUNCTION__, __LINE__ |
|
790 | + ); |
|
791 | + return false; |
|
792 | + } |
|
793 | + // make reg step details available to JS |
|
794 | + $this->checkout->set_reg_step_JSON_info(); |
|
795 | + return true; |
|
796 | + } |
|
797 | + |
|
798 | + |
|
799 | + |
|
800 | + /** |
|
801 | + * _load_and_instantiate_reg_step |
|
802 | + * |
|
803 | + * @access private |
|
804 | + * @param array $reg_step |
|
805 | + * @param int $order |
|
806 | + * @return bool |
|
807 | + */ |
|
808 | + private function _load_and_instantiate_reg_step($reg_step = array(), $order = 0) |
|
809 | + { |
|
810 | + // we need a file_path, class_name, and slug to add a reg step |
|
811 | + if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) { |
|
812 | + // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step) |
|
813 | + if ( |
|
814 | + $this->checkout->reg_url_link |
|
815 | + && $this->checkout->step !== $reg_step['slug'] |
|
816 | + && $reg_step['slug'] !== 'finalize_registration' |
|
817 | + // normally at this point we would NOT load the reg step, but this filter can change that |
|
818 | + && apply_filters( |
|
819 | + 'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step', |
|
820 | + true, |
|
821 | + $reg_step, |
|
822 | + $this->checkout |
|
823 | + ) |
|
824 | + ) { |
|
825 | + return true; |
|
826 | + } |
|
827 | + // instantiate step class using file path and class name |
|
828 | + $reg_step_obj = EE_Registry::instance()->load_file( |
|
829 | + $reg_step['file_path'], |
|
830 | + $reg_step['class_name'], |
|
831 | + 'class', |
|
832 | + $this->checkout, |
|
833 | + false |
|
834 | + ); |
|
835 | + // did we gets the goods ? |
|
836 | + if ($reg_step_obj instanceof EE_SPCO_Reg_Step) { |
|
837 | + // set reg step order based on config |
|
838 | + $reg_step_obj->set_order($order); |
|
839 | + // add instantiated reg step object to the master reg steps array |
|
840 | + $this->checkout->add_reg_step($reg_step_obj); |
|
841 | + } else { |
|
842 | + EE_Error::add_error( |
|
843 | + __('The current step could not be set.', 'event_espresso'), |
|
844 | + __FILE__, __FUNCTION__, __LINE__ |
|
845 | + ); |
|
846 | + return false; |
|
847 | + } |
|
848 | + } else { |
|
849 | + if (WP_DEBUG) { |
|
850 | + EE_Error::add_error( |
|
851 | + sprintf( |
|
852 | + __( |
|
853 | + 'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s', |
|
854 | + 'event_espresso' |
|
855 | + ), |
|
856 | + isset($reg_step['file_path']) ? $reg_step['file_path'] : '', |
|
857 | + isset($reg_step['class_name']) ? $reg_step['class_name'] : '', |
|
858 | + isset($reg_step['slug']) ? $reg_step['slug'] : '', |
|
859 | + '<ul>', |
|
860 | + '<li>', |
|
861 | + '</li>', |
|
862 | + '</ul>' |
|
863 | + ), |
|
864 | + __FILE__, __FUNCTION__, __LINE__ |
|
865 | + ); |
|
866 | + } |
|
867 | + return false; |
|
868 | + } |
|
869 | + return true; |
|
870 | + } |
|
871 | + |
|
872 | + |
|
873 | + /** |
|
874 | + * _verify_transaction_and_get_registrations |
|
875 | + * |
|
876 | + * @access private |
|
877 | + * @return bool |
|
878 | + * @throws InvalidDataTypeException |
|
879 | + * @throws InvalidEntityException |
|
880 | + * @throws EE_Error |
|
881 | + */ |
|
882 | + private function _verify_transaction_and_get_registrations() |
|
883 | + { |
|
884 | + // was there already a valid transaction in the checkout from the session ? |
|
885 | + if ( ! $this->checkout->transaction instanceof EE_Transaction) { |
|
886 | + // get transaction from db or session |
|
887 | + $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin() |
|
888 | + ? $this->_get_transaction_and_cart_for_previous_visit() |
|
889 | + : $this->_get_cart_for_current_session_and_setup_new_transaction(); |
|
890 | + if ( ! $this->checkout->transaction instanceof EE_Transaction) { |
|
891 | + EE_Error::add_error( |
|
892 | + __('Your Registration and Transaction information could not be retrieved from the db.', |
|
893 | + 'event_espresso'), |
|
894 | + __FILE__, __FUNCTION__, __LINE__ |
|
895 | + ); |
|
896 | + $this->checkout->transaction = EE_Transaction::new_instance(); |
|
897 | + // add some style and make it dance |
|
898 | + $this->add_styles_and_scripts(); |
|
899 | + EED_Single_Page_Checkout::$_initialized = true; |
|
900 | + return false; |
|
901 | + } |
|
902 | + // and the registrations for the transaction |
|
903 | + $this->_get_registrations($this->checkout->transaction); |
|
904 | + } |
|
905 | + return true; |
|
906 | + } |
|
907 | + |
|
908 | + |
|
909 | + |
|
910 | + /** |
|
911 | + * _get_transaction_and_cart_for_previous_visit |
|
912 | + * |
|
913 | + * @access private |
|
914 | + * @return mixed EE_Transaction|NULL |
|
915 | + */ |
|
916 | + private function _get_transaction_and_cart_for_previous_visit() |
|
917 | + { |
|
918 | + /** @var $TXN_model EEM_Transaction */ |
|
919 | + $TXN_model = EE_Registry::instance()->load_model('Transaction'); |
|
920 | + // because the reg_url_link is present in the request, |
|
921 | + // this is a return visit to SPCO, so we'll get the transaction data from the db |
|
922 | + $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link); |
|
923 | + // verify transaction |
|
924 | + if ($transaction instanceof EE_Transaction) { |
|
925 | + // and get the cart that was used for that transaction |
|
926 | + $this->checkout->cart = $this->_get_cart_for_transaction($transaction); |
|
927 | + return $transaction; |
|
928 | + } |
|
929 | + EE_Error::add_error( |
|
930 | + __('Your Registration and Transaction information could not be retrieved from the db.', 'event_espresso'), |
|
931 | + __FILE__, __FUNCTION__, __LINE__ |
|
932 | + ); |
|
933 | + return null; |
|
934 | + |
|
935 | + } |
|
936 | + |
|
937 | + |
|
938 | + |
|
939 | + /** |
|
940 | + * _get_cart_for_transaction |
|
941 | + * |
|
942 | + * @access private |
|
943 | + * @param EE_Transaction $transaction |
|
944 | + * @return EE_Cart |
|
945 | + */ |
|
946 | + private function _get_cart_for_transaction($transaction) |
|
947 | + { |
|
948 | + return $this->checkout->get_cart_for_transaction($transaction); |
|
949 | + } |
|
950 | + |
|
951 | + |
|
952 | + |
|
953 | + /** |
|
954 | + * get_cart_for_transaction |
|
955 | + * |
|
956 | + * @access public |
|
957 | + * @param EE_Transaction $transaction |
|
958 | + * @return EE_Cart |
|
959 | + */ |
|
960 | + public function get_cart_for_transaction(EE_Transaction $transaction) |
|
961 | + { |
|
962 | + return $this->checkout->get_cart_for_transaction($transaction); |
|
963 | + } |
|
964 | + |
|
965 | + |
|
966 | + |
|
967 | + /** |
|
968 | + * _get_transaction_and_cart_for_current_session |
|
969 | + * generates a new EE_Transaction object and adds it to the $_transaction property. |
|
970 | + * |
|
971 | + * @access private |
|
972 | + * @return EE_Transaction |
|
973 | + * @throws EE_Error |
|
974 | + */ |
|
975 | + private function _get_cart_for_current_session_and_setup_new_transaction() |
|
976 | + { |
|
977 | + // if there's no transaction, then this is the FIRST visit to SPCO |
|
978 | + // so load up the cart ( passing nothing for the TXN because it doesn't exist yet ) |
|
979 | + $this->checkout->cart = $this->_get_cart_for_transaction(null); |
|
980 | + // and then create a new transaction |
|
981 | + $transaction = $this->_initialize_transaction(); |
|
982 | + // verify transaction |
|
983 | + if ($transaction instanceof EE_Transaction) { |
|
984 | + // save it so that we have an ID for other objects to use |
|
985 | + $transaction->save(); |
|
986 | + // and save TXN data to the cart |
|
987 | + $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID()); |
|
988 | + } else { |
|
989 | + EE_Error::add_error( |
|
990 | + __('A Valid Transaction could not be initialized.', 'event_espresso'), |
|
991 | + __FILE__, __FUNCTION__, __LINE__ |
|
992 | + ); |
|
993 | + } |
|
994 | + return $transaction; |
|
995 | + } |
|
996 | + |
|
997 | + |
|
998 | + |
|
999 | + /** |
|
1000 | + * generates a new EE_Transaction object and adds it to the $_transaction property. |
|
1001 | + * |
|
1002 | + * @access private |
|
1003 | + * @return mixed EE_Transaction|NULL |
|
1004 | + */ |
|
1005 | + private function _initialize_transaction() |
|
1006 | + { |
|
1007 | + try { |
|
1008 | + // ensure cart totals have been calculated |
|
1009 | + $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes(); |
|
1010 | + // grab the cart grand total |
|
1011 | + $cart_total = $this->checkout->cart->get_cart_grand_total(); |
|
1012 | + // create new TXN |
|
1013 | + $transaction = EE_Transaction::new_instance( |
|
1014 | + array( |
|
1015 | + 'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(), |
|
1016 | + 'TXN_total' => $cart_total > 0 ? $cart_total : 0, |
|
1017 | + 'TXN_paid' => 0, |
|
1018 | + 'STS_ID' => EEM_Transaction::failed_status_code, |
|
1019 | + ) |
|
1020 | + ); |
|
1021 | + // save it so that we have an ID for other objects to use |
|
1022 | + $transaction->save(); |
|
1023 | + // set cron job for following up on TXNs after their session has expired |
|
1024 | + EE_Cron_Tasks::schedule_expired_transaction_check( |
|
1025 | + EE_Registry::instance()->SSN->expiration() + 1, |
|
1026 | + $transaction->ID() |
|
1027 | + ); |
|
1028 | + return $transaction; |
|
1029 | + } catch (Exception $e) { |
|
1030 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
1031 | + } |
|
1032 | + return null; |
|
1033 | + } |
|
1034 | + |
|
1035 | + |
|
1036 | + /** |
|
1037 | + * _get_registrations |
|
1038 | + * |
|
1039 | + * @access private |
|
1040 | + * @param EE_Transaction $transaction |
|
1041 | + * @return void |
|
1042 | + * @throws InvalidDataTypeException |
|
1043 | + * @throws InvalidEntityException |
|
1044 | + * @throws EE_Error |
|
1045 | + */ |
|
1046 | + private function _get_registrations(EE_Transaction $transaction) |
|
1047 | + { |
|
1048 | + // first step: grab the registrants { : o |
|
1049 | + $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false); |
|
1050 | + $this->checkout->total_ticket_count = count($registrations); |
|
1051 | + // verify registrations have been set |
|
1052 | + if (empty($registrations)) { |
|
1053 | + // if no cached registrations, then check the db |
|
1054 | + $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, false); |
|
1055 | + // still nothing ? well as long as this isn't a revisit |
|
1056 | + if (empty($registrations) && ! $this->checkout->revisit) { |
|
1057 | + // generate new registrations from scratch |
|
1058 | + $registrations = $this->_initialize_registrations($transaction); |
|
1059 | + } |
|
1060 | + } |
|
1061 | + // sort by their original registration order |
|
1062 | + usort($registrations, array('EED_Single_Page_Checkout', 'sort_registrations_by_REG_count')); |
|
1063 | + // then loop thru the array |
|
1064 | + foreach ($registrations as $registration) { |
|
1065 | + // verify each registration |
|
1066 | + if ($registration instanceof EE_Registration) { |
|
1067 | + // we display all attendee info for the primary registrant |
|
1068 | + if ($this->checkout->reg_url_link === $registration->reg_url_link() |
|
1069 | + && $registration->is_primary_registrant() |
|
1070 | + ) { |
|
1071 | + $this->checkout->primary_revisit = true; |
|
1072 | + break; |
|
1073 | + } |
|
1074 | + if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) { |
|
1075 | + // but hide info if it doesn't belong to you |
|
1076 | + $transaction->clear_cache('Registration', $registration->ID()); |
|
1077 | + $this->checkout->total_ticket_count--; |
|
1078 | + } |
|
1079 | + $this->checkout->set_reg_status_updated($registration->ID(), false); |
|
1080 | + } |
|
1081 | + } |
|
1082 | + } |
|
1083 | + |
|
1084 | + |
|
1085 | + /** |
|
1086 | + * adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object |
|
1087 | + * |
|
1088 | + * @access private |
|
1089 | + * @param EE_Transaction $transaction |
|
1090 | + * @return array |
|
1091 | + * @throws InvalidDataTypeException |
|
1092 | + * @throws InvalidEntityException |
|
1093 | + * @throws EE_Error |
|
1094 | + */ |
|
1095 | + private function _initialize_registrations(EE_Transaction $transaction) |
|
1096 | + { |
|
1097 | + $att_nmbr = 0; |
|
1098 | + $registrations = array(); |
|
1099 | + if ($transaction instanceof EE_Transaction) { |
|
1100 | + /** @type EE_Registration_Processor $registration_processor */ |
|
1101 | + $registration_processor = EE_Registry::instance()->load_class('Registration_Processor'); |
|
1102 | + $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count(); |
|
1103 | + // now let's add the cart items to the $transaction |
|
1104 | + foreach ($this->checkout->cart->get_tickets() as $line_item) { |
|
1105 | + //do the following for each ticket of this type they selected |
|
1106 | + for ($x = 1; $x <= $line_item->quantity(); $x++) { |
|
1107 | + $att_nmbr++; |
|
1108 | + /** @var EventEspresso\core\services\commands\registration\CreateRegistrationCommand $CreateRegistrationCommand */ |
|
1109 | + $CreateRegistrationCommand = EE_Registry::instance()->create( |
|
1110 | + 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
1111 | + array( |
|
1112 | + $transaction, |
|
1113 | + $line_item, |
|
1114 | + $att_nmbr, |
|
1115 | + $this->checkout->total_ticket_count, |
|
1116 | + ) |
|
1117 | + ); |
|
1118 | + // override capabilities for frontend registrations |
|
1119 | + if ( ! is_admin()) { |
|
1120 | + $CreateRegistrationCommand->setCapCheck( |
|
1121 | + new PublicCapabilities('', 'create_new_registration') |
|
1122 | + ); |
|
1123 | + } |
|
1124 | + $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand); |
|
1125 | + if ( ! $registration instanceof EE_Registration) { |
|
1126 | + throw new InvalidEntityException($registration, 'EE_Registration'); |
|
1127 | + } |
|
1128 | + $registrations[ $registration->ID() ] = $registration; |
|
1129 | + } |
|
1130 | + } |
|
1131 | + $registration_processor->fix_reg_final_price_rounding_issue($transaction); |
|
1132 | + } |
|
1133 | + return $registrations; |
|
1134 | + } |
|
1135 | + |
|
1136 | + |
|
1137 | + |
|
1138 | + /** |
|
1139 | + * sorts registrations by REG_count |
|
1140 | + * |
|
1141 | + * @access public |
|
1142 | + * @param EE_Registration $reg_A |
|
1143 | + * @param EE_Registration $reg_B |
|
1144 | + * @return int |
|
1145 | + */ |
|
1146 | + public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B) |
|
1147 | + { |
|
1148 | + // this shouldn't ever happen within the same TXN, but oh well |
|
1149 | + if ($reg_A->count() === $reg_B->count()) { |
|
1150 | + return 0; |
|
1151 | + } |
|
1152 | + return ($reg_A->count() > $reg_B->count()) ? 1 : -1; |
|
1153 | + } |
|
1154 | + |
|
1155 | + |
|
1156 | + |
|
1157 | + /** |
|
1158 | + * _final_verifications |
|
1159 | + * just makes sure that everything is set up correctly before proceeding |
|
1160 | + * |
|
1161 | + * @access private |
|
1162 | + * @return bool |
|
1163 | + * @throws EE_Error |
|
1164 | + */ |
|
1165 | + private function _final_verifications() |
|
1166 | + { |
|
1167 | + // filter checkout |
|
1168 | + $this->checkout = apply_filters( |
|
1169 | + 'FHEE__EED_Single_Page_Checkout___final_verifications__checkout', |
|
1170 | + $this->checkout |
|
1171 | + ); |
|
1172 | + //verify that current step is still set correctly |
|
1173 | + if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) { |
|
1174 | + EE_Error::add_error( |
|
1175 | + __('We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.', 'event_espresso'), |
|
1176 | + __FILE__, |
|
1177 | + __FUNCTION__, |
|
1178 | + __LINE__ |
|
1179 | + ); |
|
1180 | + return false; |
|
1181 | + } |
|
1182 | + // if returning to SPCO, then verify that primary registrant is set |
|
1183 | + if ( ! empty($this->checkout->reg_url_link)) { |
|
1184 | + $valid_registrant = $this->checkout->transaction->primary_registration(); |
|
1185 | + if ( ! $valid_registrant instanceof EE_Registration) { |
|
1186 | + EE_Error::add_error( |
|
1187 | + __('We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.', 'event_espresso'), |
|
1188 | + __FILE__, |
|
1189 | + __FUNCTION__, |
|
1190 | + __LINE__ |
|
1191 | + ); |
|
1192 | + return false; |
|
1193 | + } |
|
1194 | + $valid_registrant = null; |
|
1195 | + foreach ( |
|
1196 | + $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration |
|
1197 | + ) { |
|
1198 | + if ( |
|
1199 | + $registration instanceof EE_Registration |
|
1200 | + && $registration->reg_url_link() === $this->checkout->reg_url_link |
|
1201 | + ) { |
|
1202 | + $valid_registrant = $registration; |
|
1203 | + } |
|
1204 | + } |
|
1205 | + if ( ! $valid_registrant instanceof EE_Registration) { |
|
1206 | + // hmmm... maybe we have the wrong session because the user is opening multiple tabs ? |
|
1207 | + if (EED_Single_Page_Checkout::$_checkout_verified) { |
|
1208 | + // clear the session, mark the checkout as unverified, and try again |
|
1209 | + EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__); |
|
1210 | + EED_Single_Page_Checkout::$_initialized = false; |
|
1211 | + EED_Single_Page_Checkout::$_checkout_verified = false; |
|
1212 | + $this->_initialize(); |
|
1213 | + EE_Error::reset_notices(); |
|
1214 | + return false; |
|
1215 | + } |
|
1216 | + EE_Error::add_error( |
|
1217 | + __( |
|
1218 | + 'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.', |
|
1219 | + 'event_espresso' |
|
1220 | + ), |
|
1221 | + __FILE__, |
|
1222 | + __FUNCTION__, |
|
1223 | + __LINE__ |
|
1224 | + ); |
|
1225 | + return false; |
|
1226 | + } |
|
1227 | + } |
|
1228 | + // now that things have been kinda sufficiently verified, |
|
1229 | + // let's add the checkout to the session so that it's available to other systems |
|
1230 | + EE_Registry::instance()->SSN->set_checkout($this->checkout); |
|
1231 | + return true; |
|
1232 | + } |
|
1233 | + |
|
1234 | + |
|
1235 | + |
|
1236 | + /** |
|
1237 | + * _initialize_reg_steps |
|
1238 | + * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required |
|
1239 | + * then loops thru all of the active reg steps and calls the initialize_reg_step() method |
|
1240 | + * |
|
1241 | + * @access private |
|
1242 | + * @param bool $reinitializing |
|
1243 | + * @throws EE_Error |
|
1244 | + */ |
|
1245 | + private function _initialize_reg_steps($reinitializing = false) |
|
1246 | + { |
|
1247 | + $this->checkout->set_reg_step_initiated($this->checkout->current_step); |
|
1248 | + // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS |
|
1249 | + foreach ($this->checkout->reg_steps as $reg_step) { |
|
1250 | + if ( ! $reg_step->initialize_reg_step()) { |
|
1251 | + // if not initialized then maybe this step is being removed... |
|
1252 | + if ( ! $reinitializing && $reg_step->is_current_step()) { |
|
1253 | + // if it was the current step, then we need to start over here |
|
1254 | + $this->_initialize_reg_steps(true); |
|
1255 | + return; |
|
1256 | + } |
|
1257 | + continue; |
|
1258 | + } |
|
1259 | + // add css and JS for current step |
|
1260 | + $reg_step->enqueue_styles_and_scripts(); |
|
1261 | + // i18n |
|
1262 | + $reg_step->translate_js_strings(); |
|
1263 | + if ($reg_step->is_current_step()) { |
|
1264 | + // the text that appears on the reg step form submit button |
|
1265 | + $reg_step->set_submit_button_text(); |
|
1266 | + } |
|
1267 | + } |
|
1268 | + // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information |
|
1269 | + do_action( |
|
1270 | + "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}", |
|
1271 | + $this->checkout->current_step |
|
1272 | + ); |
|
1273 | + } |
|
1274 | + |
|
1275 | + |
|
1276 | + |
|
1277 | + /** |
|
1278 | + * _check_form_submission |
|
1279 | + * |
|
1280 | + * @access private |
|
1281 | + * @return boolean |
|
1282 | + */ |
|
1283 | + private function _check_form_submission() |
|
1284 | + { |
|
1285 | + //does this request require the reg form to be generated ? |
|
1286 | + if ($this->checkout->generate_reg_form) { |
|
1287 | + // ever heard that song by Blue Rodeo ? |
|
1288 | + try { |
|
1289 | + $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form(); |
|
1290 | + // if not displaying a form, then check for form submission |
|
1291 | + if ( |
|
1292 | + $this->checkout->process_form_submission |
|
1293 | + && $this->checkout->current_step->reg_form->was_submitted() |
|
1294 | + ) { |
|
1295 | + // clear out any old data in case this step is being run again |
|
1296 | + $this->checkout->current_step->set_valid_data(array()); |
|
1297 | + // capture submitted form data |
|
1298 | + $this->checkout->current_step->reg_form->receive_form_submission( |
|
1299 | + apply_filters( |
|
1300 | + 'FHEE__Single_Page_Checkout___check_form_submission__request_params', |
|
1301 | + EE_Registry::instance()->REQ->params(), |
|
1302 | + $this->checkout |
|
1303 | + ) |
|
1304 | + ); |
|
1305 | + // validate submitted form data |
|
1306 | + if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) { |
|
1307 | + // thou shall not pass !!! |
|
1308 | + $this->checkout->continue_reg = false; |
|
1309 | + // any form validation errors? |
|
1310 | + if ($this->checkout->current_step->reg_form->submission_error_message() !== '') { |
|
1311 | + EE_Error::add_error( |
|
1312 | + $this->checkout->current_step->reg_form->submission_error_message(), |
|
1313 | + __FILE__, __FUNCTION__, __LINE__ |
|
1314 | + ); |
|
1315 | + } |
|
1316 | + // well not really... what will happen is |
|
1317 | + // we'll just get redirected back to redo the current step |
|
1318 | + $this->go_to_next_step(); |
|
1319 | + return false; |
|
1320 | + } |
|
1321 | + } |
|
1322 | + } catch (EE_Error $e) { |
|
1323 | + $e->get_error(); |
|
1324 | + } |
|
1325 | + } |
|
1326 | + return true; |
|
1327 | + } |
|
1328 | + |
|
1329 | + |
|
1330 | + |
|
1331 | + /** |
|
1332 | + * _process_action |
|
1333 | + * |
|
1334 | + * @access private |
|
1335 | + * @return void |
|
1336 | + * @throws EE_Error |
|
1337 | + */ |
|
1338 | + private function _process_form_action() |
|
1339 | + { |
|
1340 | + // what cha wanna do? |
|
1341 | + switch ($this->checkout->action) { |
|
1342 | + // AJAX next step reg form |
|
1343 | + case 'display_spco_reg_step' : |
|
1344 | + $this->checkout->redirect = false; |
|
1345 | + if (EE_Registry::instance()->REQ->ajax) { |
|
1346 | + $this->checkout->json_response->set_reg_step_html( |
|
1347 | + $this->checkout->current_step->display_reg_form() |
|
1348 | + ); |
|
1349 | + } |
|
1350 | + break; |
|
1351 | + default : |
|
1352 | + // meh... do one of those other steps first |
|
1353 | + if ( |
|
1354 | + ! empty($this->checkout->action) |
|
1355 | + && is_callable(array($this->checkout->current_step, $this->checkout->action)) |
|
1356 | + ) { |
|
1357 | + // dynamically creates hook point like: |
|
1358 | + // AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step |
|
1359 | + do_action( |
|
1360 | + "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}", |
|
1361 | + $this->checkout->current_step |
|
1362 | + ); |
|
1363 | + // call action on current step |
|
1364 | + if (call_user_func(array($this->checkout->current_step, $this->checkout->action))) { |
|
1365 | + // good registrant, you get to proceed |
|
1366 | + if ( |
|
1367 | + $this->checkout->current_step->success_message() !== '' |
|
1368 | + && apply_filters( |
|
1369 | + 'FHEE__Single_Page_Checkout___process_form_action__display_success', |
|
1370 | + false |
|
1371 | + ) |
|
1372 | + ) { |
|
1373 | + EE_Error::add_success( |
|
1374 | + $this->checkout->current_step->success_message() |
|
1375 | + . '<br />' . $this->checkout->next_step->_instructions() |
|
1376 | + ); |
|
1377 | + } |
|
1378 | + // pack it up, pack it in... |
|
1379 | + $this->_setup_redirect(); |
|
1380 | + } |
|
1381 | + // dynamically creates hook point like: |
|
1382 | + // AHEE__Single_Page_Checkout__after_payment_options__process_reg_step |
|
1383 | + do_action( |
|
1384 | + "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}", |
|
1385 | + $this->checkout->current_step |
|
1386 | + ); |
|
1387 | + } else { |
|
1388 | + EE_Error::add_error( |
|
1389 | + sprintf( |
|
1390 | + __( |
|
1391 | + 'The requested form action "%s" does not exist for the current "%s" registration step.', |
|
1392 | + 'event_espresso' |
|
1393 | + ), |
|
1394 | + $this->checkout->action, |
|
1395 | + $this->checkout->current_step->name() |
|
1396 | + ), |
|
1397 | + __FILE__, |
|
1398 | + __FUNCTION__, |
|
1399 | + __LINE__ |
|
1400 | + ); |
|
1401 | + } |
|
1402 | + // end default |
|
1403 | + } |
|
1404 | + // store our progress so far |
|
1405 | + $this->checkout->stash_transaction_and_checkout(); |
|
1406 | + // advance to the next step! If you pass GO, collect $200 |
|
1407 | + $this->go_to_next_step(); |
|
1408 | + } |
|
1409 | + |
|
1410 | + |
|
1411 | + |
|
1412 | + /** |
|
1413 | + * add_styles_and_scripts |
|
1414 | + * |
|
1415 | + * @access public |
|
1416 | + * @return void |
|
1417 | + */ |
|
1418 | + public function add_styles_and_scripts() |
|
1419 | + { |
|
1420 | + // i18n |
|
1421 | + $this->translate_js_strings(); |
|
1422 | + if ($this->checkout->admin_request) { |
|
1423 | + add_action('admin_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10); |
|
1424 | + } else { |
|
1425 | + add_action('wp_enqueue_scripts', array($this, 'enqueue_styles_and_scripts'), 10); |
|
1426 | + } |
|
1427 | + } |
|
1428 | + |
|
1429 | + |
|
1430 | + |
|
1431 | + /** |
|
1432 | + * translate_js_strings |
|
1433 | + * |
|
1434 | + * @access public |
|
1435 | + * @return void |
|
1436 | + */ |
|
1437 | + public function translate_js_strings() |
|
1438 | + { |
|
1439 | + EE_Registry::$i18n_js_strings['revisit'] = $this->checkout->revisit; |
|
1440 | + EE_Registry::$i18n_js_strings['e_reg_url_link'] = $this->checkout->reg_url_link; |
|
1441 | + EE_Registry::$i18n_js_strings['server_error'] = __( |
|
1442 | + 'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.', |
|
1443 | + 'event_espresso' |
|
1444 | + ); |
|
1445 | + EE_Registry::$i18n_js_strings['invalid_json_response'] = __( |
|
1446 | + 'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.', |
|
1447 | + 'event_espresso' |
|
1448 | + ); |
|
1449 | + EE_Registry::$i18n_js_strings['validation_error'] = __( |
|
1450 | + 'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.', |
|
1451 | + 'event_espresso' |
|
1452 | + ); |
|
1453 | + EE_Registry::$i18n_js_strings['invalid_payment_method'] = __( |
|
1454 | + 'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.', |
|
1455 | + 'event_espresso' |
|
1456 | + ); |
|
1457 | + EE_Registry::$i18n_js_strings['reg_step_error'] = __( |
|
1458 | + 'This registration step could not be completed. Please refresh the page and try again.', |
|
1459 | + 'event_espresso' |
|
1460 | + ); |
|
1461 | + EE_Registry::$i18n_js_strings['invalid_coupon'] = __( |
|
1462 | + 'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.', |
|
1463 | + 'event_espresso' |
|
1464 | + ); |
|
1465 | + EE_Registry::$i18n_js_strings['process_registration'] = sprintf( |
|
1466 | + __( |
|
1467 | + 'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.', |
|
1468 | + 'event_espresso' |
|
1469 | + ), |
|
1470 | + '<br/>', |
|
1471 | + '<br/>' |
|
1472 | + ); |
|
1473 | + EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language'); |
|
1474 | + EE_Registry::$i18n_js_strings['EESID'] = EE_Registry::instance()->SSN->id(); |
|
1475 | + EE_Registry::$i18n_js_strings['currency'] = EE_Registry::instance()->CFG->currency; |
|
1476 | + EE_Registry::$i18n_js_strings['datepicker_yearRange'] = '-150:+20'; |
|
1477 | + EE_Registry::$i18n_js_strings['timer_years'] = __('years', 'event_espresso'); |
|
1478 | + EE_Registry::$i18n_js_strings['timer_months'] = __('months', 'event_espresso'); |
|
1479 | + EE_Registry::$i18n_js_strings['timer_weeks'] = __('weeks', 'event_espresso'); |
|
1480 | + EE_Registry::$i18n_js_strings['timer_days'] = __('days', 'event_espresso'); |
|
1481 | + EE_Registry::$i18n_js_strings['timer_hours'] = __('hours', 'event_espresso'); |
|
1482 | + EE_Registry::$i18n_js_strings['timer_minutes'] = __('minutes', 'event_espresso'); |
|
1483 | + EE_Registry::$i18n_js_strings['timer_seconds'] = __('seconds', 'event_espresso'); |
|
1484 | + EE_Registry::$i18n_js_strings['timer_year'] = __('year', 'event_espresso'); |
|
1485 | + EE_Registry::$i18n_js_strings['timer_month'] = __('month', 'event_espresso'); |
|
1486 | + EE_Registry::$i18n_js_strings['timer_week'] = __('week', 'event_espresso'); |
|
1487 | + EE_Registry::$i18n_js_strings['timer_day'] = __('day', 'event_espresso'); |
|
1488 | + EE_Registry::$i18n_js_strings['timer_hour'] = __('hour', 'event_espresso'); |
|
1489 | + EE_Registry::$i18n_js_strings['timer_minute'] = __('minute', 'event_espresso'); |
|
1490 | + EE_Registry::$i18n_js_strings['timer_second'] = __('second', 'event_espresso'); |
|
1491 | + EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf( |
|
1492 | + __( |
|
1493 | + '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s', |
|
1494 | + 'event_espresso' |
|
1495 | + ), |
|
1496 | + '<h4 class="important-notice">', |
|
1497 | + '</h4>', |
|
1498 | + '<br />', |
|
1499 | + '<p>', |
|
1500 | + '<a href="' . get_post_type_archive_link('espresso_events') . '" title="', |
|
1501 | + '">', |
|
1502 | + '</a>', |
|
1503 | + '</p>' |
|
1504 | + ); |
|
1505 | + EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters( |
|
1506 | + 'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit', |
|
1507 | + true |
|
1508 | + ); |
|
1509 | + EE_Registry::$i18n_js_strings['session_extension'] = absint( |
|
1510 | + apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS) |
|
1511 | + ); |
|
1512 | + EE_Registry::$i18n_js_strings['session_expiration'] = gmdate( |
|
1513 | + 'M d, Y H:i:s', |
|
1514 | + EE_Registry::instance()->SSN->expiration() + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
1515 | + ); |
|
1516 | + } |
|
1517 | + |
|
1518 | + |
|
1519 | + |
|
1520 | + /** |
|
1521 | + * enqueue_styles_and_scripts |
|
1522 | + * |
|
1523 | + * @access public |
|
1524 | + * @return void |
|
1525 | + * @throws EE_Error |
|
1526 | + */ |
|
1527 | + public function enqueue_styles_and_scripts() |
|
1528 | + { |
|
1529 | + // load css |
|
1530 | + wp_register_style( |
|
1531 | + 'single_page_checkout', |
|
1532 | + SPCO_CSS_URL . 'single_page_checkout.css', |
|
1533 | + array('espresso_default'), |
|
1534 | + EVENT_ESPRESSO_VERSION |
|
1535 | + ); |
|
1536 | + wp_enqueue_style('single_page_checkout'); |
|
1537 | + // load JS |
|
1538 | + wp_register_script( |
|
1539 | + 'jquery_plugin', |
|
1540 | + EE_THIRD_PARTY_URL . 'jquery .plugin.min.js', |
|
1541 | + array('jquery'), |
|
1542 | + '1.0.1', |
|
1543 | + true |
|
1544 | + ); |
|
1545 | + wp_register_script( |
|
1546 | + 'jquery_countdown', |
|
1547 | + EE_THIRD_PARTY_URL . 'jquery .countdown.min.js', |
|
1548 | + array('jquery_plugin'), |
|
1549 | + '2.0.2', |
|
1550 | + true |
|
1551 | + ); |
|
1552 | + wp_register_script( |
|
1553 | + 'single_page_checkout', |
|
1554 | + SPCO_JS_URL . 'single_page_checkout.js', |
|
1555 | + array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'), |
|
1556 | + EVENT_ESPRESSO_VERSION, |
|
1557 | + true |
|
1558 | + ); |
|
1559 | + if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) { |
|
1560 | + $this->checkout->registration_form->enqueue_js(); |
|
1561 | + } |
|
1562 | + if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) { |
|
1563 | + $this->checkout->current_step->reg_form->enqueue_js(); |
|
1564 | + } |
|
1565 | + wp_enqueue_script('single_page_checkout'); |
|
1566 | + /** |
|
1567 | + * global action hook for enqueueing styles and scripts with |
|
1568 | + * spco calls. |
|
1569 | + */ |
|
1570 | + do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this); |
|
1571 | + /** |
|
1572 | + * dynamic action hook for enqueueing styles and scripts with spco calls. |
|
1573 | + * The hook will end up being something like: |
|
1574 | + * AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information |
|
1575 | + */ |
|
1576 | + do_action( |
|
1577 | + 'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(), |
|
1578 | + $this |
|
1579 | + ); |
|
1580 | + } |
|
1581 | + |
|
1582 | + |
|
1583 | + |
|
1584 | + /** |
|
1585 | + * display the Registration Single Page Checkout Form |
|
1586 | + * |
|
1587 | + * @access private |
|
1588 | + * @return void |
|
1589 | + * @throws EE_Error |
|
1590 | + */ |
|
1591 | + private function _display_spco_reg_form() |
|
1592 | + { |
|
1593 | + // if registering via the admin, just display the reg form for the current step |
|
1594 | + if ($this->checkout->admin_request) { |
|
1595 | + EE_Registry::instance()->REQ->add_output($this->checkout->current_step->display_reg_form()); |
|
1596 | + } else { |
|
1597 | + // add powered by EE msg |
|
1598 | + add_action('AHEE__SPCO__reg_form_footer', array('EED_Single_Page_Checkout', 'display_registration_footer')); |
|
1599 | + $empty_cart = count( |
|
1600 | + $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) |
|
1601 | + ) < 1; |
|
1602 | + EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart; |
|
1603 | + $cookies_not_set_msg = ''; |
|
1604 | + if ($empty_cart) { |
|
1605 | + $cookies_not_set_msg = apply_filters( |
|
1606 | + 'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg', |
|
1607 | + sprintf( |
|
1608 | + __( |
|
1609 | + '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s', |
|
1610 | + 'event_espresso' |
|
1611 | + ), |
|
1612 | + '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">', |
|
1613 | + '</div>', |
|
1614 | + '<h6 class="important-notice">', |
|
1615 | + '</h6>', |
|
1616 | + '<p>', |
|
1617 | + '</p>', |
|
1618 | + '<br />', |
|
1619 | + '<a href="http://www.whatarecookies.com/enable.asp" target="_blank">', |
|
1620 | + '</a>' |
|
1621 | + ) |
|
1622 | + ); |
|
1623 | + } |
|
1624 | + $this->checkout->registration_form = new EE_Form_Section_Proper( |
|
1625 | + array( |
|
1626 | + 'name' => 'single-page-checkout', |
|
1627 | + 'html_id' => 'ee-single-page-checkout-dv', |
|
1628 | + 'layout_strategy' => |
|
1629 | + new EE_Template_Layout( |
|
1630 | + array( |
|
1631 | + 'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php', |
|
1632 | + 'template_args' => array( |
|
1633 | + 'empty_cart' => $empty_cart, |
|
1634 | + 'revisit' => $this->checkout->revisit, |
|
1635 | + 'reg_steps' => $this->checkout->reg_steps, |
|
1636 | + 'next_step' => $this->checkout->next_step instanceof EE_SPCO_Reg_Step |
|
1637 | + ? $this->checkout->next_step->slug() |
|
1638 | + : '', |
|
1639 | + 'empty_msg' => apply_filters( |
|
1640 | + 'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg', |
|
1641 | + sprintf( |
|
1642 | + __( |
|
1643 | + 'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.', |
|
1644 | + 'event_espresso' |
|
1645 | + ), |
|
1646 | + '<a href="' |
|
1647 | + . get_post_type_archive_link('espresso_events') |
|
1648 | + . '" title="', |
|
1649 | + '">', |
|
1650 | + '</a>' |
|
1651 | + ) |
|
1652 | + ), |
|
1653 | + 'cookies_not_set_msg' => $cookies_not_set_msg, |
|
1654 | + 'registration_time_limit' => $this->checkout->get_registration_time_limit(), |
|
1655 | + 'session_expiration' => gmdate( |
|
1656 | + 'M d, Y H:i:s', |
|
1657 | + EE_Registry::instance()->SSN->expiration() |
|
1658 | + + (get_option('gmt_offset') * HOUR_IN_SECONDS) |
|
1659 | + ), |
|
1660 | + ), |
|
1661 | + ) |
|
1662 | + ), |
|
1663 | + ) |
|
1664 | + ); |
|
1665 | + // load template and add to output sent that gets filtered into the_content() |
|
1666 | + EE_Registry::instance()->REQ->add_output($this->checkout->registration_form->get_html()); |
|
1667 | + } |
|
1668 | + } |
|
1669 | + |
|
1670 | + |
|
1671 | + |
|
1672 | + /** |
|
1673 | + * add_extra_finalize_registration_inputs |
|
1674 | + * |
|
1675 | + * @access public |
|
1676 | + * @param $next_step |
|
1677 | + * @internal param string $label |
|
1678 | + * @return void |
|
1679 | + */ |
|
1680 | + public function add_extra_finalize_registration_inputs($next_step) |
|
1681 | + { |
|
1682 | + if ($next_step === 'finalize_registration') { |
|
1683 | + echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>'; |
|
1684 | + } |
|
1685 | + } |
|
1686 | + |
|
1687 | + |
|
1688 | + |
|
1689 | + /** |
|
1690 | + * display_registration_footer |
|
1691 | + * |
|
1692 | + * @access public |
|
1693 | + * @return string |
|
1694 | + */ |
|
1695 | + public static function display_registration_footer() |
|
1696 | + { |
|
1697 | + if ( |
|
1698 | + apply_filters( |
|
1699 | + 'FHEE__EE_Front__Controller__show_reg_footer', |
|
1700 | + EE_Registry::instance()->CFG->admin->show_reg_footer |
|
1701 | + ) |
|
1702 | + ) { |
|
1703 | + add_filter( |
|
1704 | + 'FHEE__EEH_Template__powered_by_event_espresso__url', |
|
1705 | + function ($url) { |
|
1706 | + return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url); |
|
1707 | + } |
|
1708 | + ); |
|
1709 | + echo apply_filters( |
|
1710 | + 'FHEE__EE_Front_Controller__display_registration_footer', |
|
1711 | + \EEH_Template::powered_by_event_espresso( |
|
1712 | + '', |
|
1713 | + 'espresso-registration-footer-dv', |
|
1714 | + array('utm_content' => 'registration_checkout') |
|
1715 | + ) |
|
1716 | + ); |
|
1717 | + } |
|
1718 | + return ''; |
|
1719 | + } |
|
1720 | + |
|
1721 | + |
|
1722 | + |
|
1723 | + /** |
|
1724 | + * unlock_transaction |
|
1725 | + * |
|
1726 | + * @access public |
|
1727 | + * @return void |
|
1728 | + * @throws EE_Error |
|
1729 | + */ |
|
1730 | + public function unlock_transaction() |
|
1731 | + { |
|
1732 | + if ($this->checkout->transaction instanceof EE_Transaction) { |
|
1733 | + $this->checkout->transaction->unlock(); |
|
1734 | + } |
|
1735 | + } |
|
1736 | + |
|
1737 | + |
|
1738 | + |
|
1739 | + /** |
|
1740 | + * _setup_redirect |
|
1741 | + * |
|
1742 | + * @access private |
|
1743 | + * @return void |
|
1744 | + */ |
|
1745 | + private function _setup_redirect() |
|
1746 | + { |
|
1747 | + if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) { |
|
1748 | + $this->checkout->redirect = true; |
|
1749 | + if (empty($this->checkout->redirect_url)) { |
|
1750 | + $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url(); |
|
1751 | + } |
|
1752 | + $this->checkout->redirect_url = apply_filters( |
|
1753 | + 'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url', |
|
1754 | + $this->checkout->redirect_url, |
|
1755 | + $this->checkout |
|
1756 | + ); |
|
1757 | + } |
|
1758 | + } |
|
1759 | + |
|
1760 | + |
|
1761 | + |
|
1762 | + /** |
|
1763 | + * handle ajax message responses and redirects |
|
1764 | + * |
|
1765 | + * @access public |
|
1766 | + * @return void |
|
1767 | + * @throws EE_Error |
|
1768 | + */ |
|
1769 | + public function go_to_next_step() |
|
1770 | + { |
|
1771 | + if (EE_Registry::instance()->REQ->ajax) { |
|
1772 | + // capture contents of output buffer we started earlier in the request, and insert into JSON response |
|
1773 | + $this->checkout->json_response->set_unexpected_errors(ob_get_clean()); |
|
1774 | + } |
|
1775 | + $this->unlock_transaction(); |
|
1776 | + // just return for these conditions |
|
1777 | + if ( |
|
1778 | + $this->checkout->admin_request |
|
1779 | + || $this->checkout->action === 'redirect_form' |
|
1780 | + || $this->checkout->action === 'update_checkout' |
|
1781 | + ) { |
|
1782 | + return; |
|
1783 | + } |
|
1784 | + // AJAX response |
|
1785 | + $this->_handle_json_response(); |
|
1786 | + // redirect to next step or the Thank You page |
|
1787 | + $this->_handle_html_redirects(); |
|
1788 | + // hmmm... must be something wrong, so let's just display the form again ! |
|
1789 | + $this->_display_spco_reg_form(); |
|
1790 | + } |
|
1791 | + |
|
1792 | + |
|
1793 | + |
|
1794 | + /** |
|
1795 | + * _handle_json_response |
|
1796 | + * |
|
1797 | + * @access protected |
|
1798 | + * @return void |
|
1799 | + */ |
|
1800 | + protected function _handle_json_response() |
|
1801 | + { |
|
1802 | + // if this is an ajax request |
|
1803 | + if (EE_Registry::instance()->REQ->ajax) { |
|
1804 | + // DEBUG LOG |
|
1805 | + //$this->checkout->log( |
|
1806 | + // __CLASS__, __FUNCTION__, __LINE__, |
|
1807 | + // array( |
|
1808 | + // 'json_response_redirect_url' => $this->checkout->json_response->redirect_url(), |
|
1809 | + // 'redirect' => $this->checkout->redirect, |
|
1810 | + // 'continue_reg' => $this->checkout->continue_reg, |
|
1811 | + // ) |
|
1812 | + //); |
|
1813 | + $this->checkout->json_response->set_registration_time_limit( |
|
1814 | + $this->checkout->get_registration_time_limit() |
|
1815 | + ); |
|
1816 | + $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing); |
|
1817 | + // just send the ajax ( |
|
1818 | + $json_response = apply_filters( |
|
1819 | + 'FHEE__EE_Single_Page_Checkout__JSON_response', |
|
1820 | + $this->checkout->json_response |
|
1821 | + ); |
|
1822 | + echo $json_response; |
|
1823 | + exit(); |
|
1824 | + } |
|
1825 | + } |
|
1826 | + |
|
1827 | + |
|
1828 | + |
|
1829 | + /** |
|
1830 | + * _handle_redirects |
|
1831 | + * |
|
1832 | + * @access protected |
|
1833 | + * @return void |
|
1834 | + */ |
|
1835 | + protected function _handle_html_redirects() |
|
1836 | + { |
|
1837 | + // going somewhere ? |
|
1838 | + if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) { |
|
1839 | + // store notices in a transient |
|
1840 | + EE_Error::get_notices(false, true, true); |
|
1841 | + // DEBUG LOG |
|
1842 | + //$this->checkout->log( |
|
1843 | + // __CLASS__, __FUNCTION__, __LINE__, |
|
1844 | + // array( |
|
1845 | + // 'headers_sent' => headers_sent(), |
|
1846 | + // 'redirect_url' => $this->checkout->redirect_url, |
|
1847 | + // 'headers_list' => headers_list(), |
|
1848 | + // ) |
|
1849 | + //); |
|
1850 | + wp_safe_redirect($this->checkout->redirect_url); |
|
1851 | + exit(); |
|
1852 | + } |
|
1853 | + } |
|
1854 | + |
|
1855 | + |
|
1856 | + |
|
1857 | + /** |
|
1858 | + * set_checkout_anchor |
|
1859 | + * |
|
1860 | + * @access public |
|
1861 | + * @return void |
|
1862 | + */ |
|
1863 | + public function set_checkout_anchor() |
|
1864 | + { |
|
1865 | + echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>'; |
|
1866 | + } |
|
1867 | 1867 | |
1868 | 1868 | |
1869 | 1869 |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
3 | - exit('No direct script access allowed'); |
|
3 | + exit('No direct script access allowed'); |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | |
@@ -35,150 +35,150 @@ discard block |
||
35 | 35 | abstract class EE_Form_Section_Validatable extends EE_Form_Section_Base |
36 | 36 | { |
37 | 37 | |
38 | - /** |
|
39 | - * Array of validation errors in this section. Does not contain validation errors in subsections, however. |
|
40 | - * Those are stored individually on each subsection. |
|
41 | - * |
|
42 | - * @var EE_Validation_Error[] |
|
43 | - */ |
|
44 | - protected $_validation_errors = array(); |
|
45 | - |
|
46 | - |
|
47 | - |
|
48 | - /** |
|
49 | - * Errors on this form section. Note: EE_Form_Section_Proper |
|
50 | - * has another function for getting all errors in this form section and subsections |
|
51 | - * called get_validation_errors_accumulated |
|
52 | - * |
|
53 | - * @return EE_Validation_Error[] |
|
54 | - */ |
|
55 | - public function get_validation_errors() |
|
56 | - { |
|
57 | - return $this->_validation_errors; |
|
58 | - } |
|
59 | - |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * returns a comma-separated list of all the validation errors in it. |
|
64 | - * If we want this to be customizable, we may decide to create a strategy for displaying it |
|
65 | - * |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function get_validation_error_string() |
|
69 | - { |
|
70 | - $validation_error_messages = array(); |
|
71 | - if ($this->get_validation_errors()) { |
|
72 | - foreach ($this->get_validation_errors() as $validation_error) { |
|
73 | - if ($validation_error instanceof EE_Validation_Error) { |
|
74 | - $validation_error_messages[] = $validation_error->getMessage(); |
|
75 | - } |
|
76 | - } |
|
77 | - } |
|
78 | - return implode(", ", $validation_error_messages); |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * Performs validation on this form section (and subsections). Should be called after _normalize() |
|
85 | - * |
|
86 | - * @return boolean of whether or not the form section is valid |
|
87 | - */ |
|
88 | - abstract protected function _validate(); |
|
89 | - |
|
90 | - |
|
91 | - |
|
92 | - /** |
|
93 | - * Checks if this field has any validation errors |
|
94 | - * |
|
95 | - * @return boolean |
|
96 | - */ |
|
97 | - public function is_valid() |
|
98 | - { |
|
99 | - if (count($this->_validation_errors)) { |
|
100 | - return false; |
|
101 | - } else { |
|
102 | - return true; |
|
103 | - } |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - |
|
108 | - /** |
|
109 | - * Sanitizes input for this form section |
|
110 | - * |
|
111 | - * @param array $req_data is the full request data like $_POST |
|
112 | - * @return boolean of whether a normalization error occurred |
|
113 | - */ |
|
114 | - abstract protected function _normalize($req_data); |
|
115 | - |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * Creates a validation error from the arguments provided, and adds it to the form section's list. |
|
120 | - * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and |
|
121 | - * adds it to the list of validation errors of errors |
|
122 | - * |
|
123 | - * @param mixed $message_or_object internationalized string describing the validation error; or it could be a |
|
124 | - * proper EE_Validation_Error object |
|
125 | - * @param string $error_code a short key which can be used to uniquely identify the error |
|
126 | - * @param Exception $previous_exception if there was an exception that caused the error, that exception |
|
127 | - * @return void |
|
128 | - */ |
|
129 | - public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null) |
|
130 | - { |
|
131 | - if ($message_or_object instanceof EE_Validation_Error) { |
|
132 | - $validation_error = $message_or_object; |
|
133 | - $validation_error->set_form_section($this); |
|
134 | - } else { |
|
135 | - $validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception); |
|
136 | - } |
|
137 | - $this->_validation_errors[] = $validation_error; |
|
138 | - } |
|
139 | - |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * When generating the JS for the jquery validation rules like<br> |
|
144 | - * <code>$( "#myform" ).validate({ |
|
145 | - * rules: { |
|
146 | - * password: "required", |
|
147 | - * password_again: { |
|
148 | - * equalTo: "#password" |
|
149 | - * } |
|
150 | - * } |
|
151 | - * });</code> |
|
152 | - * gets the sections like |
|
153 | - * <br><code>password: "required", |
|
154 | - * password_again: { |
|
155 | - * equalTo: "#password" |
|
156 | - * }</code> |
|
157 | - * except we leave it as a PHP object, and leave wp_localize_script to |
|
158 | - * turn it into a JSON object which can be used by the js |
|
159 | - * |
|
160 | - * @return array |
|
161 | - */ |
|
162 | - abstract public function get_jquery_validation_rules(); |
|
163 | - |
|
164 | - |
|
165 | - |
|
166 | - /** |
|
167 | - * Checks if this form section's data is present in the req data specified |
|
168 | - * |
|
169 | - * @param array $req_data usually $_POST, if null that's what's used |
|
170 | - * @return boolean |
|
171 | - */ |
|
172 | - abstract public function form_data_present_in($req_data = null); |
|
173 | - |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * Removes teh sensitive data from this form section (usually done after |
|
178 | - * utilizing the data business function, but before saving it somewhere. Eg, |
|
179 | - * may remove a password from the form after verifying it was correct) |
|
180 | - * |
|
181 | - * @return void |
|
182 | - */ |
|
183 | - abstract public function clean_sensitive_data(); |
|
38 | + /** |
|
39 | + * Array of validation errors in this section. Does not contain validation errors in subsections, however. |
|
40 | + * Those are stored individually on each subsection. |
|
41 | + * |
|
42 | + * @var EE_Validation_Error[] |
|
43 | + */ |
|
44 | + protected $_validation_errors = array(); |
|
45 | + |
|
46 | + |
|
47 | + |
|
48 | + /** |
|
49 | + * Errors on this form section. Note: EE_Form_Section_Proper |
|
50 | + * has another function for getting all errors in this form section and subsections |
|
51 | + * called get_validation_errors_accumulated |
|
52 | + * |
|
53 | + * @return EE_Validation_Error[] |
|
54 | + */ |
|
55 | + public function get_validation_errors() |
|
56 | + { |
|
57 | + return $this->_validation_errors; |
|
58 | + } |
|
59 | + |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * returns a comma-separated list of all the validation errors in it. |
|
64 | + * If we want this to be customizable, we may decide to create a strategy for displaying it |
|
65 | + * |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function get_validation_error_string() |
|
69 | + { |
|
70 | + $validation_error_messages = array(); |
|
71 | + if ($this->get_validation_errors()) { |
|
72 | + foreach ($this->get_validation_errors() as $validation_error) { |
|
73 | + if ($validation_error instanceof EE_Validation_Error) { |
|
74 | + $validation_error_messages[] = $validation_error->getMessage(); |
|
75 | + } |
|
76 | + } |
|
77 | + } |
|
78 | + return implode(", ", $validation_error_messages); |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * Performs validation on this form section (and subsections). Should be called after _normalize() |
|
85 | + * |
|
86 | + * @return boolean of whether or not the form section is valid |
|
87 | + */ |
|
88 | + abstract protected function _validate(); |
|
89 | + |
|
90 | + |
|
91 | + |
|
92 | + /** |
|
93 | + * Checks if this field has any validation errors |
|
94 | + * |
|
95 | + * @return boolean |
|
96 | + */ |
|
97 | + public function is_valid() |
|
98 | + { |
|
99 | + if (count($this->_validation_errors)) { |
|
100 | + return false; |
|
101 | + } else { |
|
102 | + return true; |
|
103 | + } |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + |
|
108 | + /** |
|
109 | + * Sanitizes input for this form section |
|
110 | + * |
|
111 | + * @param array $req_data is the full request data like $_POST |
|
112 | + * @return boolean of whether a normalization error occurred |
|
113 | + */ |
|
114 | + abstract protected function _normalize($req_data); |
|
115 | + |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * Creates a validation error from the arguments provided, and adds it to the form section's list. |
|
120 | + * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and |
|
121 | + * adds it to the list of validation errors of errors |
|
122 | + * |
|
123 | + * @param mixed $message_or_object internationalized string describing the validation error; or it could be a |
|
124 | + * proper EE_Validation_Error object |
|
125 | + * @param string $error_code a short key which can be used to uniquely identify the error |
|
126 | + * @param Exception $previous_exception if there was an exception that caused the error, that exception |
|
127 | + * @return void |
|
128 | + */ |
|
129 | + public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null) |
|
130 | + { |
|
131 | + if ($message_or_object instanceof EE_Validation_Error) { |
|
132 | + $validation_error = $message_or_object; |
|
133 | + $validation_error->set_form_section($this); |
|
134 | + } else { |
|
135 | + $validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception); |
|
136 | + } |
|
137 | + $this->_validation_errors[] = $validation_error; |
|
138 | + } |
|
139 | + |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * When generating the JS for the jquery validation rules like<br> |
|
144 | + * <code>$( "#myform" ).validate({ |
|
145 | + * rules: { |
|
146 | + * password: "required", |
|
147 | + * password_again: { |
|
148 | + * equalTo: "#password" |
|
149 | + * } |
|
150 | + * } |
|
151 | + * });</code> |
|
152 | + * gets the sections like |
|
153 | + * <br><code>password: "required", |
|
154 | + * password_again: { |
|
155 | + * equalTo: "#password" |
|
156 | + * }</code> |
|
157 | + * except we leave it as a PHP object, and leave wp_localize_script to |
|
158 | + * turn it into a JSON object which can be used by the js |
|
159 | + * |
|
160 | + * @return array |
|
161 | + */ |
|
162 | + abstract public function get_jquery_validation_rules(); |
|
163 | + |
|
164 | + |
|
165 | + |
|
166 | + /** |
|
167 | + * Checks if this form section's data is present in the req data specified |
|
168 | + * |
|
169 | + * @param array $req_data usually $_POST, if null that's what's used |
|
170 | + * @return boolean |
|
171 | + */ |
|
172 | + abstract public function form_data_present_in($req_data = null); |
|
173 | + |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * Removes teh sensitive data from this form section (usually done after |
|
178 | + * utilizing the data business function, but before saving it somewhere. Eg, |
|
179 | + * may remove a password from the form after verifying it was correct) |
|
180 | + * |
|
181 | + * @return void |
|
182 | + */ |
|
183 | + abstract public function clean_sensitive_data(); |
|
184 | 184 | } |
185 | 185 | \ No newline at end of file |