@@ -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 | |
@@ -27,838 +27,838 @@ discard block |
||
27 | 27 | class Payments_Admin_Page extends EE_Admin_Page |
28 | 28 | { |
29 | 29 | |
30 | - /** |
|
31 | - * Variables used for when we're re-sorting the logs results, in case |
|
32 | - * we needed to do two queries and we need to resort |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - private $_sort_logs_again_direction; |
|
37 | - |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @Constructor |
|
42 | - * @access public |
|
43 | - * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object. |
|
44 | - * @return \Payments_Admin_Page |
|
45 | - */ |
|
46 | - public function __construct($routing = true) |
|
47 | - { |
|
48 | - parent::__construct($routing); |
|
49 | - } |
|
50 | - |
|
51 | - |
|
52 | - |
|
53 | - protected function _init_page_props() |
|
54 | - { |
|
55 | - $this->page_slug = EE_PAYMENTS_PG_SLUG; |
|
56 | - $this->page_label = __('Payment Methods', 'event_espresso'); |
|
57 | - $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL; |
|
58 | - $this->_admin_base_path = EE_PAYMENTS_ADMIN; |
|
59 | - } |
|
60 | - |
|
61 | - |
|
62 | - |
|
63 | - protected function _ajax_hooks() |
|
64 | - { |
|
65 | - //todo: all hooks for ajax goes here. |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - |
|
70 | - protected function _define_page_props() |
|
71 | - { |
|
72 | - $this->_admin_page_title = $this->page_label; |
|
73 | - $this->_labels = array( |
|
74 | - 'publishbox' => __('Update Settings', 'event_espresso'), |
|
75 | - ); |
|
76 | - } |
|
77 | - |
|
78 | - |
|
79 | - |
|
80 | - protected function _set_page_routes() |
|
81 | - { |
|
82 | - /** |
|
83 | - * note that with payment method capabilities, although we've implemented |
|
84 | - * capability mapping which will be used for accessing payment methods owned by |
|
85 | - * other users. This is not fully implemented yet in the payment method ui. |
|
86 | - * Currently only the "plural" caps are in active use. |
|
87 | - * When cap mapping is implemented, some routes will need to use the singular form of |
|
88 | - * capability method and also include the $id of the payment method for the route. |
|
89 | - **/ |
|
90 | - $this->_page_routes = array( |
|
91 | - 'default' => array( |
|
92 | - 'func' => '_payment_methods_list', |
|
93 | - 'capability' => 'ee_edit_payment_methods', |
|
94 | - ), |
|
95 | - 'payment_settings' => array( |
|
96 | - 'func' => '_payment_settings', |
|
97 | - 'capability' => 'ee_manage_gateways', |
|
98 | - ), |
|
99 | - 'activate_payment_method' => array( |
|
100 | - 'func' => '_activate_payment_method', |
|
101 | - 'noheader' => true, |
|
102 | - 'capability' => 'ee_edit_payment_methods', |
|
103 | - ), |
|
104 | - 'deactivate_payment_method' => array( |
|
105 | - 'func' => '_deactivate_payment_method', |
|
106 | - 'noheader' => true, |
|
107 | - 'capability' => 'ee_delete_payment_methods', |
|
108 | - ), |
|
109 | - 'update_payment_method' => array( |
|
110 | - 'func' => '_update_payment_method', |
|
111 | - 'noheader' => true, |
|
112 | - 'headers_sent_route' => 'default', |
|
113 | - 'capability' => 'ee_edit_payment_methods', |
|
114 | - ), |
|
115 | - 'update_payment_settings' => array( |
|
116 | - 'func' => '_update_payment_settings', |
|
117 | - 'noheader' => true, |
|
118 | - 'capability' => 'ee_manage_gateways', |
|
119 | - ), |
|
120 | - 'payment_log' => array( |
|
121 | - 'func' => '_payment_log_overview_list_table', |
|
122 | - 'capability' => 'ee_read_payment_methods', |
|
123 | - ), |
|
124 | - 'payment_log_details' => array( |
|
125 | - 'func' => '_payment_log_details', |
|
126 | - 'capability' => 'ee_read_payment_methods', |
|
127 | - ), |
|
128 | - ); |
|
129 | - } |
|
130 | - |
|
131 | - |
|
132 | - |
|
133 | - protected function _set_page_config() |
|
134 | - { |
|
135 | - $payment_method_list_config = array( |
|
136 | - 'nav' => array( |
|
137 | - 'label' => __('Payment Methods', 'event_espresso'), |
|
138 | - 'order' => 10, |
|
139 | - ), |
|
140 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
141 | - 'help_tabs' => array_merge( |
|
142 | - array( |
|
143 | - 'payment_methods_overview_help_tab' => array( |
|
144 | - 'title' => __('Payment Methods Overview', 'event_espresso'), |
|
145 | - 'filename' => 'payment_methods_overview', |
|
146 | - ), |
|
147 | - ), |
|
148 | - $this->_add_payment_method_help_tabs()), |
|
149 | - 'help_tour' => array('Payment_Methods_Selection_Help_Tour'), |
|
150 | - 'require_nonce' => false, |
|
151 | - ); |
|
152 | - $this->_page_config = array( |
|
153 | - 'default' => $payment_method_list_config, |
|
154 | - 'payment_settings' => array( |
|
155 | - 'nav' => array( |
|
156 | - 'label' => __('Settings', 'event_espresso'), |
|
157 | - 'order' => 20, |
|
158 | - ), |
|
159 | - 'help_tabs' => array( |
|
160 | - 'payment_methods_settings_help_tab' => array( |
|
161 | - 'title' => __('Payment Method Settings', 'event_espresso'), |
|
162 | - 'filename' => 'payment_methods_settings', |
|
163 | - ), |
|
164 | - ), |
|
165 | - //'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ), |
|
166 | - 'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')), |
|
167 | - 'require_nonce' => false, |
|
168 | - ), |
|
169 | - 'payment_log' => array( |
|
170 | - 'nav' => array( |
|
171 | - 'label' => __("Logs", 'event_espresso'), |
|
172 | - 'order' => 30, |
|
173 | - ), |
|
174 | - 'list_table' => 'Payment_Log_Admin_List_Table', |
|
175 | - 'metaboxes' => $this->_default_espresso_metaboxes, |
|
176 | - 'require_nonce' => false, |
|
177 | - ), |
|
178 | - ); |
|
179 | - } |
|
180 | - |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * @return array |
|
185 | - */ |
|
186 | - protected function _add_payment_method_help_tabs() |
|
187 | - { |
|
188 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
189 | - $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types(); |
|
190 | - $all_pmt_help_tabs_config = array(); |
|
191 | - foreach ($payment_method_types as $payment_method_type) { |
|
192 | - if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(), |
|
193 | - 'specific_payment_method_type_access') |
|
194 | - ) { |
|
195 | - continue; |
|
196 | - } |
|
197 | - foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) { |
|
198 | - $template_args = isset($config['template_args']) ? $config['template_args'] : array(); |
|
199 | - $template_args['admin_page_obj'] = $this; |
|
200 | - $all_pmt_help_tabs_config[$help_tab_name] = array( |
|
201 | - 'title' => $config['title'], |
|
202 | - 'content' => EEH_Template::display_template( |
|
203 | - $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php', |
|
204 | - $template_args, |
|
205 | - true), |
|
206 | - ); |
|
207 | - } |
|
208 | - } |
|
209 | - return $all_pmt_help_tabs_config; |
|
210 | - } |
|
211 | - |
|
212 | - |
|
213 | - |
|
214 | - //none of the below group are currently used for Gateway Settings |
|
215 | - protected function _add_screen_options() |
|
216 | - { |
|
217 | - } |
|
218 | - |
|
219 | - |
|
220 | - |
|
221 | - protected function _add_feature_pointers() |
|
222 | - { |
|
223 | - } |
|
224 | - |
|
225 | - |
|
226 | - |
|
227 | - public function admin_init() |
|
228 | - { |
|
229 | - } |
|
230 | - |
|
231 | - |
|
232 | - |
|
233 | - public function admin_notices() |
|
234 | - { |
|
235 | - } |
|
236 | - |
|
237 | - |
|
238 | - |
|
239 | - public function admin_footer_scripts() |
|
240 | - { |
|
241 | - } |
|
242 | - |
|
243 | - |
|
244 | - |
|
245 | - public function load_scripts_styles() |
|
246 | - { |
|
247 | - wp_enqueue_script('ee_admin_js'); |
|
248 | - wp_enqueue_script('ee-text-links'); |
|
249 | - wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js', |
|
250 | - array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true); |
|
251 | - } |
|
252 | - |
|
253 | - |
|
254 | - |
|
255 | - public function load_scripts_styles_default() |
|
256 | - { |
|
257 | - //styles |
|
258 | - wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(), |
|
259 | - EVENT_ESPRESSO_VERSION); |
|
260 | - wp_enqueue_style('espresso_payments'); |
|
261 | - wp_enqueue_style('ee-text-links'); |
|
262 | - //scripts |
|
263 | - } |
|
264 | - |
|
265 | - |
|
266 | - |
|
267 | - protected function _payment_methods_list() |
|
268 | - { |
|
269 | - /** |
|
270 | - * first let's ensure payment methods have been setup. We do this here because when people activate a |
|
271 | - * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due |
|
272 | - * to the loading process. However, people MUST setup the details for the payment method so its safe to do a |
|
273 | - * recheck here. |
|
274 | - */ |
|
275 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
276 | - EEM_Payment_Method::instance()->verify_button_urls(); |
|
277 | - //setup tabs, one for each payment method type |
|
278 | - $tabs = array(); |
|
279 | - $payment_methods = array(); |
|
280 | - foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) { |
|
281 | - // we don't want to show admin-only PMTs for now |
|
282 | - if ($pmt_obj instanceof EE_PMT_Admin_Only) { |
|
283 | - continue; |
|
284 | - } |
|
285 | - //check access |
|
286 | - if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(), |
|
287 | - 'specific_payment_method_type_access') |
|
288 | - ) { |
|
289 | - continue; |
|
290 | - } |
|
291 | - //check for any active pms of that type |
|
292 | - $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name()); |
|
293 | - if (! $payment_method instanceof EE_Payment_Method) { |
|
294 | - $payment_method = EE_Payment_Method::new_instance( |
|
295 | - array( |
|
296 | - 'PMD_slug' => sanitize_key($pmt_obj->system_name()), |
|
297 | - 'PMD_type' => $pmt_obj->system_name(), |
|
298 | - 'PMD_name' => $pmt_obj->pretty_name(), |
|
299 | - 'PMD_admin_name' => $pmt_obj->pretty_name(), |
|
300 | - ) |
|
301 | - ); |
|
302 | - } |
|
303 | - $payment_methods[$payment_method->slug()] = $payment_method; |
|
304 | - } |
|
305 | - $payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods', |
|
306 | - $payment_methods); |
|
307 | - foreach ($payment_methods as $payment_method) { |
|
308 | - if ($payment_method instanceof EE_Payment_Method) { |
|
309 | - add_meta_box( |
|
310 | - //html id |
|
311 | - 'espresso_' . $payment_method->slug() . '_payment_settings', |
|
312 | - //title |
|
313 | - sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()), |
|
314 | - //callback |
|
315 | - array($this, 'payment_method_settings_meta_box'), |
|
316 | - //post type |
|
317 | - null, |
|
318 | - //context |
|
319 | - 'normal', |
|
320 | - //priority |
|
321 | - 'default', |
|
322 | - //callback args |
|
323 | - array('payment_method' => $payment_method) |
|
324 | - ); |
|
325 | - //setup for tabbed content |
|
326 | - $tabs[$payment_method->slug()] = array( |
|
327 | - 'label' => $payment_method->admin_name(), |
|
328 | - 'class' => $payment_method->active() ? 'gateway-active' : '', |
|
329 | - 'href' => 'espresso_' . $payment_method->slug() . '_payment_settings', |
|
330 | - 'title' => __('Modify this Payment Method', 'event_espresso'), |
|
331 | - 'slug' => $payment_method->slug(), |
|
332 | - ); |
|
333 | - } |
|
334 | - } |
|
335 | - $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links', |
|
336 | - '|', $this->_get_active_payment_method_slug()); |
|
337 | - $this->display_admin_page_with_sidebar(); |
|
338 | - } |
|
339 | - |
|
340 | - |
|
341 | - |
|
342 | - /** |
|
343 | - * _get_active_payment_method_slug |
|
344 | - * |
|
345 | - * @return string |
|
346 | - */ |
|
347 | - protected function _get_active_payment_method_slug() |
|
348 | - { |
|
349 | - $payment_method_slug = false; |
|
350 | - //decide which payment method tab to open first, as dictated by the request's 'payment_method' |
|
351 | - if (isset($this->_req_data['payment_method'])) { |
|
352 | - // if they provided the current payment method, use it |
|
353 | - $payment_method_slug = sanitize_key($this->_req_data['payment_method']); |
|
354 | - } |
|
355 | - $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug))); |
|
356 | - // if that didn't work or wasn't provided, find another way to select the current pm |
|
357 | - if (! $this->_verify_payment_method($payment_method)) { |
|
358 | - // like, looking for an active one |
|
359 | - $payment_method = EEM_Payment_Method::instance()->get_one_active('CART'); |
|
360 | - // test that one as well |
|
361 | - if ($this->_verify_payment_method($payment_method)) { |
|
362 | - $payment_method_slug = $payment_method->slug(); |
|
363 | - } else { |
|
364 | - $payment_method_slug = 'paypal_standard'; |
|
365 | - } |
|
366 | - } |
|
367 | - return $payment_method_slug; |
|
368 | - } |
|
369 | - |
|
370 | - |
|
371 | - |
|
372 | - /** |
|
373 | - * payment_method_settings_meta_box |
|
374 | - * returns TRUE if the passed payment method is properly constructed and the logged in user has the correct |
|
375 | - * capabilities to access it |
|
376 | - * |
|
377 | - * @param \EE_Payment_Method $payment_method |
|
378 | - * @return boolean |
|
379 | - */ |
|
380 | - protected function _verify_payment_method($payment_method) |
|
381 | - { |
|
382 | - if ( |
|
383 | - $payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base |
|
384 | - && EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(), |
|
385 | - 'specific_payment_method_type_access') |
|
386 | - ) { |
|
387 | - return true; |
|
388 | - } |
|
389 | - return false; |
|
390 | - } |
|
391 | - |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * payment_method_settings_meta_box |
|
396 | - * |
|
397 | - * @param NULL $post_obj_which_is_null is an object containing the current post (as a $post object) |
|
398 | - * @param array $metabox is an array with metabox id, title, callback, and args elements. the value |
|
399 | - * at 'args' has key 'payment_method', as set within _payment_methods_list |
|
400 | - * @return string |
|
401 | - * @throws EE_Error |
|
402 | - */ |
|
403 | - public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox) |
|
404 | - { |
|
405 | - $payment_method = isset($metabox['args'], $metabox['args']['payment_method']) |
|
406 | - ? $metabox['args']['payment_method'] : null; |
|
407 | - if (! $payment_method instanceof EE_Payment_Method) { |
|
408 | - throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied', |
|
409 | - 'event_espresso'))); |
|
410 | - } |
|
411 | - $payment_method_scopes = $payment_method->active(); |
|
412 | - // if the payment method really exists show its form, otherwise the activation template |
|
413 | - if ($payment_method->ID() && ! empty($payment_method_scopes)) { |
|
414 | - $form = $this->_generate_payment_method_settings_form($payment_method); |
|
415 | - if ($form->form_data_present_in($this->_req_data)) { |
|
416 | - $form->receive_form_submission($this->_req_data); |
|
417 | - } |
|
418 | - echo $form->form_open() . $form->get_html_and_js() . $form->form_close(); |
|
419 | - } else { |
|
420 | - echo $this->_activate_payment_method_button($payment_method)->get_html_and_js(); |
|
421 | - } |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - |
|
426 | - /** |
|
427 | - * Gets the form for all the settings related to this payment method type |
|
428 | - * |
|
429 | - * @access protected |
|
430 | - * @param \EE_Payment_Method $payment_method |
|
431 | - * @return \EE_Form_Section_Proper |
|
432 | - */ |
|
433 | - protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method) |
|
434 | - { |
|
435 | - if (! $payment_method instanceof EE_Payment_Method) { |
|
436 | - return new EE_Form_Section_Proper(); |
|
437 | - } |
|
438 | - return new EE_Form_Section_Proper( |
|
439 | - array( |
|
440 | - 'name' => $payment_method->slug() . '_settings_form', |
|
441 | - 'html_id' => $payment_method->slug() . '_settings_form', |
|
442 | - 'action' => EE_Admin_Page::add_query_args_and_nonce( |
|
443 | - array( |
|
444 | - 'action' => 'update_payment_method', |
|
445 | - 'payment_method' => $payment_method->slug(), |
|
446 | - ), |
|
447 | - EE_PAYMENTS_ADMIN_URL |
|
448 | - ), |
|
449 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
450 | - 'subsections' => apply_filters( |
|
451 | - 'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections', |
|
452 | - array( |
|
453 | - 'pci_dss_compliance' => $this->_pci_dss_compliance($payment_method), |
|
454 | - 'currency_support' => $this->_currency_support($payment_method), |
|
455 | - 'payment_method_settings' => $this->_payment_method_settings($payment_method), |
|
456 | - 'update' => $this->_update_payment_method_button($payment_method), |
|
457 | - 'deactivate' => $this->_deactivate_payment_method_button($payment_method), |
|
458 | - 'fine_print' => $this->_fine_print(), |
|
459 | - ), |
|
460 | - $payment_method |
|
461 | - ), |
|
462 | - ) |
|
463 | - ); |
|
464 | - } |
|
465 | - |
|
466 | - |
|
467 | - |
|
468 | - /** |
|
469 | - * _pci_dss_compliance |
|
470 | - * |
|
471 | - * @access protected |
|
472 | - * @param \EE_Payment_Method $payment_method |
|
473 | - * @return \EE_Form_Section_Proper |
|
474 | - */ |
|
475 | - protected function _pci_dss_compliance(EE_Payment_Method $payment_method) |
|
476 | - { |
|
477 | - if ($payment_method->type_obj()->requires_https()) { |
|
478 | - return new EE_Form_Section_HTML( |
|
479 | - EEH_HTML::tr( |
|
480 | - EEH_HTML::th( |
|
481 | - EEH_HTML::label( |
|
482 | - EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice') |
|
483 | - ) |
|
484 | - ) . |
|
485 | - EEH_HTML::td( |
|
486 | - EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.', |
|
487 | - 'event_espresso')) |
|
488 | - . |
|
489 | - EEH_HTML::br() |
|
490 | - . |
|
491 | - __('Learn more about ', 'event_espresso') |
|
492 | - . EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php', |
|
493 | - __('PCI DSS compliance', 'event_espresso')) |
|
494 | - ) |
|
495 | - ) |
|
496 | - ); |
|
497 | - } else { |
|
498 | - return new EE_Form_Section_HTML(''); |
|
499 | - } |
|
500 | - } |
|
501 | - |
|
502 | - |
|
503 | - |
|
504 | - /** |
|
505 | - * _currency_support |
|
506 | - * |
|
507 | - * @access protected |
|
508 | - * @param \EE_Payment_Method $payment_method |
|
509 | - * @return \EE_Form_Section_Proper |
|
510 | - */ |
|
511 | - protected function _currency_support(EE_Payment_Method $payment_method) |
|
512 | - { |
|
513 | - if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) { |
|
514 | - return new EE_Form_Section_HTML( |
|
515 | - EEH_HTML::tr( |
|
516 | - EEH_HTML::th( |
|
517 | - EEH_HTML::label( |
|
518 | - EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice') |
|
519 | - ) |
|
520 | - ) . |
|
521 | - EEH_HTML::td( |
|
522 | - EEH_HTML::strong( |
|
523 | - sprintf( |
|
524 | - __('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.', |
|
525 | - 'event_espresso'), |
|
526 | - EE_Config::instance()->currency->code |
|
527 | - ) |
|
528 | - ) |
|
529 | - ) |
|
530 | - ) |
|
531 | - ); |
|
532 | - } else { |
|
533 | - return new EE_Form_Section_HTML(''); |
|
534 | - } |
|
535 | - } |
|
536 | - |
|
537 | - |
|
538 | - |
|
539 | - /** |
|
540 | - * _update_payment_method_button |
|
541 | - * |
|
542 | - * @access protected |
|
543 | - * @param \EE_Payment_Method $payment_method |
|
544 | - * @return \EE_Form_Section_HTML |
|
545 | - */ |
|
546 | - protected function _payment_method_settings(EE_Payment_Method $payment_method) |
|
547 | - { |
|
548 | - //modify the form so we only have/show fields that will be implemented for this version |
|
549 | - return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name()); |
|
550 | - } |
|
551 | - |
|
552 | - |
|
553 | - |
|
554 | - /** |
|
555 | - * Simplifies the form to merely reproduce 4.1's gateway settings functionality |
|
556 | - * |
|
557 | - * @param EE_Form_Section_Proper $form_section |
|
558 | - * @param string $payment_method_name |
|
559 | - * @return \EE_Payment_Method_Form |
|
560 | - * @throws \EE_Error |
|
561 | - */ |
|
562 | - protected function _simplify_form($form_section, $payment_method_name = '') |
|
563 | - { |
|
564 | - if ($form_section instanceof EE_Payment_Method_Form) { |
|
565 | - $form_section->exclude( |
|
566 | - array( |
|
567 | - 'PMD_type', //dont want them changing the type |
|
568 | - 'PMD_slug', //or the slug (probably never) |
|
569 | - 'PMD_wp_user', //or the user's ID |
|
570 | - 'Currency' //or the currency, until the rest of EE supports simultaneous currencies |
|
571 | - ) |
|
572 | - ); |
|
573 | - return $form_section; |
|
574 | - } else { |
|
575 | - throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.', |
|
576 | - 'event_espresso'), $payment_method_name)); |
|
577 | - } |
|
578 | - } |
|
579 | - |
|
580 | - |
|
581 | - |
|
582 | - /** |
|
583 | - * _update_payment_method_button |
|
584 | - * |
|
585 | - * @access protected |
|
586 | - * @param \EE_Payment_Method $payment_method |
|
587 | - * @return \EE_Form_Section_HTML |
|
588 | - */ |
|
589 | - protected function _update_payment_method_button(EE_Payment_Method $payment_method) |
|
590 | - { |
|
591 | - $update_button = new EE_Submit_Input( |
|
592 | - array( |
|
593 | - 'name' => 'submit', |
|
594 | - 'html_id' => 'save_' . $payment_method->slug() . '_settings', |
|
595 | - 'default' => sprintf(__('Update %s Payment Settings', 'event_espresso'), |
|
596 | - $payment_method->admin_name()), |
|
597 | - 'html_label' => EEH_HTML::nbsp(), |
|
598 | - ) |
|
599 | - ); |
|
600 | - return new EE_Form_Section_HTML( |
|
601 | - EEH_HTML::no_row(EEH_HTML::br(2)) . |
|
602 | - EEH_HTML::tr( |
|
603 | - EEH_HTML::th(__('Update Settings', 'event_espresso')) . |
|
604 | - EEH_HTML::td( |
|
605 | - $update_button->get_html_for_input() |
|
606 | - ) |
|
607 | - ) |
|
608 | - ); |
|
609 | - } |
|
610 | - |
|
611 | - |
|
612 | - |
|
613 | - /** |
|
614 | - * _deactivate_payment_method_button |
|
615 | - * |
|
616 | - * @access protected |
|
617 | - * @param \EE_Payment_Method $payment_method |
|
618 | - * @return \EE_Form_Section_Proper |
|
619 | - */ |
|
620 | - protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method) |
|
621 | - { |
|
622 | - $link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'), |
|
623 | - $payment_method->admin_name()); |
|
624 | - return new EE_Form_Section_HTML( |
|
625 | - EEH_HTML::tr( |
|
626 | - EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) . |
|
627 | - EEH_HTML::td( |
|
628 | - EEH_HTML::link( |
|
629 | - EE_Admin_Page::add_query_args_and_nonce( |
|
630 | - array( |
|
631 | - 'action' => 'deactivate_payment_method', |
|
632 | - 'payment_method' => $payment_method->slug(), |
|
633 | - ), |
|
634 | - EE_PAYMENTS_ADMIN_URL |
|
635 | - ), |
|
636 | - $link_text_and_title, |
|
637 | - $link_text_and_title, |
|
638 | - 'deactivate_' . $payment_method->slug(), |
|
639 | - 'espresso-button button-secondary' |
|
640 | - ) |
|
641 | - ) |
|
642 | - ) |
|
643 | - ); |
|
644 | - } |
|
645 | - |
|
646 | - |
|
647 | - |
|
648 | - /** |
|
649 | - * _activate_payment_method_button |
|
650 | - * |
|
651 | - * @access protected |
|
652 | - * @param \EE_Payment_Method $payment_method |
|
653 | - * @return \EE_Form_Section_Proper |
|
654 | - */ |
|
655 | - protected function _activate_payment_method_button(EE_Payment_Method $payment_method) |
|
656 | - { |
|
657 | - $link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'), |
|
658 | - $payment_method->admin_name()); |
|
659 | - return new EE_Form_Section_Proper( |
|
660 | - array( |
|
661 | - 'name' => 'activate_' . $payment_method->slug() . '_settings_form', |
|
662 | - 'html_id' => 'activate_' . $payment_method->slug() . '_settings_form', |
|
663 | - 'action' => '#', |
|
664 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
665 | - 'subsections' => apply_filters( |
|
666 | - 'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections', |
|
667 | - array( |
|
668 | - new EE_Form_Section_HTML( |
|
669 | - EEH_HTML::tr( |
|
670 | - EEH_HTML::td($payment_method->type_obj()->introductory_html(), |
|
671 | - '', |
|
672 | - '', |
|
673 | - '', |
|
674 | - 'colspan="2"' |
|
675 | - ) |
|
676 | - ) . |
|
677 | - EEH_HTML::tr( |
|
678 | - EEH_HTML::th( |
|
679 | - EEH_HTML::label(__('Click to Activate ', 'event_espresso')) |
|
680 | - ) . |
|
681 | - EEH_HTML::td( |
|
682 | - EEH_HTML::link( |
|
683 | - EE_Admin_Page::add_query_args_and_nonce( |
|
684 | - array( |
|
685 | - 'action' => 'activate_payment_method', |
|
686 | - 'payment_method_type' => $payment_method->type(), |
|
687 | - ), |
|
688 | - EE_PAYMENTS_ADMIN_URL |
|
689 | - ), |
|
690 | - $link_text_and_title, |
|
691 | - $link_text_and_title, |
|
692 | - 'activate_' . $payment_method->slug(), |
|
693 | - 'espresso-button-green button-primary' |
|
694 | - ) |
|
695 | - ) |
|
696 | - ) |
|
697 | - ), |
|
698 | - ), |
|
699 | - $payment_method |
|
700 | - ), |
|
701 | - ) |
|
702 | - ); |
|
703 | - } |
|
704 | - |
|
705 | - |
|
706 | - |
|
707 | - /** |
|
708 | - * _fine_print |
|
709 | - * |
|
710 | - * @access protected |
|
711 | - * @return \EE_Form_Section_HTML |
|
712 | - */ |
|
713 | - protected function _fine_print() |
|
714 | - { |
|
715 | - return new EE_Form_Section_HTML( |
|
716 | - EEH_HTML::tr( |
|
717 | - EEH_HTML::th() . |
|
718 | - EEH_HTML::td( |
|
719 | - EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text') |
|
720 | - ) |
|
721 | - ) |
|
722 | - ); |
|
723 | - } |
|
724 | - |
|
725 | - |
|
726 | - |
|
727 | - /** |
|
728 | - * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far) |
|
729 | - * |
|
730 | - * @global WP_User $current_user |
|
731 | - */ |
|
732 | - protected function _activate_payment_method() |
|
733 | - { |
|
734 | - if (isset($this->_req_data['payment_method_type'])) { |
|
735 | - $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']); |
|
736 | - //see if one exists |
|
737 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
738 | - $payment_method = EE_Payment_Method_Manager::instance() |
|
739 | - ->activate_a_payment_method_of_type($payment_method_type); |
|
740 | - $this->_redirect_after_action(1, 'Payment Method', 'activated', |
|
741 | - array('action' => 'default', 'payment_method' => $payment_method->slug())); |
|
742 | - } else { |
|
743 | - $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default')); |
|
744 | - } |
|
745 | - } |
|
746 | - |
|
747 | - |
|
748 | - |
|
749 | - /** |
|
750 | - * Deactivates the payment method with the specified slug, and redirects. |
|
751 | - */ |
|
752 | - protected function _deactivate_payment_method() |
|
753 | - { |
|
754 | - if (isset($this->_req_data['payment_method'])) { |
|
755 | - $payment_method_slug = sanitize_key($this->_req_data['payment_method']); |
|
756 | - //deactivate it |
|
757 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
758 | - $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug); |
|
759 | - $this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated', |
|
760 | - array('action' => 'default', 'payment_method' => $payment_method_slug)); |
|
761 | - } else { |
|
762 | - $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default')); |
|
763 | - } |
|
764 | - } |
|
765 | - |
|
766 | - |
|
767 | - |
|
768 | - /** |
|
769 | - * Processes the payment method form that was submitted. This is slightly trickier than usual form |
|
770 | - * processing because we first need to identify WHICH form was processed and which payment method |
|
771 | - * it corresponds to. Once we have done that, we see if the form is valid. If it is, the |
|
772 | - * form's data is saved and we redirect to the default payment methods page, setting the updated payment method |
|
773 | - * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the |
|
774 | - * subsequently called 'headers_sent_func' which is _payment_methods_list) |
|
775 | - * |
|
776 | - * @return void |
|
777 | - */ |
|
778 | - protected function _update_payment_method() |
|
779 | - { |
|
780 | - if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
781 | - //ok let's find which gateway form to use based on the form input |
|
782 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
783 | - /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */ |
|
784 | - $correct_pmt_form_to_use = null; |
|
785 | - $payment_method = null; |
|
786 | - foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) { |
|
787 | - //get the form and simplify it, like what we do when we display it |
|
788 | - $pmt_form = $this->_generate_payment_method_settings_form($payment_method); |
|
789 | - if ($pmt_form->form_data_present_in($this->_req_data)) { |
|
790 | - $correct_pmt_form_to_use = $pmt_form; |
|
791 | - break; |
|
792 | - } |
|
793 | - } |
|
794 | - //if we couldn't find the correct payment method type... |
|
795 | - if (! $correct_pmt_form_to_use) { |
|
796 | - EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support", |
|
797 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
798 | - $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default')); |
|
799 | - } |
|
800 | - $correct_pmt_form_to_use->receive_form_submission($this->_req_data); |
|
801 | - if ($correct_pmt_form_to_use->is_valid()) { |
|
802 | - $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings'); |
|
803 | - if (! $payment_settings_subform instanceof EE_Payment_Method_Form) { |
|
804 | - throw new EE_Error( |
|
805 | - sprintf( |
|
806 | - __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.', |
|
807 | - 'event_espresso'), |
|
808 | - 'payment_method_settings' |
|
809 | - ) |
|
810 | - ); |
|
811 | - } |
|
812 | - $payment_settings_subform->save(); |
|
813 | - /** @var $pm EE_Payment_Method */ |
|
814 | - $this->_redirect_after_action(true, 'Payment Method', 'updated', |
|
815 | - array('action' => 'default', 'payment_method' => $payment_method->slug())); |
|
816 | - } else { |
|
817 | - EE_Error::add_error( |
|
818 | - sprintf( |
|
819 | - __('Payment method of type %s was not saved because there were validation errors. They have been marked in the form', |
|
820 | - 'event_espresso'), |
|
821 | - $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name() |
|
822 | - : __('"(unknown)"', 'event_espresso') |
|
823 | - ), |
|
824 | - __FILE__, |
|
825 | - __FUNCTION__, |
|
826 | - __LINE__ |
|
827 | - ); |
|
828 | - } |
|
829 | - } |
|
830 | - return; |
|
831 | - } |
|
832 | - |
|
833 | - |
|
834 | - |
|
835 | - protected function _payment_settings() |
|
836 | - { |
|
837 | - $this->_template_args['values'] = $this->_yes_no_values; |
|
838 | - $this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options) |
|
839 | - ? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false; |
|
840 | - $this->_set_add_edit_form_tags('update_payment_settings'); |
|
841 | - $this->_set_publish_post_box_vars(null, false, false, null, false); |
|
842 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH |
|
843 | - . 'payment_settings.template.php', |
|
844 | - $this->_template_args, true); |
|
845 | - $this->display_admin_page_with_sidebar(); |
|
846 | - } |
|
847 | - |
|
848 | - |
|
849 | - |
|
850 | - /** |
|
851 | - * _update_payment_settings |
|
852 | - * |
|
853 | - * @access protected |
|
854 | - * @return array |
|
855 | - */ |
|
856 | - protected function _update_payment_settings() |
|
857 | - { |
|
858 | - EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options']) |
|
859 | - ? $this->_req_data['show_pending_payment_options'] : false; |
|
860 | - EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG', |
|
861 | - EE_Registry::instance()->CFG); |
|
30 | + /** |
|
31 | + * Variables used for when we're re-sorting the logs results, in case |
|
32 | + * we needed to do two queries and we need to resort |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + private $_sort_logs_again_direction; |
|
37 | + |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @Constructor |
|
42 | + * @access public |
|
43 | + * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object. |
|
44 | + * @return \Payments_Admin_Page |
|
45 | + */ |
|
46 | + public function __construct($routing = true) |
|
47 | + { |
|
48 | + parent::__construct($routing); |
|
49 | + } |
|
50 | + |
|
51 | + |
|
52 | + |
|
53 | + protected function _init_page_props() |
|
54 | + { |
|
55 | + $this->page_slug = EE_PAYMENTS_PG_SLUG; |
|
56 | + $this->page_label = __('Payment Methods', 'event_espresso'); |
|
57 | + $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL; |
|
58 | + $this->_admin_base_path = EE_PAYMENTS_ADMIN; |
|
59 | + } |
|
60 | + |
|
61 | + |
|
62 | + |
|
63 | + protected function _ajax_hooks() |
|
64 | + { |
|
65 | + //todo: all hooks for ajax goes here. |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + |
|
70 | + protected function _define_page_props() |
|
71 | + { |
|
72 | + $this->_admin_page_title = $this->page_label; |
|
73 | + $this->_labels = array( |
|
74 | + 'publishbox' => __('Update Settings', 'event_espresso'), |
|
75 | + ); |
|
76 | + } |
|
77 | + |
|
78 | + |
|
79 | + |
|
80 | + protected function _set_page_routes() |
|
81 | + { |
|
82 | + /** |
|
83 | + * note that with payment method capabilities, although we've implemented |
|
84 | + * capability mapping which will be used for accessing payment methods owned by |
|
85 | + * other users. This is not fully implemented yet in the payment method ui. |
|
86 | + * Currently only the "plural" caps are in active use. |
|
87 | + * When cap mapping is implemented, some routes will need to use the singular form of |
|
88 | + * capability method and also include the $id of the payment method for the route. |
|
89 | + **/ |
|
90 | + $this->_page_routes = array( |
|
91 | + 'default' => array( |
|
92 | + 'func' => '_payment_methods_list', |
|
93 | + 'capability' => 'ee_edit_payment_methods', |
|
94 | + ), |
|
95 | + 'payment_settings' => array( |
|
96 | + 'func' => '_payment_settings', |
|
97 | + 'capability' => 'ee_manage_gateways', |
|
98 | + ), |
|
99 | + 'activate_payment_method' => array( |
|
100 | + 'func' => '_activate_payment_method', |
|
101 | + 'noheader' => true, |
|
102 | + 'capability' => 'ee_edit_payment_methods', |
|
103 | + ), |
|
104 | + 'deactivate_payment_method' => array( |
|
105 | + 'func' => '_deactivate_payment_method', |
|
106 | + 'noheader' => true, |
|
107 | + 'capability' => 'ee_delete_payment_methods', |
|
108 | + ), |
|
109 | + 'update_payment_method' => array( |
|
110 | + 'func' => '_update_payment_method', |
|
111 | + 'noheader' => true, |
|
112 | + 'headers_sent_route' => 'default', |
|
113 | + 'capability' => 'ee_edit_payment_methods', |
|
114 | + ), |
|
115 | + 'update_payment_settings' => array( |
|
116 | + 'func' => '_update_payment_settings', |
|
117 | + 'noheader' => true, |
|
118 | + 'capability' => 'ee_manage_gateways', |
|
119 | + ), |
|
120 | + 'payment_log' => array( |
|
121 | + 'func' => '_payment_log_overview_list_table', |
|
122 | + 'capability' => 'ee_read_payment_methods', |
|
123 | + ), |
|
124 | + 'payment_log_details' => array( |
|
125 | + 'func' => '_payment_log_details', |
|
126 | + 'capability' => 'ee_read_payment_methods', |
|
127 | + ), |
|
128 | + ); |
|
129 | + } |
|
130 | + |
|
131 | + |
|
132 | + |
|
133 | + protected function _set_page_config() |
|
134 | + { |
|
135 | + $payment_method_list_config = array( |
|
136 | + 'nav' => array( |
|
137 | + 'label' => __('Payment Methods', 'event_espresso'), |
|
138 | + 'order' => 10, |
|
139 | + ), |
|
140 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
141 | + 'help_tabs' => array_merge( |
|
142 | + array( |
|
143 | + 'payment_methods_overview_help_tab' => array( |
|
144 | + 'title' => __('Payment Methods Overview', 'event_espresso'), |
|
145 | + 'filename' => 'payment_methods_overview', |
|
146 | + ), |
|
147 | + ), |
|
148 | + $this->_add_payment_method_help_tabs()), |
|
149 | + 'help_tour' => array('Payment_Methods_Selection_Help_Tour'), |
|
150 | + 'require_nonce' => false, |
|
151 | + ); |
|
152 | + $this->_page_config = array( |
|
153 | + 'default' => $payment_method_list_config, |
|
154 | + 'payment_settings' => array( |
|
155 | + 'nav' => array( |
|
156 | + 'label' => __('Settings', 'event_espresso'), |
|
157 | + 'order' => 20, |
|
158 | + ), |
|
159 | + 'help_tabs' => array( |
|
160 | + 'payment_methods_settings_help_tab' => array( |
|
161 | + 'title' => __('Payment Method Settings', 'event_espresso'), |
|
162 | + 'filename' => 'payment_methods_settings', |
|
163 | + ), |
|
164 | + ), |
|
165 | + //'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ), |
|
166 | + 'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')), |
|
167 | + 'require_nonce' => false, |
|
168 | + ), |
|
169 | + 'payment_log' => array( |
|
170 | + 'nav' => array( |
|
171 | + 'label' => __("Logs", 'event_espresso'), |
|
172 | + 'order' => 30, |
|
173 | + ), |
|
174 | + 'list_table' => 'Payment_Log_Admin_List_Table', |
|
175 | + 'metaboxes' => $this->_default_espresso_metaboxes, |
|
176 | + 'require_nonce' => false, |
|
177 | + ), |
|
178 | + ); |
|
179 | + } |
|
180 | + |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * @return array |
|
185 | + */ |
|
186 | + protected function _add_payment_method_help_tabs() |
|
187 | + { |
|
188 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
189 | + $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types(); |
|
190 | + $all_pmt_help_tabs_config = array(); |
|
191 | + foreach ($payment_method_types as $payment_method_type) { |
|
192 | + if (! EE_Registry::instance()->CAP->current_user_can($payment_method_type->cap_name(), |
|
193 | + 'specific_payment_method_type_access') |
|
194 | + ) { |
|
195 | + continue; |
|
196 | + } |
|
197 | + foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) { |
|
198 | + $template_args = isset($config['template_args']) ? $config['template_args'] : array(); |
|
199 | + $template_args['admin_page_obj'] = $this; |
|
200 | + $all_pmt_help_tabs_config[$help_tab_name] = array( |
|
201 | + 'title' => $config['title'], |
|
202 | + 'content' => EEH_Template::display_template( |
|
203 | + $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php', |
|
204 | + $template_args, |
|
205 | + true), |
|
206 | + ); |
|
207 | + } |
|
208 | + } |
|
209 | + return $all_pmt_help_tabs_config; |
|
210 | + } |
|
211 | + |
|
212 | + |
|
213 | + |
|
214 | + //none of the below group are currently used for Gateway Settings |
|
215 | + protected function _add_screen_options() |
|
216 | + { |
|
217 | + } |
|
218 | + |
|
219 | + |
|
220 | + |
|
221 | + protected function _add_feature_pointers() |
|
222 | + { |
|
223 | + } |
|
224 | + |
|
225 | + |
|
226 | + |
|
227 | + public function admin_init() |
|
228 | + { |
|
229 | + } |
|
230 | + |
|
231 | + |
|
232 | + |
|
233 | + public function admin_notices() |
|
234 | + { |
|
235 | + } |
|
236 | + |
|
237 | + |
|
238 | + |
|
239 | + public function admin_footer_scripts() |
|
240 | + { |
|
241 | + } |
|
242 | + |
|
243 | + |
|
244 | + |
|
245 | + public function load_scripts_styles() |
|
246 | + { |
|
247 | + wp_enqueue_script('ee_admin_js'); |
|
248 | + wp_enqueue_script('ee-text-links'); |
|
249 | + wp_enqueue_script('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js', |
|
250 | + array('espresso-ui-theme', 'ee-datepicker'), EVENT_ESPRESSO_VERSION, true); |
|
251 | + } |
|
252 | + |
|
253 | + |
|
254 | + |
|
255 | + public function load_scripts_styles_default() |
|
256 | + { |
|
257 | + //styles |
|
258 | + wp_register_style('espresso_payments', EE_PAYMENTS_ASSETS_URL . 'ee-payments.css', array(), |
|
259 | + EVENT_ESPRESSO_VERSION); |
|
260 | + wp_enqueue_style('espresso_payments'); |
|
261 | + wp_enqueue_style('ee-text-links'); |
|
262 | + //scripts |
|
263 | + } |
|
264 | + |
|
265 | + |
|
266 | + |
|
267 | + protected function _payment_methods_list() |
|
268 | + { |
|
269 | + /** |
|
270 | + * first let's ensure payment methods have been setup. We do this here because when people activate a |
|
271 | + * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due |
|
272 | + * to the loading process. However, people MUST setup the details for the payment method so its safe to do a |
|
273 | + * recheck here. |
|
274 | + */ |
|
275 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
276 | + EEM_Payment_Method::instance()->verify_button_urls(); |
|
277 | + //setup tabs, one for each payment method type |
|
278 | + $tabs = array(); |
|
279 | + $payment_methods = array(); |
|
280 | + foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) { |
|
281 | + // we don't want to show admin-only PMTs for now |
|
282 | + if ($pmt_obj instanceof EE_PMT_Admin_Only) { |
|
283 | + continue; |
|
284 | + } |
|
285 | + //check access |
|
286 | + if (! EE_Registry::instance()->CAP->current_user_can($pmt_obj->cap_name(), |
|
287 | + 'specific_payment_method_type_access') |
|
288 | + ) { |
|
289 | + continue; |
|
290 | + } |
|
291 | + //check for any active pms of that type |
|
292 | + $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name()); |
|
293 | + if (! $payment_method instanceof EE_Payment_Method) { |
|
294 | + $payment_method = EE_Payment_Method::new_instance( |
|
295 | + array( |
|
296 | + 'PMD_slug' => sanitize_key($pmt_obj->system_name()), |
|
297 | + 'PMD_type' => $pmt_obj->system_name(), |
|
298 | + 'PMD_name' => $pmt_obj->pretty_name(), |
|
299 | + 'PMD_admin_name' => $pmt_obj->pretty_name(), |
|
300 | + ) |
|
301 | + ); |
|
302 | + } |
|
303 | + $payment_methods[$payment_method->slug()] = $payment_method; |
|
304 | + } |
|
305 | + $payment_methods = apply_filters('FHEE__Payments_Admin_Page___payment_methods_list__payment_methods', |
|
306 | + $payment_methods); |
|
307 | + foreach ($payment_methods as $payment_method) { |
|
308 | + if ($payment_method instanceof EE_Payment_Method) { |
|
309 | + add_meta_box( |
|
310 | + //html id |
|
311 | + 'espresso_' . $payment_method->slug() . '_payment_settings', |
|
312 | + //title |
|
313 | + sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()), |
|
314 | + //callback |
|
315 | + array($this, 'payment_method_settings_meta_box'), |
|
316 | + //post type |
|
317 | + null, |
|
318 | + //context |
|
319 | + 'normal', |
|
320 | + //priority |
|
321 | + 'default', |
|
322 | + //callback args |
|
323 | + array('payment_method' => $payment_method) |
|
324 | + ); |
|
325 | + //setup for tabbed content |
|
326 | + $tabs[$payment_method->slug()] = array( |
|
327 | + 'label' => $payment_method->admin_name(), |
|
328 | + 'class' => $payment_method->active() ? 'gateway-active' : '', |
|
329 | + 'href' => 'espresso_' . $payment_method->slug() . '_payment_settings', |
|
330 | + 'title' => __('Modify this Payment Method', 'event_espresso'), |
|
331 | + 'slug' => $payment_method->slug(), |
|
332 | + ); |
|
333 | + } |
|
334 | + } |
|
335 | + $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($tabs, 'payment_method_links', |
|
336 | + '|', $this->_get_active_payment_method_slug()); |
|
337 | + $this->display_admin_page_with_sidebar(); |
|
338 | + } |
|
339 | + |
|
340 | + |
|
341 | + |
|
342 | + /** |
|
343 | + * _get_active_payment_method_slug |
|
344 | + * |
|
345 | + * @return string |
|
346 | + */ |
|
347 | + protected function _get_active_payment_method_slug() |
|
348 | + { |
|
349 | + $payment_method_slug = false; |
|
350 | + //decide which payment method tab to open first, as dictated by the request's 'payment_method' |
|
351 | + if (isset($this->_req_data['payment_method'])) { |
|
352 | + // if they provided the current payment method, use it |
|
353 | + $payment_method_slug = sanitize_key($this->_req_data['payment_method']); |
|
354 | + } |
|
355 | + $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug))); |
|
356 | + // if that didn't work or wasn't provided, find another way to select the current pm |
|
357 | + if (! $this->_verify_payment_method($payment_method)) { |
|
358 | + // like, looking for an active one |
|
359 | + $payment_method = EEM_Payment_Method::instance()->get_one_active('CART'); |
|
360 | + // test that one as well |
|
361 | + if ($this->_verify_payment_method($payment_method)) { |
|
362 | + $payment_method_slug = $payment_method->slug(); |
|
363 | + } else { |
|
364 | + $payment_method_slug = 'paypal_standard'; |
|
365 | + } |
|
366 | + } |
|
367 | + return $payment_method_slug; |
|
368 | + } |
|
369 | + |
|
370 | + |
|
371 | + |
|
372 | + /** |
|
373 | + * payment_method_settings_meta_box |
|
374 | + * returns TRUE if the passed payment method is properly constructed and the logged in user has the correct |
|
375 | + * capabilities to access it |
|
376 | + * |
|
377 | + * @param \EE_Payment_Method $payment_method |
|
378 | + * @return boolean |
|
379 | + */ |
|
380 | + protected function _verify_payment_method($payment_method) |
|
381 | + { |
|
382 | + if ( |
|
383 | + $payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base |
|
384 | + && EE_Registry::instance()->CAP->current_user_can($payment_method->type_obj()->cap_name(), |
|
385 | + 'specific_payment_method_type_access') |
|
386 | + ) { |
|
387 | + return true; |
|
388 | + } |
|
389 | + return false; |
|
390 | + } |
|
391 | + |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * payment_method_settings_meta_box |
|
396 | + * |
|
397 | + * @param NULL $post_obj_which_is_null is an object containing the current post (as a $post object) |
|
398 | + * @param array $metabox is an array with metabox id, title, callback, and args elements. the value |
|
399 | + * at 'args' has key 'payment_method', as set within _payment_methods_list |
|
400 | + * @return string |
|
401 | + * @throws EE_Error |
|
402 | + */ |
|
403 | + public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox) |
|
404 | + { |
|
405 | + $payment_method = isset($metabox['args'], $metabox['args']['payment_method']) |
|
406 | + ? $metabox['args']['payment_method'] : null; |
|
407 | + if (! $payment_method instanceof EE_Payment_Method) { |
|
408 | + throw new EE_Error(sprintf(__('Payment method metabox setup incorrectly. No Payment method object was supplied', |
|
409 | + 'event_espresso'))); |
|
410 | + } |
|
411 | + $payment_method_scopes = $payment_method->active(); |
|
412 | + // if the payment method really exists show its form, otherwise the activation template |
|
413 | + if ($payment_method->ID() && ! empty($payment_method_scopes)) { |
|
414 | + $form = $this->_generate_payment_method_settings_form($payment_method); |
|
415 | + if ($form->form_data_present_in($this->_req_data)) { |
|
416 | + $form->receive_form_submission($this->_req_data); |
|
417 | + } |
|
418 | + echo $form->form_open() . $form->get_html_and_js() . $form->form_close(); |
|
419 | + } else { |
|
420 | + echo $this->_activate_payment_method_button($payment_method)->get_html_and_js(); |
|
421 | + } |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + |
|
426 | + /** |
|
427 | + * Gets the form for all the settings related to this payment method type |
|
428 | + * |
|
429 | + * @access protected |
|
430 | + * @param \EE_Payment_Method $payment_method |
|
431 | + * @return \EE_Form_Section_Proper |
|
432 | + */ |
|
433 | + protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method) |
|
434 | + { |
|
435 | + if (! $payment_method instanceof EE_Payment_Method) { |
|
436 | + return new EE_Form_Section_Proper(); |
|
437 | + } |
|
438 | + return new EE_Form_Section_Proper( |
|
439 | + array( |
|
440 | + 'name' => $payment_method->slug() . '_settings_form', |
|
441 | + 'html_id' => $payment_method->slug() . '_settings_form', |
|
442 | + 'action' => EE_Admin_Page::add_query_args_and_nonce( |
|
443 | + array( |
|
444 | + 'action' => 'update_payment_method', |
|
445 | + 'payment_method' => $payment_method->slug(), |
|
446 | + ), |
|
447 | + EE_PAYMENTS_ADMIN_URL |
|
448 | + ), |
|
449 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
450 | + 'subsections' => apply_filters( |
|
451 | + 'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections', |
|
452 | + array( |
|
453 | + 'pci_dss_compliance' => $this->_pci_dss_compliance($payment_method), |
|
454 | + 'currency_support' => $this->_currency_support($payment_method), |
|
455 | + 'payment_method_settings' => $this->_payment_method_settings($payment_method), |
|
456 | + 'update' => $this->_update_payment_method_button($payment_method), |
|
457 | + 'deactivate' => $this->_deactivate_payment_method_button($payment_method), |
|
458 | + 'fine_print' => $this->_fine_print(), |
|
459 | + ), |
|
460 | + $payment_method |
|
461 | + ), |
|
462 | + ) |
|
463 | + ); |
|
464 | + } |
|
465 | + |
|
466 | + |
|
467 | + |
|
468 | + /** |
|
469 | + * _pci_dss_compliance |
|
470 | + * |
|
471 | + * @access protected |
|
472 | + * @param \EE_Payment_Method $payment_method |
|
473 | + * @return \EE_Form_Section_Proper |
|
474 | + */ |
|
475 | + protected function _pci_dss_compliance(EE_Payment_Method $payment_method) |
|
476 | + { |
|
477 | + if ($payment_method->type_obj()->requires_https()) { |
|
478 | + return new EE_Form_Section_HTML( |
|
479 | + EEH_HTML::tr( |
|
480 | + EEH_HTML::th( |
|
481 | + EEH_HTML::label( |
|
482 | + EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice') |
|
483 | + ) |
|
484 | + ) . |
|
485 | + EEH_HTML::td( |
|
486 | + EEH_HTML::strong(__('You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.', |
|
487 | + 'event_espresso')) |
|
488 | + . |
|
489 | + EEH_HTML::br() |
|
490 | + . |
|
491 | + __('Learn more about ', 'event_espresso') |
|
492 | + . EEH_HTML::link('https://www.pcisecuritystandards.org/merchants/index.php', |
|
493 | + __('PCI DSS compliance', 'event_espresso')) |
|
494 | + ) |
|
495 | + ) |
|
496 | + ); |
|
497 | + } else { |
|
498 | + return new EE_Form_Section_HTML(''); |
|
499 | + } |
|
500 | + } |
|
501 | + |
|
502 | + |
|
503 | + |
|
504 | + /** |
|
505 | + * _currency_support |
|
506 | + * |
|
507 | + * @access protected |
|
508 | + * @param \EE_Payment_Method $payment_method |
|
509 | + * @return \EE_Form_Section_Proper |
|
510 | + */ |
|
511 | + protected function _currency_support(EE_Payment_Method $payment_method) |
|
512 | + { |
|
513 | + if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) { |
|
514 | + return new EE_Form_Section_HTML( |
|
515 | + EEH_HTML::tr( |
|
516 | + EEH_HTML::th( |
|
517 | + EEH_HTML::label( |
|
518 | + EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice') |
|
519 | + ) |
|
520 | + ) . |
|
521 | + EEH_HTML::td( |
|
522 | + EEH_HTML::strong( |
|
523 | + sprintf( |
|
524 | + __('This payment method does not support the currency set on your site (%1$s). Please activate a different payment method or change your site\'s country and associated currency.', |
|
525 | + 'event_espresso'), |
|
526 | + EE_Config::instance()->currency->code |
|
527 | + ) |
|
528 | + ) |
|
529 | + ) |
|
530 | + ) |
|
531 | + ); |
|
532 | + } else { |
|
533 | + return new EE_Form_Section_HTML(''); |
|
534 | + } |
|
535 | + } |
|
536 | + |
|
537 | + |
|
538 | + |
|
539 | + /** |
|
540 | + * _update_payment_method_button |
|
541 | + * |
|
542 | + * @access protected |
|
543 | + * @param \EE_Payment_Method $payment_method |
|
544 | + * @return \EE_Form_Section_HTML |
|
545 | + */ |
|
546 | + protected function _payment_method_settings(EE_Payment_Method $payment_method) |
|
547 | + { |
|
548 | + //modify the form so we only have/show fields that will be implemented for this version |
|
549 | + return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name()); |
|
550 | + } |
|
551 | + |
|
552 | + |
|
553 | + |
|
554 | + /** |
|
555 | + * Simplifies the form to merely reproduce 4.1's gateway settings functionality |
|
556 | + * |
|
557 | + * @param EE_Form_Section_Proper $form_section |
|
558 | + * @param string $payment_method_name |
|
559 | + * @return \EE_Payment_Method_Form |
|
560 | + * @throws \EE_Error |
|
561 | + */ |
|
562 | + protected function _simplify_form($form_section, $payment_method_name = '') |
|
563 | + { |
|
564 | + if ($form_section instanceof EE_Payment_Method_Form) { |
|
565 | + $form_section->exclude( |
|
566 | + array( |
|
567 | + 'PMD_type', //dont want them changing the type |
|
568 | + 'PMD_slug', //or the slug (probably never) |
|
569 | + 'PMD_wp_user', //or the user's ID |
|
570 | + 'Currency' //or the currency, until the rest of EE supports simultaneous currencies |
|
571 | + ) |
|
572 | + ); |
|
573 | + return $form_section; |
|
574 | + } else { |
|
575 | + throw new EE_Error(sprintf(__('The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.', |
|
576 | + 'event_espresso'), $payment_method_name)); |
|
577 | + } |
|
578 | + } |
|
579 | + |
|
580 | + |
|
581 | + |
|
582 | + /** |
|
583 | + * _update_payment_method_button |
|
584 | + * |
|
585 | + * @access protected |
|
586 | + * @param \EE_Payment_Method $payment_method |
|
587 | + * @return \EE_Form_Section_HTML |
|
588 | + */ |
|
589 | + protected function _update_payment_method_button(EE_Payment_Method $payment_method) |
|
590 | + { |
|
591 | + $update_button = new EE_Submit_Input( |
|
592 | + array( |
|
593 | + 'name' => 'submit', |
|
594 | + 'html_id' => 'save_' . $payment_method->slug() . '_settings', |
|
595 | + 'default' => sprintf(__('Update %s Payment Settings', 'event_espresso'), |
|
596 | + $payment_method->admin_name()), |
|
597 | + 'html_label' => EEH_HTML::nbsp(), |
|
598 | + ) |
|
599 | + ); |
|
600 | + return new EE_Form_Section_HTML( |
|
601 | + EEH_HTML::no_row(EEH_HTML::br(2)) . |
|
602 | + EEH_HTML::tr( |
|
603 | + EEH_HTML::th(__('Update Settings', 'event_espresso')) . |
|
604 | + EEH_HTML::td( |
|
605 | + $update_button->get_html_for_input() |
|
606 | + ) |
|
607 | + ) |
|
608 | + ); |
|
609 | + } |
|
610 | + |
|
611 | + |
|
612 | + |
|
613 | + /** |
|
614 | + * _deactivate_payment_method_button |
|
615 | + * |
|
616 | + * @access protected |
|
617 | + * @param \EE_Payment_Method $payment_method |
|
618 | + * @return \EE_Form_Section_Proper |
|
619 | + */ |
|
620 | + protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method) |
|
621 | + { |
|
622 | + $link_text_and_title = sprintf(__('Deactivate %1$s Payments?', 'event_espresso'), |
|
623 | + $payment_method->admin_name()); |
|
624 | + return new EE_Form_Section_HTML( |
|
625 | + EEH_HTML::tr( |
|
626 | + EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) . |
|
627 | + EEH_HTML::td( |
|
628 | + EEH_HTML::link( |
|
629 | + EE_Admin_Page::add_query_args_and_nonce( |
|
630 | + array( |
|
631 | + 'action' => 'deactivate_payment_method', |
|
632 | + 'payment_method' => $payment_method->slug(), |
|
633 | + ), |
|
634 | + EE_PAYMENTS_ADMIN_URL |
|
635 | + ), |
|
636 | + $link_text_and_title, |
|
637 | + $link_text_and_title, |
|
638 | + 'deactivate_' . $payment_method->slug(), |
|
639 | + 'espresso-button button-secondary' |
|
640 | + ) |
|
641 | + ) |
|
642 | + ) |
|
643 | + ); |
|
644 | + } |
|
645 | + |
|
646 | + |
|
647 | + |
|
648 | + /** |
|
649 | + * _activate_payment_method_button |
|
650 | + * |
|
651 | + * @access protected |
|
652 | + * @param \EE_Payment_Method $payment_method |
|
653 | + * @return \EE_Form_Section_Proper |
|
654 | + */ |
|
655 | + protected function _activate_payment_method_button(EE_Payment_Method $payment_method) |
|
656 | + { |
|
657 | + $link_text_and_title = sprintf(__('Activate %1$s Payment Method?', 'event_espresso'), |
|
658 | + $payment_method->admin_name()); |
|
659 | + return new EE_Form_Section_Proper( |
|
660 | + array( |
|
661 | + 'name' => 'activate_' . $payment_method->slug() . '_settings_form', |
|
662 | + 'html_id' => 'activate_' . $payment_method->slug() . '_settings_form', |
|
663 | + 'action' => '#', |
|
664 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
665 | + 'subsections' => apply_filters( |
|
666 | + 'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections', |
|
667 | + array( |
|
668 | + new EE_Form_Section_HTML( |
|
669 | + EEH_HTML::tr( |
|
670 | + EEH_HTML::td($payment_method->type_obj()->introductory_html(), |
|
671 | + '', |
|
672 | + '', |
|
673 | + '', |
|
674 | + 'colspan="2"' |
|
675 | + ) |
|
676 | + ) . |
|
677 | + EEH_HTML::tr( |
|
678 | + EEH_HTML::th( |
|
679 | + EEH_HTML::label(__('Click to Activate ', 'event_espresso')) |
|
680 | + ) . |
|
681 | + EEH_HTML::td( |
|
682 | + EEH_HTML::link( |
|
683 | + EE_Admin_Page::add_query_args_and_nonce( |
|
684 | + array( |
|
685 | + 'action' => 'activate_payment_method', |
|
686 | + 'payment_method_type' => $payment_method->type(), |
|
687 | + ), |
|
688 | + EE_PAYMENTS_ADMIN_URL |
|
689 | + ), |
|
690 | + $link_text_and_title, |
|
691 | + $link_text_and_title, |
|
692 | + 'activate_' . $payment_method->slug(), |
|
693 | + 'espresso-button-green button-primary' |
|
694 | + ) |
|
695 | + ) |
|
696 | + ) |
|
697 | + ), |
|
698 | + ), |
|
699 | + $payment_method |
|
700 | + ), |
|
701 | + ) |
|
702 | + ); |
|
703 | + } |
|
704 | + |
|
705 | + |
|
706 | + |
|
707 | + /** |
|
708 | + * _fine_print |
|
709 | + * |
|
710 | + * @access protected |
|
711 | + * @return \EE_Form_Section_HTML |
|
712 | + */ |
|
713 | + protected function _fine_print() |
|
714 | + { |
|
715 | + return new EE_Form_Section_HTML( |
|
716 | + EEH_HTML::tr( |
|
717 | + EEH_HTML::th() . |
|
718 | + EEH_HTML::td( |
|
719 | + EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text') |
|
720 | + ) |
|
721 | + ) |
|
722 | + ); |
|
723 | + } |
|
724 | + |
|
725 | + |
|
726 | + |
|
727 | + /** |
|
728 | + * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far) |
|
729 | + * |
|
730 | + * @global WP_User $current_user |
|
731 | + */ |
|
732 | + protected function _activate_payment_method() |
|
733 | + { |
|
734 | + if (isset($this->_req_data['payment_method_type'])) { |
|
735 | + $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']); |
|
736 | + //see if one exists |
|
737 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
738 | + $payment_method = EE_Payment_Method_Manager::instance() |
|
739 | + ->activate_a_payment_method_of_type($payment_method_type); |
|
740 | + $this->_redirect_after_action(1, 'Payment Method', 'activated', |
|
741 | + array('action' => 'default', 'payment_method' => $payment_method->slug())); |
|
742 | + } else { |
|
743 | + $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default')); |
|
744 | + } |
|
745 | + } |
|
746 | + |
|
747 | + |
|
748 | + |
|
749 | + /** |
|
750 | + * Deactivates the payment method with the specified slug, and redirects. |
|
751 | + */ |
|
752 | + protected function _deactivate_payment_method() |
|
753 | + { |
|
754 | + if (isset($this->_req_data['payment_method'])) { |
|
755 | + $payment_method_slug = sanitize_key($this->_req_data['payment_method']); |
|
756 | + //deactivate it |
|
757 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
758 | + $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug); |
|
759 | + $this->_redirect_after_action($count_updated, 'Payment Method', 'deactivated', |
|
760 | + array('action' => 'default', 'payment_method' => $payment_method_slug)); |
|
761 | + } else { |
|
762 | + $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default')); |
|
763 | + } |
|
764 | + } |
|
765 | + |
|
766 | + |
|
767 | + |
|
768 | + /** |
|
769 | + * Processes the payment method form that was submitted. This is slightly trickier than usual form |
|
770 | + * processing because we first need to identify WHICH form was processed and which payment method |
|
771 | + * it corresponds to. Once we have done that, we see if the form is valid. If it is, the |
|
772 | + * form's data is saved and we redirect to the default payment methods page, setting the updated payment method |
|
773 | + * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the |
|
774 | + * subsequently called 'headers_sent_func' which is _payment_methods_list) |
|
775 | + * |
|
776 | + * @return void |
|
777 | + */ |
|
778 | + protected function _update_payment_method() |
|
779 | + { |
|
780 | + if ($_SERVER['REQUEST_METHOD'] == 'POST') { |
|
781 | + //ok let's find which gateway form to use based on the form input |
|
782 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
783 | + /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */ |
|
784 | + $correct_pmt_form_to_use = null; |
|
785 | + $payment_method = null; |
|
786 | + foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) { |
|
787 | + //get the form and simplify it, like what we do when we display it |
|
788 | + $pmt_form = $this->_generate_payment_method_settings_form($payment_method); |
|
789 | + if ($pmt_form->form_data_present_in($this->_req_data)) { |
|
790 | + $correct_pmt_form_to_use = $pmt_form; |
|
791 | + break; |
|
792 | + } |
|
793 | + } |
|
794 | + //if we couldn't find the correct payment method type... |
|
795 | + if (! $correct_pmt_form_to_use) { |
|
796 | + EE_Error::add_error(__("We could not find which payment method type your form submission related to. Please contact support", |
|
797 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
798 | + $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default')); |
|
799 | + } |
|
800 | + $correct_pmt_form_to_use->receive_form_submission($this->_req_data); |
|
801 | + if ($correct_pmt_form_to_use->is_valid()) { |
|
802 | + $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings'); |
|
803 | + if (! $payment_settings_subform instanceof EE_Payment_Method_Form) { |
|
804 | + throw new EE_Error( |
|
805 | + sprintf( |
|
806 | + __('The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.', |
|
807 | + 'event_espresso'), |
|
808 | + 'payment_method_settings' |
|
809 | + ) |
|
810 | + ); |
|
811 | + } |
|
812 | + $payment_settings_subform->save(); |
|
813 | + /** @var $pm EE_Payment_Method */ |
|
814 | + $this->_redirect_after_action(true, 'Payment Method', 'updated', |
|
815 | + array('action' => 'default', 'payment_method' => $payment_method->slug())); |
|
816 | + } else { |
|
817 | + EE_Error::add_error( |
|
818 | + sprintf( |
|
819 | + __('Payment method of type %s was not saved because there were validation errors. They have been marked in the form', |
|
820 | + 'event_espresso'), |
|
821 | + $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name() |
|
822 | + : __('"(unknown)"', 'event_espresso') |
|
823 | + ), |
|
824 | + __FILE__, |
|
825 | + __FUNCTION__, |
|
826 | + __LINE__ |
|
827 | + ); |
|
828 | + } |
|
829 | + } |
|
830 | + return; |
|
831 | + } |
|
832 | + |
|
833 | + |
|
834 | + |
|
835 | + protected function _payment_settings() |
|
836 | + { |
|
837 | + $this->_template_args['values'] = $this->_yes_no_values; |
|
838 | + $this->_template_args['show_pending_payment_options'] = isset(EE_Registry::instance()->CFG->registration->show_pending_payment_options) |
|
839 | + ? absint(EE_Registry::instance()->CFG->registration->show_pending_payment_options) : false; |
|
840 | + $this->_set_add_edit_form_tags('update_payment_settings'); |
|
841 | + $this->_set_publish_post_box_vars(null, false, false, null, false); |
|
842 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template(EE_PAYMENTS_TEMPLATE_PATH |
|
843 | + . 'payment_settings.template.php', |
|
844 | + $this->_template_args, true); |
|
845 | + $this->display_admin_page_with_sidebar(); |
|
846 | + } |
|
847 | + |
|
848 | + |
|
849 | + |
|
850 | + /** |
|
851 | + * _update_payment_settings |
|
852 | + * |
|
853 | + * @access protected |
|
854 | + * @return array |
|
855 | + */ |
|
856 | + protected function _update_payment_settings() |
|
857 | + { |
|
858 | + EE_Registry::instance()->CFG->registration->show_pending_payment_options = isset($this->_req_data['show_pending_payment_options']) |
|
859 | + ? $this->_req_data['show_pending_payment_options'] : false; |
|
860 | + EE_Registry::instance()->CFG = apply_filters('FHEE__Payments_Admin_Page___update_payment_settings__CFG', |
|
861 | + EE_Registry::instance()->CFG); |
|
862 | 862 | // $superform = new EE_Form_Section_Proper( |
863 | 863 | // array( |
864 | 864 | // 'subsections' => array( |
@@ -876,176 +876,176 @@ discard block |
||
876 | 876 | // ); |
877 | 877 | // $this->_redirect_after_action( 0, 'settings', 'updated', array( 'action' => 'payment_settings' ) ); |
878 | 878 | // } |
879 | - $what = __('Payment Settings', 'event_espresso'); |
|
880 | - $success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__, |
|
881 | - __LINE__); |
|
882 | - $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), |
|
883 | - array('action' => 'payment_settings')); |
|
884 | - } |
|
879 | + $what = __('Payment Settings', 'event_espresso'); |
|
880 | + $success = $this->_update_espresso_configuration($what, EE_Registry::instance()->CFG, __FILE__, __FUNCTION__, |
|
881 | + __LINE__); |
|
882 | + $this->_redirect_after_action($success, $what, __('updated', 'event_espresso'), |
|
883 | + array('action' => 'payment_settings')); |
|
884 | + } |
|
885 | 885 | |
886 | 886 | |
887 | 887 | |
888 | - protected function _payment_log_overview_list_table() |
|
889 | - { |
|
888 | + protected function _payment_log_overview_list_table() |
|
889 | + { |
|
890 | 890 | // $this->_search_btn_label = __('Payment Log', 'event_espresso'); |
891 | - $this->display_admin_list_table_page_with_sidebar(); |
|
892 | - } |
|
893 | - |
|
894 | - |
|
895 | - |
|
896 | - protected function _set_list_table_views_payment_log() |
|
897 | - { |
|
898 | - $this->_views = array( |
|
899 | - 'all' => array( |
|
900 | - 'slug' => 'all', |
|
901 | - 'label' => __('View All Logs', 'event_espresso'), |
|
902 | - 'count' => 0, |
|
903 | - ), |
|
904 | - ); |
|
905 | - } |
|
906 | - |
|
907 | - |
|
908 | - |
|
909 | - /** |
|
910 | - * @param int $per_page |
|
911 | - * @param int $current_page |
|
912 | - * @param bool $count |
|
913 | - * @return array |
|
914 | - */ |
|
915 | - public function get_payment_logs($per_page = 50, $current_page = 0, $count = false) |
|
916 | - { |
|
917 | - EE_Registry::instance()->load_model('Change_Log'); |
|
918 | - //we may need to do multiple queries (joining differently), so we actually wan tan array of query params |
|
919 | - $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway)); |
|
920 | - //check if they've selected a specific payment method |
|
921 | - if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') { |
|
922 | - $query_params[0]['OR*pm_or_pay_pm'] = array( |
|
923 | - 'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'], |
|
924 | - 'Payment_Method.PMD_ID' => $this->_req_data['_payment_method'], |
|
925 | - ); |
|
926 | - } |
|
927 | - //take into account search |
|
928 | - if (isset($this->_req_data['s']) && $this->_req_data['s']) { |
|
929 | - $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%'); |
|
930 | - $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string; |
|
931 | - $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string; |
|
932 | - $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string; |
|
933 | - $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string; |
|
934 | - $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string; |
|
935 | - $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string; |
|
936 | - $query_params[0]['OR*s']['LOG_message'] = $similarity_string; |
|
937 | - $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string; |
|
938 | - $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string; |
|
939 | - $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string; |
|
940 | - $query_params[0]['OR*s']['LOG_message'] = $similarity_string; |
|
941 | - } |
|
942 | - if (isset($this->_req_data['payment-filter-start-date']) |
|
943 | - && isset($this->_req_data['payment-filter-end-date']) |
|
944 | - ) { |
|
945 | - //add date |
|
946 | - $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']); |
|
947 | - $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']); |
|
948 | - //make sure our timestamps start and end right at the boundaries for each day |
|
949 | - $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
950 | - $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
951 | - //convert to timestamps |
|
952 | - $start_date = strtotime($start_date); |
|
953 | - $end_date = strtotime($end_date); |
|
954 | - //makes sure start date is the lowest value and vice versa |
|
955 | - $start_date = min($start_date, $end_date); |
|
956 | - $end_date = max($start_date, $end_date); |
|
957 | - //convert for query |
|
958 | - $start_date = EEM_Change_Log::instance() |
|
959 | - ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date), |
|
960 | - 'Y-m-d H:i:s'); |
|
961 | - $end_date = EEM_Change_Log::instance() |
|
962 | - ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date), |
|
963 | - 'Y-m-d H:i:s'); |
|
964 | - $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date)); |
|
965 | - } |
|
966 | - if ($count) { |
|
967 | - return EEM_Change_Log::instance()->count($query_params); |
|
968 | - } |
|
969 | - if (isset($this->_req_data['order'])) { |
|
970 | - $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] |
|
971 | - : 'DESC'; |
|
972 | - $query_params['order_by'] = array('LOG_time' => $sort); |
|
973 | - } else { |
|
974 | - $query_params['order_by'] = array('LOG_time' => 'DESC'); |
|
975 | - } |
|
976 | - $offset = ($current_page - 1) * $per_page; |
|
977 | - if (! isset($this->_req_data['download_results'])) { |
|
978 | - $query_params['limit'] = array($offset, $per_page); |
|
979 | - } |
|
980 | - //now they've requested to instead just download the file instead of viewing it. |
|
981 | - if (isset($this->_req_data['download_results'])) { |
|
982 | - $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params); |
|
983 | - header('Content-Disposition: attachment'); |
|
984 | - header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url())); |
|
985 | - echo "<h1>Payment Logs for " . site_url() . "</h1>"; |
|
986 | - echo "<h3>Query:</h3>"; |
|
987 | - var_dump($query_params); |
|
988 | - echo "<h3>Results:</h3>"; |
|
989 | - var_dump($wpdb_results); |
|
990 | - die; |
|
991 | - } |
|
992 | - $results = EEM_Change_Log::instance()->get_all($query_params); |
|
993 | - return $results; |
|
994 | - } |
|
995 | - |
|
996 | - |
|
997 | - |
|
998 | - /** |
|
999 | - * Used by usort to RE-sort log query results, because we lose the ordering |
|
1000 | - * because we're possibly combining the results from two queries |
|
1001 | - * |
|
1002 | - * @param EE_Change_Log $logA |
|
1003 | - * @param EE_Change_Log $logB |
|
1004 | - * @return int |
|
1005 | - */ |
|
1006 | - protected function _sort_logs_again($logA, $logB) |
|
1007 | - { |
|
1008 | - $timeA = $logA->get_raw('LOG_time'); |
|
1009 | - $timeB = $logB->get_raw('LOG_time'); |
|
1010 | - if ($timeA == $timeB) { |
|
1011 | - return 0; |
|
1012 | - } |
|
1013 | - $comparison = $timeA < $timeB ? -1 : 1; |
|
1014 | - if (strtoupper($this->_sort_logs_again_direction) == 'DESC') { |
|
1015 | - return $comparison * -1; |
|
1016 | - } else { |
|
1017 | - return $comparison; |
|
1018 | - } |
|
1019 | - } |
|
1020 | - |
|
1021 | - |
|
1022 | - |
|
1023 | - protected function _payment_log_details() |
|
1024 | - { |
|
1025 | - EE_Registry::instance()->load_model('Change_Log'); |
|
1026 | - /** @var $payment_log EE_Change_Log */ |
|
1027 | - $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']); |
|
1028 | - $payment_method = null; |
|
1029 | - $transaction = null; |
|
1030 | - if ($payment_log instanceof EE_Change_Log) { |
|
1031 | - if ($payment_log->object() instanceof EE_Payment) { |
|
1032 | - $payment_method = $payment_log->object()->payment_method(); |
|
1033 | - $transaction = $payment_log->object()->transaction(); |
|
1034 | - } elseif ($payment_log->object() instanceof EE_Payment_Method) { |
|
1035 | - $payment_method = $payment_log->object(); |
|
1036 | - } |
|
1037 | - } |
|
1038 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
1039 | - EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php', |
|
1040 | - array( |
|
1041 | - 'payment_log' => $payment_log, |
|
1042 | - 'payment_method' => $payment_method, |
|
1043 | - 'transaction' => $transaction, |
|
1044 | - ), |
|
1045 | - true |
|
1046 | - ); |
|
1047 | - $this->display_admin_page_with_sidebar(); |
|
1048 | - } |
|
891 | + $this->display_admin_list_table_page_with_sidebar(); |
|
892 | + } |
|
893 | + |
|
894 | + |
|
895 | + |
|
896 | + protected function _set_list_table_views_payment_log() |
|
897 | + { |
|
898 | + $this->_views = array( |
|
899 | + 'all' => array( |
|
900 | + 'slug' => 'all', |
|
901 | + 'label' => __('View All Logs', 'event_espresso'), |
|
902 | + 'count' => 0, |
|
903 | + ), |
|
904 | + ); |
|
905 | + } |
|
906 | + |
|
907 | + |
|
908 | + |
|
909 | + /** |
|
910 | + * @param int $per_page |
|
911 | + * @param int $current_page |
|
912 | + * @param bool $count |
|
913 | + * @return array |
|
914 | + */ |
|
915 | + public function get_payment_logs($per_page = 50, $current_page = 0, $count = false) |
|
916 | + { |
|
917 | + EE_Registry::instance()->load_model('Change_Log'); |
|
918 | + //we may need to do multiple queries (joining differently), so we actually wan tan array of query params |
|
919 | + $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway)); |
|
920 | + //check if they've selected a specific payment method |
|
921 | + if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') { |
|
922 | + $query_params[0]['OR*pm_or_pay_pm'] = array( |
|
923 | + 'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'], |
|
924 | + 'Payment_Method.PMD_ID' => $this->_req_data['_payment_method'], |
|
925 | + ); |
|
926 | + } |
|
927 | + //take into account search |
|
928 | + if (isset($this->_req_data['s']) && $this->_req_data['s']) { |
|
929 | + $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%'); |
|
930 | + $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string; |
|
931 | + $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string; |
|
932 | + $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string; |
|
933 | + $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string; |
|
934 | + $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string; |
|
935 | + $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string; |
|
936 | + $query_params[0]['OR*s']['LOG_message'] = $similarity_string; |
|
937 | + $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string; |
|
938 | + $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string; |
|
939 | + $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string; |
|
940 | + $query_params[0]['OR*s']['LOG_message'] = $similarity_string; |
|
941 | + } |
|
942 | + if (isset($this->_req_data['payment-filter-start-date']) |
|
943 | + && isset($this->_req_data['payment-filter-end-date']) |
|
944 | + ) { |
|
945 | + //add date |
|
946 | + $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']); |
|
947 | + $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']); |
|
948 | + //make sure our timestamps start and end right at the boundaries for each day |
|
949 | + $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00'; |
|
950 | + $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59'; |
|
951 | + //convert to timestamps |
|
952 | + $start_date = strtotime($start_date); |
|
953 | + $end_date = strtotime($end_date); |
|
954 | + //makes sure start date is the lowest value and vice versa |
|
955 | + $start_date = min($start_date, $end_date); |
|
956 | + $end_date = max($start_date, $end_date); |
|
957 | + //convert for query |
|
958 | + $start_date = EEM_Change_Log::instance() |
|
959 | + ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $start_date), |
|
960 | + 'Y-m-d H:i:s'); |
|
961 | + $end_date = EEM_Change_Log::instance() |
|
962 | + ->convert_datetime_for_query('LOG_time', date('Y-m-d H:i:s', $end_date), |
|
963 | + 'Y-m-d H:i:s'); |
|
964 | + $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date)); |
|
965 | + } |
|
966 | + if ($count) { |
|
967 | + return EEM_Change_Log::instance()->count($query_params); |
|
968 | + } |
|
969 | + if (isset($this->_req_data['order'])) { |
|
970 | + $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] |
|
971 | + : 'DESC'; |
|
972 | + $query_params['order_by'] = array('LOG_time' => $sort); |
|
973 | + } else { |
|
974 | + $query_params['order_by'] = array('LOG_time' => 'DESC'); |
|
975 | + } |
|
976 | + $offset = ($current_page - 1) * $per_page; |
|
977 | + if (! isset($this->_req_data['download_results'])) { |
|
978 | + $query_params['limit'] = array($offset, $per_page); |
|
979 | + } |
|
980 | + //now they've requested to instead just download the file instead of viewing it. |
|
981 | + if (isset($this->_req_data['download_results'])) { |
|
982 | + $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params); |
|
983 | + header('Content-Disposition: attachment'); |
|
984 | + header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url())); |
|
985 | + echo "<h1>Payment Logs for " . site_url() . "</h1>"; |
|
986 | + echo "<h3>Query:</h3>"; |
|
987 | + var_dump($query_params); |
|
988 | + echo "<h3>Results:</h3>"; |
|
989 | + var_dump($wpdb_results); |
|
990 | + die; |
|
991 | + } |
|
992 | + $results = EEM_Change_Log::instance()->get_all($query_params); |
|
993 | + return $results; |
|
994 | + } |
|
995 | + |
|
996 | + |
|
997 | + |
|
998 | + /** |
|
999 | + * Used by usort to RE-sort log query results, because we lose the ordering |
|
1000 | + * because we're possibly combining the results from two queries |
|
1001 | + * |
|
1002 | + * @param EE_Change_Log $logA |
|
1003 | + * @param EE_Change_Log $logB |
|
1004 | + * @return int |
|
1005 | + */ |
|
1006 | + protected function _sort_logs_again($logA, $logB) |
|
1007 | + { |
|
1008 | + $timeA = $logA->get_raw('LOG_time'); |
|
1009 | + $timeB = $logB->get_raw('LOG_time'); |
|
1010 | + if ($timeA == $timeB) { |
|
1011 | + return 0; |
|
1012 | + } |
|
1013 | + $comparison = $timeA < $timeB ? -1 : 1; |
|
1014 | + if (strtoupper($this->_sort_logs_again_direction) == 'DESC') { |
|
1015 | + return $comparison * -1; |
|
1016 | + } else { |
|
1017 | + return $comparison; |
|
1018 | + } |
|
1019 | + } |
|
1020 | + |
|
1021 | + |
|
1022 | + |
|
1023 | + protected function _payment_log_details() |
|
1024 | + { |
|
1025 | + EE_Registry::instance()->load_model('Change_Log'); |
|
1026 | + /** @var $payment_log EE_Change_Log */ |
|
1027 | + $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']); |
|
1028 | + $payment_method = null; |
|
1029 | + $transaction = null; |
|
1030 | + if ($payment_log instanceof EE_Change_Log) { |
|
1031 | + if ($payment_log->object() instanceof EE_Payment) { |
|
1032 | + $payment_method = $payment_log->object()->payment_method(); |
|
1033 | + $transaction = $payment_log->object()->transaction(); |
|
1034 | + } elseif ($payment_log->object() instanceof EE_Payment_Method) { |
|
1035 | + $payment_method = $payment_log->object(); |
|
1036 | + } |
|
1037 | + } |
|
1038 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
1039 | + EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php', |
|
1040 | + array( |
|
1041 | + 'payment_log' => $payment_log, |
|
1042 | + 'payment_method' => $payment_method, |
|
1043 | + 'transaction' => $transaction, |
|
1044 | + ), |
|
1045 | + true |
|
1046 | + ); |
|
1047 | + $this->display_admin_page_with_sidebar(); |
|
1048 | + } |
|
1049 | 1049 | |
1050 | 1050 | |
1051 | 1051 | } //end Payments_Admin_Page class |