eventespresso / event-espresso-core

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +1124 added lines, -1124 removed lines

@@ -14,1128 +14,1128 @@
 class Payments_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * Variables used for when we're re-sorting the logs results, in case
-     * we needed to do two queries and we need to resort
-     *
-     * @var string
-     */
-    private $_sort_logs_again_direction;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @return \Payments_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = __('Payment Methods', 'event_espresso');
-        $this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
-        $this->_admin_base_path = EE_PAYMENTS_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        // todo: all hooks for ajax goes here.
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'publishbox' => __('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-    protected function _set_page_routes()
-    {
-        /**
-         * note that with payment method capabilities, although we've implemented
-         * capability mapping which will be used for accessing payment methods owned by
-         * other users.  This is not fully implemented yet in the payment method ui.
-         * Currently only the "plural" caps are in active use.
-         * When cap mapping is implemented, some routes will need to use the singular form of
-         * capability method and also include the $id of the payment method for the route.
-         **/
-        $this->_page_routes = array(
-            'default'                   => array(
-                'func'       => '_payment_methods_list',
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'payment_settings'          => array(
-                'func'       => '_payment_settings',
-                'capability' => 'ee_manage_gateways',
-            ),
-            'activate_payment_method'   => array(
-                'func'       => '_activate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_edit_payment_methods',
-            ),
-            'deactivate_payment_method' => array(
-                'func'       => '_deactivate_payment_method',
-                'noheader'   => true,
-                'capability' => 'ee_delete_payment_methods',
-            ),
-            'update_payment_method'     => array(
-                'func'               => '_update_payment_method',
-                'noheader'           => true,
-                'headers_sent_route' => 'default',
-                'capability'         => 'ee_edit_payment_methods',
-            ),
-            'update_payment_settings'   => array(
-                'func'       => '_update_payment_settings',
-                'noheader'   => true,
-                'capability' => 'ee_manage_gateways',
-            ),
-            'payment_log'               => array(
-                'func'       => '_payment_log_overview_list_table',
-                'capability' => 'ee_read_payment_methods',
-            ),
-            'payment_log_details'       => array(
-                'func'       => '_payment_log_details',
-                'capability' => 'ee_read_payment_methods',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => __('Payment Methods', 'event_espresso'),
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => __('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()
-            ),
-            'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => __('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                // 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => __("Logs", 'event_espresso'),
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _add_payment_method_help_tabs()
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
-        $all_pmt_help_tabs_config = array();
-        foreach ($payment_method_types as $payment_method_type) {
-            if (! EE_Registry::instance()->CAP->current_user_can(
-                $payment_method_type->cap_name(),
-                'specific_payment_method_type_access'
-            )
-            ) {
-                continue;
-            }
-            foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
-                $template_args = isset($config['template_args']) ? $config['template_args'] : array();
-                $template_args['admin_page_obj'] = $this;
-                $all_pmt_help_tabs_config[ $help_tab_name ] = array(
-                    'title'   => $config['title'],
-                    'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
-                        $template_args,
-                        true
-                    ),
-                );
-            }
-        }
-        return $all_pmt_help_tabs_config;
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links');
-        wp_enqueue_script(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            array('espresso-ui-theme', 'ee-datepicker'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_register_style(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links');
-        // scripts
-    }
-
-
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been setup. We do this here because when people activate a
-         * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
-         * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
-         * recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        // setup tabs, one for each payment method type
-        $tabs = array();
-        $payment_methods = array();
-        foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
-            // we don't want to show admin-only PMTs for now
-            if ($pmt_obj instanceof EE_PMT_Admin_Only) {
-                continue;
-            }
-            // check access
-            if (! EE_Registry::instance()->CAP->current_user_can(
-                $pmt_obj->cap_name(),
-                'specific_payment_method_type_access'
-            )
-            ) {
-                continue;
-            }
-            // check for any active pms of that type
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
-            if (! $payment_method instanceof EE_Payment_Method) {
-                $payment_method = EE_Payment_Method::new_instance(
-                    array(
-                        'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
-                        'PMD_type'       => $pmt_obj->system_name(),
-                        'PMD_name'       => $pmt_obj->pretty_name(),
-                        'PMD_admin_name' => $pmt_obj->pretty_name(),
-                    )
-                );
-            }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
-        }
-        $payment_methods = apply_filters(
-            'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-            $payment_methods
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                add_meta_box(
-                    // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    // title
-                    sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
-                    // callback
-                    array($this, 'payment_method_settings_meta_box'),
-                    // post type
-                    null,
-                    // context
-                    'normal',
-                    // priority
-                    'default',
-                    // callback args
-                    array('payment_method' => $payment_method)
-                );
-                // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = array(
-                    'label' => $payment_method->admin_name(),
-                    'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
-                    'title' => __('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                );
-            }
-        }
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $tabs,
-            'payment_method_links',
-            '|',
-            $this->_get_active_payment_method_slug()
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *   _get_active_payment_method_slug
-     *
-     * @return string
-     */
-    protected function _get_active_payment_method_slug()
-    {
-        $payment_method_slug = false;
-        // decide which payment method tab to open first, as dictated by the request's 'payment_method'
-        if (isset($this->_req_data['payment_method'])) {
-            // if they provided the current payment method, use it
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-        }
-        $payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
-        // if that didn't work or wasn't provided, find another way to select the current pm
-        if (! $this->_verify_payment_method($payment_method)) {
-            // like, looking for an active one
-            $payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
-            // test that one as well
-            if ($this->_verify_payment_method($payment_method)) {
-                $payment_method_slug = $payment_method->slug();
-            } else {
-                $payment_method_slug = 'paypal_standard';
-            }
-        }
-        return $payment_method_slug;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
-     *    capabilities to access it
-     *
-     * @param \EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    protected function _verify_payment_method($payment_method)
-    {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
-            && EE_Registry::instance()->CAP->current_user_can(
-                $payment_method->type_obj()->cap_name(),
-                'specific_payment_method_type_access'
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    payment_method_settings_meta_box
-     *
-     * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
-     * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
-     *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
-    {
-        $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
-            ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Payment method metabox setup incorrectly. No Payment method object was supplied',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-        $payment_method_scopes = $payment_method->active();
-        // if the payment method really exists show its form, otherwise the activation template
-        if ($payment_method->ID() && ! empty($payment_method_scopes)) {
-            $form = $this->_generate_payment_method_settings_form($payment_method);
-            if ($form->form_data_present_in($this->_req_data)) {
-                $form->receive_form_submission($this->_req_data);
-            }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
-        } else {
-            echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
-        }
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
-                'action'          => EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'         => 'update_payment_method',
-                        'payment_method' => $payment_method->slug(),
-                    ),
-                    EE_PAYMENTS_ADMIN_URL
-                ),
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-                    array(
-                        'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
-                        'currency_support'        => $this->_currency_support($payment_method),
-                        'payment_method_settings' => $this->_payment_method_settings($payment_method),
-                        'update'                  => $this->_update_payment_method_button($payment_method),
-                        'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
-                        'fine_print'              => $this->_fine_print(),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
-    {
-        if ($payment_method->type_obj()->requires_https()) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            __(
-                                'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                                'event_espresso'
-                            )
-                        )
-                        .
-                        EEH_HTML::br()
-                        .
-                        __('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link(
-                            'https://www.pcisecuritystandards.org/merchants/index.php',
-                            __('PCI DSS compliance', 'event_espresso')
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method)
-    {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return new EE_Form_Section_HTML(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            sprintf(
-                                __(
-                                    '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.',
-                                    'event_espresso'
-                                ),
-                                EE_Config::instance()->currency->code
-                            )
-                        )
-                    )
-                )
-            );
-        } else {
-            return new EE_Form_Section_HTML('');
-        }
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _payment_method_settings(EE_Payment_Method $payment_method)
-    {
-        // modify the form so we only have/show fields that will be implemented for this version
-        return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
-    }
-
-
-    /**
-     * Simplifies the form to merely reproduce 4.1's gateway settings functionality
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @param string                 $payment_method_name
-     * @return \EE_Payment_Method_Form
-     * @throws \EE_Error
-     */
-    protected function _simplify_form($form_section, $payment_method_name = '')
-    {
-        if ($form_section instanceof EE_Payment_Method_Form) {
-            $form_section->exclude(
-                array(
-                    'PMD_type', // dont want them changing the type
-                    'PMD_slug', // or the slug (probably never)
-                    'PMD_wp_user', // or the user's ID
-                    'Currency' // or the currency, until the rest of EE supports simultaneous currencies
-                )
-            );
-            return $form_section;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _update_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $update_button = new EE_Submit_Input(
-            array(
-                'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
-                'default'    => sprintf(
-                    __('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()
-                ),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
-                EEH_HTML::td(
-                    $update_button->get_html_for_input()
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _deactivate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            __('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
-                EEH_HTML::td(
-                    EEH_HTML::link(
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action'         => 'deactivate_payment_method',
-                                'payment_method' => $payment_method->slug(),
-                            ),
-                            EE_PAYMENTS_ADMIN_URL
-                        ),
-                        $link_text_and_title,
-                        $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
-                        'espresso-button button-secondary'
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            __('Activate %1$s Payment Method?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
-                'action'          => '#',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
-                    array(
-                        new EE_Form_Section_HTML(
-                            EEH_HTML::tr(
-                                EEH_HTML::td(
-                                    $payment_method->type_obj()->introductory_html(),
-                                    '',
-                                    '',
-                                    '',
-                                    'colspan="2"'
-                                )
-                            ) .
-                            EEH_HTML::tr(
-                                EEH_HTML::th(
-                                    EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
-                                EEH_HTML::td(
-                                    EEH_HTML::link(
-                                        EE_Admin_Page::add_query_args_and_nonce(
-                                            array(
-                                                'action'              => 'activate_payment_method',
-                                                'payment_method_type' => $payment_method->type(),
-                                            ),
-                                            EE_PAYMENTS_ADMIN_URL
-                                        ),
-                                        $link_text_and_title,
-                                        $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
-                                        'espresso-button-green button-primary'
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return \EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::tr(
-                EEH_HTML::th() .
-                EEH_HTML::td(
-                    EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
-     *
-     * @global WP_User $current_user
-     */
-    protected function _activate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method_type'])) {
-            $payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
-            // see if one exists
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $payment_method = EE_Payment_Method_Manager::instance()
-                                                       ->activate_a_payment_method_of_type($payment_method_type);
-            $this->_redirect_after_action(
-                1,
-                'Payment Method',
-                'activated',
-                array('action' => 'default', 'payment_method' => $payment_method->slug())
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * Deactivates the payment method with the specified slug, and redirects.
-     */
-    protected function _deactivate_payment_method()
-    {
-        if (isset($this->_req_data['payment_method'])) {
-            $payment_method_slug = sanitize_key($this->_req_data['payment_method']);
-            // deactivate it
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
-            $this->_redirect_after_action(
-                $count_updated,
-                'Payment Method',
-                'deactivated',
-                array('action' => 'default', 'payment_method' => $payment_method_slug)
-            );
-        } else {
-            $this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
-        }
-    }
-
-
-    /**
-     * Processes the payment method form that was submitted. This is slightly trickier than usual form
-     * processing because we first need to identify WHICH form was processed and which payment method
-     * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
-     * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
-     * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
-     * subsequently called 'headers_sent_func' which is _payment_methods_list)
-     *
-     * @return void
-     */
-    protected function _update_payment_method()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            // ok let's find which gateway form to use based on the form input
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            /** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
-            $correct_pmt_form_to_use = null;
-            $payment_method = null;
-            foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
-                // get the form and simplify it, like what we do when we display it
-                $pmt_form = $this->_generate_payment_method_settings_form($payment_method);
-                if ($pmt_form->form_data_present_in($this->_req_data)) {
-                    $correct_pmt_form_to_use = $pmt_form;
-                    break;
-                }
-            }
-            // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
-                EE_Error::add_error(
-                    __(
-                        "We could not find which payment method type your form submission related to. Please contact support",
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
-            }
-            $correct_pmt_form_to_use->receive_form_submission($this->_req_data);
-            if ($correct_pmt_form_to_use->is_valid()) {
-                $payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
-                if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
-                                'event_espresso'
-                            ),
-                            'payment_method_settings'
-                        )
-                    );
-                }
-                $payment_settings_subform->save();
-                /** @var $pm EE_Payment_Method */
-                $this->_redirect_after_action(
-                    true,
-                    'Payment Method',
-                    'updated',
-                    array('action' => 'default', 'payment_method' => $payment_method->slug())
-                );
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
-                            'event_espresso'
-                        ),
-                        $payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
-                            : __('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return;
-    }
-
-
-    /**
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        $this->_set_add_edit_form_tags('update_payment_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] =  $form->get_html_and_js();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _update_payment_settings()
-    {
-        $form = $this->getPaymentSettingsForm();
-        if ($form->was_submitted($this->_req_data)) {
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                /**
-                 * @var $reg_config EE_Registration_Config
-                 */
-                $loader = LoaderFactory::getLoader();
-                $reg_config = $loader->getShared('EE_Registration_Config');
-                $valid_data = $form->valid_data();
-                $reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
-                $reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
-            }
-        }
-        EE_Registry::instance()->CFG = apply_filters(
-            'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
-            EE_Registry::instance()->CFG
-        );
-
-        $cfg =  EE_Registry::instance()->CFG ;
-
-        $what = __('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            __('updated', 'event_espresso'),
-            array('action' => 'payment_settings')
-        );
-    }
-
-
-    /**
-     * Gets the form used for updating payment settings
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function getPaymentSettingsForm()
-    {
-        /**
-         * @var $reg_config EE_Registration_Config
-         */
-        $reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'payment-settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => array(
-                    'show_pending_payment_options' => new EE_Yes_No_Input(
-                        array(
-                            'html_name' => 'show_pending_payment_options',
-                            'default' => $reg_config->show_pending_payment_options,
-                            'html_help_text' => esc_html__(
-                                "If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
-                                'event_espresso'
-                            )
-                        )
-                    ),
-                    'gateway_log_lifespan' => new \EE_Select_Input(
-                        $reg_config->gatewayLogLifespanOptions(),
-                        array(
-                            'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
-                            'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
-                            'default' => $reg_config->gateway_log_lifespan,
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    protected function _payment_log_overview_list_table()
-    {
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    protected function _set_list_table_views_payment_log()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'  => 'all',
-                'label' => __('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array
-     */
-    public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        // we may need to do multiple queries (joining differently), so we actually wan tan array of query params
-        $query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
-        // check if they've selected a specific payment method
-        if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
-            $query_params[0]['OR*pm_or_pay_pm'] = array(
-                'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
-                'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
-            );
-        }
-        // take into account search
-        if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
-            $query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
-            $query_params[0]['OR*s']['LOG_message'] = $similarity_string;
-        }
-        if (isset($this->_req_data['payment-filter-start-date'])
-            && isset($this->_req_data['payment-filter-end-date'])
-        ) {
-            // add date
-            $start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
-            $end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
-            // make sure our timestamps start and end right at the boundaries for each day
-            $start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
-            $end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
-            // convert to timestamps
-            $start_date = strtotime($start_date);
-            $end_date = strtotime($end_date);
-            // makes sure start date is the lowest value and vice versa
-            $start_date = min($start_date, $end_date);
-            $end_date = max($start_date, $end_date);
-            // convert for query
-            $start_date = EEM_Change_Log::instance()
-                                        ->convert_datetime_for_query(
-                                            'LOG_time',
-                                            date('Y-m-d H:i:s', $start_date),
-                                            'Y-m-d H:i:s'
-                                        );
-            $end_date = EEM_Change_Log::instance()
-                                      ->convert_datetime_for_query(
-                                          'LOG_time',
-                                          date('Y-m-d H:i:s', $end_date),
-                                          'Y-m-d H:i:s'
-                                      );
-            $query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
-        }
-        if ($count) {
-            return EEM_Change_Log::instance()->count($query_params);
-        }
-        if (isset($this->_req_data['order'])) {
-            $sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
-                : 'DESC';
-            $query_params['order_by'] = array('LOG_time' => $sort);
-        } else {
-            $query_params['order_by'] = array('LOG_time' => 'DESC');
-        }
-        $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
-            $query_params['limit'] = array($offset, $per_page);
-        }
-        // now they've requested to instead just download the file instead of viewing it.
-        if (isset($this->_req_data['download_results'])) {
-            $wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
-            header('Content-Disposition: attachment');
-            header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
-            echo "<h3>Query:</h3>";
-            var_dump($query_params);
-            echo "<h3>Results:</h3>";
-            var_dump($wpdb_results);
-            die;
-        }
-        $results = EEM_Change_Log::instance()->get_all($query_params);
-        return $results;
-    }
-
-
-    /**
-     * Used by usort to RE-sort log query results, because we lose the ordering
-     * because we're possibly combining the results from two queries
-     *
-     * @param EE_Change_Log $logA
-     * @param EE_Change_Log $logB
-     * @return int
-     */
-    protected function _sort_logs_again($logA, $logB)
-    {
-        $timeA = $logA->get_raw('LOG_time');
-        $timeB = $logB->get_raw('LOG_time');
-        if ($timeA == $timeB) {
-            return 0;
-        }
-        $comparison = $timeA < $timeB ? -1 : 1;
-        if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
-            return $comparison * -1;
-        } else {
-            return $comparison;
-        }
-    }
-
-
-    protected function _payment_log_details()
-    {
-        EE_Registry::instance()->load_model('Change_Log');
-        /** @var $payment_log EE_Change_Log */
-        $payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
-        $payment_method = null;
-        $transaction = null;
-        if ($payment_log instanceof EE_Change_Log) {
-            if ($payment_log->object() instanceof EE_Payment) {
-                $payment_method = $payment_log->object()->payment_method();
-                $transaction = $payment_log->object()->transaction();
-            } elseif ($payment_log->object() instanceof EE_Payment_Method) {
-                $payment_method = $payment_log->object();
-            } elseif ($payment_log->object() instanceof EE_Transaction) {
-                $transaction = $payment_log->object();
-                $payment_method = $transaction->payment_method();
-            }
-        }
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
-            array(
-                'payment_log'    => $payment_log,
-                'payment_method' => $payment_method,
-                'transaction'    => $transaction,
-            ),
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
+	/**
+	 * Variables used for when we're re-sorting the logs results, in case
+	 * we needed to do two queries and we need to resort
+	 *
+	 * @var string
+	 */
+	private $_sort_logs_again_direction;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @return \Payments_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = __('Payment Methods', 'event_espresso');
+		$this->_admin_base_url = EE_PAYMENTS_ADMIN_URL;
+		$this->_admin_base_path = EE_PAYMENTS_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		// todo: all hooks for ajax goes here.
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'publishbox' => __('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+	protected function _set_page_routes()
+	{
+		/**
+		 * note that with payment method capabilities, although we've implemented
+		 * capability mapping which will be used for accessing payment methods owned by
+		 * other users.  This is not fully implemented yet in the payment method ui.
+		 * Currently only the "plural" caps are in active use.
+		 * When cap mapping is implemented, some routes will need to use the singular form of
+		 * capability method and also include the $id of the payment method for the route.
+		 **/
+		$this->_page_routes = array(
+			'default'                   => array(
+				'func'       => '_payment_methods_list',
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'payment_settings'          => array(
+				'func'       => '_payment_settings',
+				'capability' => 'ee_manage_gateways',
+			),
+			'activate_payment_method'   => array(
+				'func'       => '_activate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_edit_payment_methods',
+			),
+			'deactivate_payment_method' => array(
+				'func'       => '_deactivate_payment_method',
+				'noheader'   => true,
+				'capability' => 'ee_delete_payment_methods',
+			),
+			'update_payment_method'     => array(
+				'func'               => '_update_payment_method',
+				'noheader'           => true,
+				'headers_sent_route' => 'default',
+				'capability'         => 'ee_edit_payment_methods',
+			),
+			'update_payment_settings'   => array(
+				'func'       => '_update_payment_settings',
+				'noheader'   => true,
+				'capability' => 'ee_manage_gateways',
+			),
+			'payment_log'               => array(
+				'func'       => '_payment_log_overview_list_table',
+				'capability' => 'ee_read_payment_methods',
+			),
+			'payment_log_details'       => array(
+				'func'       => '_payment_log_details',
+				'capability' => 'ee_read_payment_methods',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => __('Payment Methods', 'event_espresso'),
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => __('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()
+			),
+			'help_tour'     => array('Payment_Methods_Selection_Help_Tour'),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => __('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				// 'help_tour' => array( 'Payment_Methods_Settings_Help_Tour' ),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => __("Logs", 'event_espresso'),
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _add_payment_method_help_tabs()
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_method_types = EE_Payment_Method_Manager::instance()->payment_method_types();
+		$all_pmt_help_tabs_config = array();
+		foreach ($payment_method_types as $payment_method_type) {
+			if (! EE_Registry::instance()->CAP->current_user_can(
+				$payment_method_type->cap_name(),
+				'specific_payment_method_type_access'
+			)
+			) {
+				continue;
+			}
+			foreach ($payment_method_type->help_tabs_config() as $help_tab_name => $config) {
+				$template_args = isset($config['template_args']) ? $config['template_args'] : array();
+				$template_args['admin_page_obj'] = $this;
+				$all_pmt_help_tabs_config[ $help_tab_name ] = array(
+					'title'   => $config['title'],
+					'content' => EEH_Template::display_template(
+						$payment_method_type->file_folder() . 'help_tabs' . DS . $config['filename'] . '.help_tab.php',
+						$template_args,
+						true
+					),
+				);
+			}
+		}
+		return $all_pmt_help_tabs_config;
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links');
+		wp_enqueue_script(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			array('espresso-ui-theme', 'ee-datepicker'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_register_style(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links');
+		// scripts
+	}
+
+
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been setup. We do this here because when people activate a
+		 * payment method for the first time (as an addon), it may not setup its capabilities or get registered correctly due
+		 * to the loading process.  However, people MUST setup the details for the payment method so its safe to do a
+		 * recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		// setup tabs, one for each payment method type
+		$tabs = array();
+		$payment_methods = array();
+		foreach (EE_Payment_Method_Manager::instance()->payment_method_types() as $pmt_obj) {
+			// we don't want to show admin-only PMTs for now
+			if ($pmt_obj instanceof EE_PMT_Admin_Only) {
+				continue;
+			}
+			// check access
+			if (! EE_Registry::instance()->CAP->current_user_can(
+				$pmt_obj->cap_name(),
+				'specific_payment_method_type_access'
+			)
+			) {
+				continue;
+			}
+			// check for any active pms of that type
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pmt_obj->system_name());
+			if (! $payment_method instanceof EE_Payment_Method) {
+				$payment_method = EE_Payment_Method::new_instance(
+					array(
+						'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
+						'PMD_type'       => $pmt_obj->system_name(),
+						'PMD_name'       => $pmt_obj->pretty_name(),
+						'PMD_admin_name' => $pmt_obj->pretty_name(),
+					)
+				);
+			}
+			$payment_methods[ $payment_method->slug() ] = $payment_method;
+		}
+		$payment_methods = apply_filters(
+			'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+			$payment_methods
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				add_meta_box(
+					// html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					// title
+					sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
+					// callback
+					array($this, 'payment_method_settings_meta_box'),
+					// post type
+					null,
+					// context
+					'normal',
+					// priority
+					'default',
+					// callback args
+					array('payment_method' => $payment_method)
+				);
+				// setup for tabbed content
+				$tabs[ $payment_method->slug() ] = array(
+					'label' => $payment_method->admin_name(),
+					'class' => $payment_method->active() ? 'gateway-active' : '',
+					'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+					'title' => __('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+				);
+			}
+		}
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$tabs,
+			'payment_method_links',
+			'|',
+			$this->_get_active_payment_method_slug()
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *   _get_active_payment_method_slug
+	 *
+	 * @return string
+	 */
+	protected function _get_active_payment_method_slug()
+	{
+		$payment_method_slug = false;
+		// decide which payment method tab to open first, as dictated by the request's 'payment_method'
+		if (isset($this->_req_data['payment_method'])) {
+			// if they provided the current payment method, use it
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+		}
+		$payment_method = EEM_Payment_Method::instance()->get_one(array(array('PMD_slug' => $payment_method_slug)));
+		// if that didn't work or wasn't provided, find another way to select the current pm
+		if (! $this->_verify_payment_method($payment_method)) {
+			// like, looking for an active one
+			$payment_method = EEM_Payment_Method::instance()->get_one_active('CART');
+			// test that one as well
+			if ($this->_verify_payment_method($payment_method)) {
+				$payment_method_slug = $payment_method->slug();
+			} else {
+				$payment_method_slug = 'paypal_standard';
+			}
+		}
+		return $payment_method_slug;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *    returns TRUE if the passed payment method is properly constructed and the logged in user has the correct
+	 *    capabilities to access it
+	 *
+	 * @param \EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	protected function _verify_payment_method($payment_method)
+	{
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj() instanceof EE_PMT_Base
+			&& EE_Registry::instance()->CAP->current_user_can(
+				$payment_method->type_obj()->cap_name(),
+				'specific_payment_method_type_access'
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    payment_method_settings_meta_box
+	 *
+	 * @param NULL  $post_obj_which_is_null is an object containing the current post (as a $post object)
+	 * @param array $metabox                is an array with metabox id, title, callback, and args elements. the value
+	 *                                      at 'args' has key 'payment_method', as set within _payment_methods_list
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_method_settings_meta_box($post_obj_which_is_null, $metabox)
+	{
+		$payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
+			? $metabox['args']['payment_method'] : null;
+		if (! $payment_method instanceof EE_Payment_Method) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Payment method metabox setup incorrectly. No Payment method object was supplied',
+						'event_espresso'
+					)
+				)
+			);
+		}
+		$payment_method_scopes = $payment_method->active();
+		// if the payment method really exists show its form, otherwise the activation template
+		if ($payment_method->ID() && ! empty($payment_method_scopes)) {
+			$form = $this->_generate_payment_method_settings_form($payment_method);
+			if ($form->form_data_present_in($this->_req_data)) {
+				$form->receive_form_submission($this->_req_data);
+			}
+			echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+		} else {
+			echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
+		}
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $payment_method->slug() . '_settings_form',
+				'html_id'         => $payment_method->slug() . '_settings_form',
+				'action'          => EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'         => 'update_payment_method',
+						'payment_method' => $payment_method->slug(),
+					),
+					EE_PAYMENTS_ADMIN_URL
+				),
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+					array(
+						'pci_dss_compliance'      => $this->_pci_dss_compliance($payment_method),
+						'currency_support'        => $this->_currency_support($payment_method),
+						'payment_method_settings' => $this->_payment_method_settings($payment_method),
+						'update'                  => $this->_update_payment_method_button($payment_method),
+						'deactivate'              => $this->_deactivate_payment_method_button($payment_method),
+						'fine_print'              => $this->_fine_print(),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
+	{
+		if ($payment_method->type_obj()->requires_https()) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							__(
+								'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+								'event_espresso'
+							)
+						)
+						.
+						EEH_HTML::br()
+						.
+						__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link(
+							'https://www.pcisecuritystandards.org/merchants/index.php',
+							__('PCI DSS compliance', 'event_espresso')
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method)
+	{
+		if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return new EE_Form_Section_HTML(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							sprintf(
+								__(
+									'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.',
+									'event_espresso'
+								),
+								EE_Config::instance()->currency->code
+							)
+						)
+					)
+				)
+			);
+		} else {
+			return new EE_Form_Section_HTML('');
+		}
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _payment_method_settings(EE_Payment_Method $payment_method)
+	{
+		// modify the form so we only have/show fields that will be implemented for this version
+		return $this->_simplify_form($payment_method->type_obj()->settings_form(), $payment_method->name());
+	}
+
+
+	/**
+	 * Simplifies the form to merely reproduce 4.1's gateway settings functionality
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param string                 $payment_method_name
+	 * @return \EE_Payment_Method_Form
+	 * @throws \EE_Error
+	 */
+	protected function _simplify_form($form_section, $payment_method_name = '')
+	{
+		if ($form_section instanceof EE_Payment_Method_Form) {
+			$form_section->exclude(
+				array(
+					'PMD_type', // dont want them changing the type
+					'PMD_slug', // or the slug (probably never)
+					'PMD_wp_user', // or the user's ID
+					'Currency' // or the currency, until the rest of EE supports simultaneous currencies
+				)
+			);
+			return $form_section;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The EE_Payment_Method_Form for the "%1$s" payment method is missing or invalid.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _update_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$update_button = new EE_Submit_Input(
+			array(
+				'name'       => 'submit',
+				'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+				'default'    => sprintf(
+					__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()
+				),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::no_row(EEH_HTML::br(2)) .
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+				EEH_HTML::td(
+					$update_button->get_html_for_input()
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _deactivate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+				EEH_HTML::td(
+					EEH_HTML::link(
+						EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action'         => 'deactivate_payment_method',
+								'payment_method' => $payment_method->slug(),
+							),
+							EE_PAYMENTS_ADMIN_URL
+						),
+						$link_text_and_title,
+						$link_text_and_title,
+						'deactivate_' . $payment_method->slug(),
+						'espresso-button button-secondary'
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return \EE_Form_Section_Proper
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			__('Activate %1$s Payment Method?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
+				'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+				'action'          => '#',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Payments_Admin_Page___activate_payment_method_button__form_subsections',
+					array(
+						new EE_Form_Section_HTML(
+							EEH_HTML::tr(
+								EEH_HTML::td(
+									$payment_method->type_obj()->introductory_html(),
+									'',
+									'',
+									'',
+									'colspan="2"'
+								)
+							) .
+							EEH_HTML::tr(
+								EEH_HTML::th(
+									EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
+								) .
+								EEH_HTML::td(
+									EEH_HTML::link(
+										EE_Admin_Page::add_query_args_and_nonce(
+											array(
+												'action'              => 'activate_payment_method',
+												'payment_method_type' => $payment_method->type(),
+											),
+											EE_PAYMENTS_ADMIN_URL
+										),
+										$link_text_and_title,
+										$link_text_and_title,
+										'activate_' . $payment_method->slug(),
+										'espresso-button-green button-primary'
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return \EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::tr(
+				EEH_HTML::th() .
+				EEH_HTML::td(
+					EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Activates a payment method of that type. Mostly assuming there is only 1 of that type (or none so far)
+	 *
+	 * @global WP_User $current_user
+	 */
+	protected function _activate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method_type'])) {
+			$payment_method_type = sanitize_text_field($this->_req_data['payment_method_type']);
+			// see if one exists
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$payment_method = EE_Payment_Method_Manager::instance()
+													   ->activate_a_payment_method_of_type($payment_method_type);
+			$this->_redirect_after_action(
+				1,
+				'Payment Method',
+				'activated',
+				array('action' => 'default', 'payment_method' => $payment_method->slug())
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * Deactivates the payment method with the specified slug, and redirects.
+	 */
+	protected function _deactivate_payment_method()
+	{
+		if (isset($this->_req_data['payment_method'])) {
+			$payment_method_slug = sanitize_key($this->_req_data['payment_method']);
+			// deactivate it
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method($payment_method_slug);
+			$this->_redirect_after_action(
+				$count_updated,
+				'Payment Method',
+				'deactivated',
+				array('action' => 'default', 'payment_method' => $payment_method_slug)
+			);
+		} else {
+			$this->_redirect_after_action(false, 'Payment Method', 'deactivated', array('action' => 'default'));
+		}
+	}
+
+
+	/**
+	 * Processes the payment method form that was submitted. This is slightly trickier than usual form
+	 * processing because we first need to identify WHICH form was processed and which payment method
+	 * it corresponds to. Once we have done that, we see if the form is valid. If it is, the
+	 * form's data is saved and we redirect to the default payment methods page, setting the updated payment method
+	 * as the currently-selected one. If it DOESN'T validate, we render the page with the form's errors (in the
+	 * subsequently called 'headers_sent_func' which is _payment_methods_list)
+	 *
+	 * @return void
+	 */
+	protected function _update_payment_method()
+	{
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			// ok let's find which gateway form to use based on the form input
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			/** @var $correct_pmt_form_to_use EE_Payment_Method_Form */
+			$correct_pmt_form_to_use = null;
+			$payment_method = null;
+			foreach (EEM_Payment_Method::instance()->get_all() as $payment_method) {
+				// get the form and simplify it, like what we do when we display it
+				$pmt_form = $this->_generate_payment_method_settings_form($payment_method);
+				if ($pmt_form->form_data_present_in($this->_req_data)) {
+					$correct_pmt_form_to_use = $pmt_form;
+					break;
+				}
+			}
+			// if we couldn't find the correct payment method type...
+			if (! $correct_pmt_form_to_use) {
+				EE_Error::add_error(
+					__(
+						"We could not find which payment method type your form submission related to. Please contact support",
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(false, 'Payment Method', 'activated', array('action' => 'default'));
+			}
+			$correct_pmt_form_to_use->receive_form_submission($this->_req_data);
+			if ($correct_pmt_form_to_use->is_valid()) {
+				$payment_settings_subform = $correct_pmt_form_to_use->get_subsection('payment_method_settings');
+				if (! $payment_settings_subform instanceof EE_Payment_Method_Form) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The payment method could not be saved because the form sections were misnamed. We expected to find %1$s, but did not.',
+								'event_espresso'
+							),
+							'payment_method_settings'
+						)
+					);
+				}
+				$payment_settings_subform->save();
+				/** @var $pm EE_Payment_Method */
+				$this->_redirect_after_action(
+					true,
+					'Payment Method',
+					'updated',
+					array('action' => 'default', 'payment_method' => $payment_method->slug())
+				);
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'Payment method of type %s was not saved because there were validation errors. They have been marked in the form',
+							'event_espresso'
+						),
+						$payment_method instanceof EE_Payment_Method ? $payment_method->type_obj()->pretty_name()
+							: __('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		$this->_set_add_edit_form_tags('update_payment_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] =  $form->get_html_and_js();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _update_payment_settings()
+	{
+		$form = $this->getPaymentSettingsForm();
+		if ($form->was_submitted($this->_req_data)) {
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				/**
+				 * @var $reg_config EE_Registration_Config
+				 */
+				$loader = LoaderFactory::getLoader();
+				$reg_config = $loader->getShared('EE_Registration_Config');
+				$valid_data = $form->valid_data();
+				$reg_config->show_pending_payment_options = $valid_data['show_pending_payment_options'];
+				$reg_config->gateway_log_lifespan = $valid_data['gateway_log_lifespan'];
+			}
+		}
+		EE_Registry::instance()->CFG = apply_filters(
+			'FHEE__Payments_Admin_Page___update_payment_settings__CFG',
+			EE_Registry::instance()->CFG
+		);
+
+		$cfg =  EE_Registry::instance()->CFG ;
+
+		$what = __('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			__('updated', 'event_espresso'),
+			array('action' => 'payment_settings')
+		);
+	}
+
+
+	/**
+	 * Gets the form used for updating payment settings
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function getPaymentSettingsForm()
+	{
+		/**
+		 * @var $reg_config EE_Registration_Config
+		 */
+		$reg_config = LoaderFactory::getLoader()->getShared('EE_Registration_Config');
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'payment-settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => array(
+					'show_pending_payment_options' => new EE_Yes_No_Input(
+						array(
+							'html_name' => 'show_pending_payment_options',
+							'default' => $reg_config->show_pending_payment_options,
+							'html_help_text' => esc_html__(
+								"If a payment is marked as 'Pending Payment', or if payment is deferred (ie, an offline gateway like Check, Bank, or Invoice is used), then give registrants the option to retry payment. ",
+								'event_espresso'
+							)
+						)
+					),
+					'gateway_log_lifespan' => new \EE_Select_Input(
+						$reg_config->gatewayLogLifespanOptions(),
+						array(
+							'html_label_text' => esc_html__('Gateway Logs Lifespan', 'event_espresso'),
+							'html_help_text' => esc_html__('If issues arise with payments being made through a payment gateway, it\'s helpful to log non-sensitive communications with the payment gateway. But it\'s a security responsibility, so it\'s a good idea to not keep them for any longer than necessary.', 'event_espresso'),
+							'default' => $reg_config->gateway_log_lifespan,
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	protected function _payment_log_overview_list_table()
+	{
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	protected function _set_list_table_views_payment_log()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'  => 'all',
+				'label' => __('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array
+	 */
+	public function get_payment_logs($per_page = 50, $current_page = 0, $count = false)
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		// we may need to do multiple queries (joining differently), so we actually wan tan array of query params
+		$query_params = array(array('LOG_type' => EEM_Change_Log::type_gateway));
+		// check if they've selected a specific payment method
+		if (isset($this->_req_data['_payment_method']) && $this->_req_data['_payment_method'] !== 'all') {
+			$query_params[0]['OR*pm_or_pay_pm'] = array(
+				'Payment.Payment_Method.PMD_ID' => $this->_req_data['_payment_method'],
+				'Payment_Method.PMD_ID'         => $this->_req_data['_payment_method'],
+			);
+		}
+		// take into account search
+		if (isset($this->_req_data['s']) && $this->_req_data['s']) {
+			$similarity_string = array('LIKE', '%' . str_replace("", "%", $this->_req_data['s']) . '%');
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_fname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_lname'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Transaction.Registration.Attendee.ATT_email'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment.Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_admin_name'] = $similarity_string;
+			$query_params[0]['OR*s']['Payment_Method.PMD_type'] = $similarity_string;
+			$query_params[0]['OR*s']['LOG_message'] = $similarity_string;
+		}
+		if (isset($this->_req_data['payment-filter-start-date'])
+			&& isset($this->_req_data['payment-filter-end-date'])
+		) {
+			// add date
+			$start_date = wp_strip_all_tags($this->_req_data['payment-filter-start-date']);
+			$end_date = wp_strip_all_tags($this->_req_data['payment-filter-end-date']);
+			// make sure our timestamps start and end right at the boundaries for each day
+			$start_date = date('Y-m-d', strtotime($start_date)) . ' 00:00:00';
+			$end_date = date('Y-m-d', strtotime($end_date)) . ' 23:59:59';
+			// convert to timestamps
+			$start_date = strtotime($start_date);
+			$end_date = strtotime($end_date);
+			// makes sure start date is the lowest value and vice versa
+			$start_date = min($start_date, $end_date);
+			$end_date = max($start_date, $end_date);
+			// convert for query
+			$start_date = EEM_Change_Log::instance()
+										->convert_datetime_for_query(
+											'LOG_time',
+											date('Y-m-d H:i:s', $start_date),
+											'Y-m-d H:i:s'
+										);
+			$end_date = EEM_Change_Log::instance()
+									  ->convert_datetime_for_query(
+										  'LOG_time',
+										  date('Y-m-d H:i:s', $end_date),
+										  'Y-m-d H:i:s'
+									  );
+			$query_params[0]['LOG_time'] = array('BETWEEN', array($start_date, $end_date));
+		}
+		if ($count) {
+			return EEM_Change_Log::instance()->count($query_params);
+		}
+		if (isset($this->_req_data['order'])) {
+			$sort = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order']
+				: 'DESC';
+			$query_params['order_by'] = array('LOG_time' => $sort);
+		} else {
+			$query_params['order_by'] = array('LOG_time' => 'DESC');
+		}
+		$offset = ($current_page - 1) * $per_page;
+		if (! isset($this->_req_data['download_results'])) {
+			$query_params['limit'] = array($offset, $per_page);
+		}
+		// now they've requested to instead just download the file instead of viewing it.
+		if (isset($this->_req_data['download_results'])) {
+			$wpdb_results = EEM_Change_Log::instance()->get_all_efficiently($query_params);
+			header('Content-Disposition: attachment');
+			header("Content-Disposition: attachment; filename=ee_payment_logs_for_" . sanitize_key(site_url()));
+			echo "<h1>Payment Logs for " . site_url() . "</h1>";
+			echo "<h3>Query:</h3>";
+			var_dump($query_params);
+			echo "<h3>Results:</h3>";
+			var_dump($wpdb_results);
+			die;
+		}
+		$results = EEM_Change_Log::instance()->get_all($query_params);
+		return $results;
+	}
+
+
+	/**
+	 * Used by usort to RE-sort log query results, because we lose the ordering
+	 * because we're possibly combining the results from two queries
+	 *
+	 * @param EE_Change_Log $logA
+	 * @param EE_Change_Log $logB
+	 * @return int
+	 */
+	protected function _sort_logs_again($logA, $logB)
+	{
+		$timeA = $logA->get_raw('LOG_time');
+		$timeB = $logB->get_raw('LOG_time');
+		if ($timeA == $timeB) {
+			return 0;
+		}
+		$comparison = $timeA < $timeB ? -1 : 1;
+		if (strtoupper($this->_sort_logs_again_direction) == 'DESC') {
+			return $comparison * -1;
+		} else {
+			return $comparison;
+		}
+	}
+
+
+	protected function _payment_log_details()
+	{
+		EE_Registry::instance()->load_model('Change_Log');
+		/** @var $payment_log EE_Change_Log */
+		$payment_log = EEM_Change_Log::instance()->get_one_by_ID($this->_req_data['ID']);
+		$payment_method = null;
+		$transaction = null;
+		if ($payment_log instanceof EE_Change_Log) {
+			if ($payment_log->object() instanceof EE_Payment) {
+				$payment_method = $payment_log->object()->payment_method();
+				$transaction = $payment_log->object()->transaction();
+			} elseif ($payment_log->object() instanceof EE_Payment_Method) {
+				$payment_method = $payment_log->object();
+			} elseif ($payment_log->object() instanceof EE_Transaction) {
+				$transaction = $payment_log->object();
+				$payment_method = $transaction->payment_method();
+			}
+		}
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+			array(
+				'payment_log'    => $payment_log,
+				'payment_method' => $payment_method,
+				'transaction'    => $transaction,
+			),
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
 }

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +491 added lines, -491 removed lines

@@ -23,495 +23,495 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array
-     */
-    protected $_currencies_supported = array();
-    /**
-     * Whether or not this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected $_supports_sending_refunds = false;
-
-    /**
-     * Whether or not this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected $_supports_receiving_refunds = false;
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment
-     */
-    protected $_pay_model;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEMI_Payment_Log
-     */
-    protected $_pay_log;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEHI_Template
-     */
-    protected $_template;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEHI_Money
-     */
-    protected $_money;
-
-    /**
-     * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEHI_Line_Item
-     */
-    protected $_line_item;
-
-    /**
-     * @var GatewayDataFormatterInterface
-     */
-    protected $_gateway_data_formatter;
-
-    /**
-     * @var FormatterInterface
-     */
-    protected $_unsupported_character_remover;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected $_ID;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected $_debug_mode;
-    /**
-     *
-     * @var string $_name name to show for this payment method
-     */
-    protected $_name;
-    /**
-     *
-     * @var string name to show fir this payment method to admin-type users
-     */
-    protected $_admin_name;
-
-    /**
-     * @return EE_Gateway
-     */
-    public function __construct()
-    {
-    }
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-    /**
-     * Returns whether or not this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-    /**
-     * Returns whether or not this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return boolean
-     */
-    public function supports_receiving_refunds()
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment for the refund
-     * @throws EE_Error
-     */
-    public function do_direct_refund(EE_Payment $payment, $refund_info = null)
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            $property_name = "_" . $name;
-            $this->{$property_name} = $value;
-        }
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment $payment_model
-     */
-    public function set_payment_model($payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEMI_Payment_Log $payment_log_model
-     */
-    public function set_payment_log($payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Template $template_helper
-     */
-    public function set_template_helper($template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper($line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-    /**
-     * See this class description
-     *
-     * @param EEHI_Money $money_helper
-     */
-    public function set_money_helper($money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter()
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface $formatter
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover()
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param $message
-     * @param $payment
-     */
-    public function log($message, $object_logged)
-    {
-        if ($object_logged instanceof EEI_Payment) {
-            $type = 'Payment';
-            $id = $object_logged->ID();
-        } elseif ($object_logged instanceof EEI_Payment_Method) {
-            $type = 'Payment_Method';
-            $id = $this->_ID;
-        } elseif ($object_logged instanceof EEI_Transaction) {
-            $type = 'Transaction';
-            $id = $object_logged->ID();
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency($amount)
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return mixed array or string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-    /**
-     * Determines whether or not we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EEI_Payment $payment
-     * @return boolean
-     */
-    protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EEI_Payment $payment
-     * @return EEI_Event|null
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event();
-    }
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EEI_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EEI_Payment $payment)
-    {
-        return $payment->get_first_event_name();
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     * @param EE_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     * @param EEI_Payment $payment
-     * @return string
-     */
-    protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Payment   $payment
-     * @return string
-     */
-    protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     * @param EEI_Payment $payment
-     * @return type
-     */
-    protected function _format_order_description(EEI_Payment $payment)
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array
+	 */
+	protected $_currencies_supported = array();
+	/**
+	 * Whether or not this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_sending_refunds = false;
+
+	/**
+	 * Whether or not this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected $_supports_receiving_refunds = false;
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment
+	 */
+	protected $_pay_model;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEMI_Payment_Log
+	 */
+	protected $_pay_log;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEHI_Template
+	 */
+	protected $_template;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEHI_Money
+	 */
+	protected $_money;
+
+	/**
+	 * Concrete class that implements EEHI_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEHI_Line_Item
+	 */
+	protected $_line_item;
+
+	/**
+	 * @var GatewayDataFormatterInterface
+	 */
+	protected $_gateway_data_formatter;
+
+	/**
+	 * @var FormatterInterface
+	 */
+	protected $_unsupported_character_remover;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected $_ID;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected $_debug_mode;
+	/**
+	 *
+	 * @var string $_name name to show for this payment method
+	 */
+	protected $_name;
+	/**
+	 *
+	 * @var string name to show fir this payment method to admin-type users
+	 */
+	protected $_admin_name;
+
+	/**
+	 * @return EE_Gateway
+	 */
+	public function __construct()
+	{
+	}
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+	/**
+	 * Returns whether or not this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+	/**
+	 * Returns whether or not this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return boolean
+	 */
+	public function supports_receiving_refunds()
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment for the refund
+	 * @throws EE_Error
+	 */
+	public function do_direct_refund(EE_Payment $payment, $refund_info = null)
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			$property_name = "_" . $name;
+			$this->{$property_name} = $value;
+		}
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment $payment_model
+	 */
+	public function set_payment_model($payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEMI_Payment_Log $payment_log_model
+	 */
+	public function set_payment_log($payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Template $template_helper
+	 */
+	public function set_template_helper($template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper($line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEHI_Money $money_helper
+	 */
+	public function set_money_helper($money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter()
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface $formatter
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover()
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param $message
+	 * @param $payment
+	 */
+	public function log($message, $object_logged)
+	{
+		if ($object_logged instanceof EEI_Payment) {
+			$type = 'Payment';
+			$id = $object_logged->ID();
+		} elseif ($object_logged instanceof EEI_Payment_Method) {
+			$type = 'Payment_Method';
+			$id = $this->_ID;
+		} elseif ($object_logged instanceof EEI_Transaction) {
+			$type = 'Transaction';
+			$id = $object_logged->ID();
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency($amount)
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they're all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return mixed array or string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+	/**
+	 * Determines whether or not we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return boolean
+	 */
+	protected function _can_easily_itemize_transaction_for(EEI_Payment $payment)
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EEI_Payment $payment
+	 * @return EEI_Event|null
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event();
+	}
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EEI_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EEI_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EEI_Payment $payment)
+	{
+		return $payment->get_first_event_name();
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_name(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 * @param EEI_Payment $payment
+	 * @return string
+	 */
+	protected function _format_partial_payment_line_item_desc(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_name(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Payment   $payment
+	 * @return string
+	 */
+	protected function _format_line_item_desc(EEI_Line_Item $line_item, EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 * @param EEI_Payment $payment
+	 * @return type
+	 */
+	protected function _format_order_description(EEI_Payment $payment)
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
 }

admin_pages/payments/templates/payment_log_details.template.php

Indentation +14 added lines, -14 removed lines

@@ -36,17 +36,17 @@ 
                 </th>
                 <td>
                     <?php
-                    if ($payment_log->object() instanceof EE_Transaction) {
-                        esc_html_e('Unknown', 'event_espresso');
-                    } else {
-                        echo $payment_method
-                        ? $payment_method->admin_name()
-                        : esc_html__(
-                            "No Longer Exists",
-                            'event_espresso'
-                        );
-                    }
-                    ?>
+					if ($payment_log->object() instanceof EE_Transaction) {
+						esc_html_e('Unknown', 'event_espresso');
+					} else {
+						echo $payment_method
+						? $payment_method->admin_name()
+						: esc_html__(
+							"No Longer Exists",
+							'event_espresso'
+						);
+					}
+					?>
 
                 </td>
             </tr>
@@ -69,9 +69,9 @@ 
                 </th>
                 <td>
                     <?php echo $payment_log->e(
-                        'LOG_message',
-                        'as_table'
-                    );// EEH_Template::layout_array_as_table($payment_log->content())?>
+						'LOG_message',
+						'as_table'
+					);// EEH_Template::layout_array_as_table($payment_log->content())?>
                 </td>
             </tr>
             </tbody>

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +808 added lines, -808 removed lines

@@ -21,812 +21,812 @@
 abstract class EE_PMT_Base
 {
 
-    const onsite = 'on-site';
-    const offsite = 'off-site';
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = false;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = null;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = null;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = null;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = true;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string
-     */
-    protected $_pretty_name = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_button_url = null;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_description = null;
-
-
-    /**
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @return EE_PMT_Base
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', DS, $this->file_folder());
-        $file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url = $file_path;
-    }
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description()
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder()
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url()
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     */
-    public function set_instance($payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they setup the payment method
-     *
-     * @return EE_Payment_Method_Form
-     */
-    public function settings_form()
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure its reflected in teh form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form($form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form()
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param \EE_Transaction $transaction
-     * @param array           $extra_args
-     * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
-     */
-    public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            ($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $transaction instanceof EE_Transaction
-                && $transaction->primary_registration() instanceof EE_Registration
-                && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-            ),
-            $this->_billing_form,
-            $transaction
-        )) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form($form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether or not this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https()
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     *
-     * @param EE_Transaction       $transaction
-     * @param float                $amount
-     * @param EE_Billing_Info_Form $billing_info
-     * @param string               $return_url
-     * @param string               $fail_url
-     * @param string               $method
-     * @param bool                 $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_info = null,
-        $return_url = null,
-        $fail_url = '',
-        $method = 'CART',
-        $by_admin = false
-    ) {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            // there is a gateway, so we're going to make a payment object
-            // but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = array(
-                'STS_ID'               => EEM_Payment::status_id_failed,
-                'TXN_ID'               => $transaction->ID(),
-                'PMD_ID'               => $this->_pm_instance->ID(),
-                'PAY_source'           => $method,
-                'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            );
-            $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
-            // if we didn't already have a payment in progress for the same thing,
-            // then we actually want to make a new payment
-            if (! $payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        array(
-                            'PAY_timestamp'       => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number'       => null,
-                            'PAY_extra_accntng'   => null,
-                            'PAY_details'         => null,
-                        )
-                    )
-                );
-            }
-            // make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        array(
-                            'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug(),
-                        )
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                array(
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                )
-            );
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            return $billing_form->input_pretty_values(true);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function handle_ipn($req_data, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    __("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        $payment = $this->_gateway->handle_payment_update($req_data, $transaction);
-        return $payment;
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction                $transaction
-     * @return boolean success
-     */
-    protected function _save_billing_info_to_attendee($billing_form, $transaction)
-    {
-        if (! $transaction || ! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                __("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                __(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn($req_data = array())
-    {
-        throw new EE_Error(
-            sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     */
-    public function finalize_payment_for($transaction)
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether or not this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->supports_sending_refunds();
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     *
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @throws EE_Error
-     * @return EE_Payment
-     */
-    public function process_refund(EE_Payment $payment, $refund_info = array())
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs()
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        } elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php',
-            array('payment_method' => $this->_pm_instance, 'payment' => $payment),
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return array();
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     * @return string
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string
-     */
-    public function pretty_name()
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string
-     */
-    public function default_button_url()
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway()
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link()
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name()
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name()
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html()
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php',
-            array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
-        );
-    }
+	const onsite = 'on-site';
+	const offsite = 'off-site';
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = false;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = null;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = null;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = true;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_description = null;
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @return EE_PMT_Base
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		$fn = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . DS;
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', DS, $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url = $file_path;
+	}
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description()
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder()
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url()
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 */
+	public function set_instance($payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they setup the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	public function settings_form()
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure its reflected in teh form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form($form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form()
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param array           $extra_args
+	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 */
+	public function billing_form(EE_Transaction $transaction = null, $extra_args = array())
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			($this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $transaction instanceof EE_Transaction
+				&& $transaction->primary_registration() instanceof EE_Registration
+				&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+			),
+			$this->_billing_form,
+			$transaction
+		)) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form($form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether or not this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https()
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 *
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount
+	 * @param EE_Billing_Info_Form $billing_info
+	 * @param string               $return_url
+	 * @param string               $fail_url
+	 * @param string               $method
+	 * @param bool                 $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_info = null,
+		$return_url = null,
+		$fail_url = '',
+		$method = 'CART',
+		$by_admin = false
+	) {
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			// there is a gateway, so we're going to make a payment object
+			// but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = array(
+				'STS_ID'               => EEM_Payment::status_id_failed,
+				'TXN_ID'               => $transaction->ID(),
+				'PMD_ID'               => $this->_pm_instance->ID(),
+				'PAY_source'           => $method,
+				'PAY_amount'           => $amount !== null ? $amount : $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			);
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
+			// if we didn't already have a payment in progress for the same thing,
+			// then we actually want to make a new payment
+			if (! $payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						array(
+							'PAY_timestamp'       => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number'       => null,
+							'PAY_extra_accntng'   => null,
+							'PAY_details'         => null,
+						)
+					)
+				);
+			}
+			// make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						array(
+							'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug(),
+						)
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+							'event_espresso'
+						),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				array(
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				)
+			);
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function handle_ipn($req_data, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
+		return $payment;
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction                $transaction
+	 * @return boolean success
+	 */
+	protected function _save_billing_info_to_attendee($billing_form, $transaction)
+	{
+		if (! $transaction || ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				__("Cannot save billing info because the transaction has no primary registration", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn($req_data = array())
+	{
+		throw new EE_Error(
+			sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this))
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 */
+	public function finalize_payment_for($transaction)
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether or not this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->supports_sending_refunds();
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @throws EE_Error
+	 * @return EE_Payment
+	 */
+	public function process_refund(EE_Payment $payment, $refund_info = array())
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs()
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		} elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php',
+			array('payment_method' => $this->_pm_instance, 'payment' => $payment),
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return array();
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 * @return string
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string
+	 */
+	public function default_button_url()
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway()
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link()
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name()
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name()
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html()
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php',
+			array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance)
+		);
+	}
 }

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Indentation +555 added lines, -555 removed lines

@@ -17,559 +17,559 @@
 class EE_Payment_Method_Manager implements ResettableInterface
 {
 
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const   CAPABILITIES_PREFIX = 'ee_payment_method_';
-
-    /**
-     * @var EE_Payment_Method_Manager $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean
-     */
-    protected $payment_method_caps_initialized = false;
-
-    /**
-     * @var array keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected $payment_method_objects = array();
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // set them immediately
-            $this->initializePaymentMethodCaps();
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                array($this, 'addPaymentMethodCapsDuringReset')
-            );
-        }
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        // keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . DS . $module_class . $module_ext;
-        ksort($this->_payment_method_types);
-        return true;
-    }
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if ($force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname;
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class;
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        // if this was the invoice message type, make sure users can view their invoices
-        if ($payment_method->type() === 'Invoice'
-            && (
-            ! EEH_MSG_Template::is_mt_active('invoice')
-            )
-        ) {
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            new PersistentAdminNotice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->defaultFrontendName(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                    array(array('PMD_type' => array('!=', 'Admin_Only')))
-                ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        // now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
-            $payment_method_slug,
-            $count_updated
-        );
-        return $count_updated;
-    }
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    protected function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps()
-    {
-        $caps = array();
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
-    {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
-        }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                          . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param $caps
-     * @return mixed
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const   CAPABILITIES_PREFIX = 'ee_payment_method_';
+
+	/**
+	 * @var EE_Payment_Method_Manager $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean
+	 */
+	protected $payment_method_caps_initialized = false;
+
+	/**
+	 * @var array keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected $payment_method_objects = array();
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// set them immediately
+			$this->initializePaymentMethodCaps();
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				array($this, 'addPaymentMethodCapsDuringReset')
+			);
+		}
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		// keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . DS . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[ $module ] = $payment_method_path . DS . $module_class . $module_ext;
+		ksort($this->_payment_method_types);
+		return true;
+	}
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if ($force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[ $payment_method_name ])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[ $payment_method_name ])) {
+			require_once($this->_payment_method_types[ $payment_method_name ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[ $classname ])) {
+					$this->payment_method_objects[ $classname ] = new $classname;
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class;
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		// if this was the invoice message type, make sure users can view their invoices
+		if ($payment_method->type() === 'Invoice'
+			&& (
+			! EEH_MSG_Template::is_mt_active('invoice')
+			)
+		) {
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			new PersistentAdminNotice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->defaultFrontendName(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+					array(array('PMD_type' => array('!=', 'Admin_Only')))
+				) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		// now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			// verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
+			$payment_method_slug,
+			$count_updated
+		);
+		return $count_updated;
+	}
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	protected function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps()
+	{
+		$caps = array();
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name, $caps);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
+	{
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if (! isset($payment_method_caps[ $role ])) {
+			$payment_method_caps[ $role ] = array();
+		}
+		$payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+										  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param $caps
+	 * @return mixed
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -74,7 +74,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -105,7 +105,7 @@ 
      */
     public function maybe_register_payment_methods($force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -119,7 +119,7 @@ 
     protected function _register_payment_methods()
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -159,9 +159,9 @@ 
         // create class name from module directory name
         $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.DS.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
@@ -169,22 +169,22 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
+        require_once($payment_method_path.DS.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . DS . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.DS.$module_class.$module_ext;
         ksort($this->_payment_method_types);
         return true;
     }
@@ -201,12 +201,12 @@ 
     {
         if ($force_recheck
             || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
+            || ! isset($this->_payment_method_types[$payment_method_name])
         ) {
             $this->maybe_register_payment_methods($force_recheck);
         }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
+        if (isset($this->_payment_method_types[$payment_method_name])) {
+            require_once($this->_payment_method_types[$payment_method_name]);
             return true;
         }
         return false;
@@ -248,8 +248,8 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname;
+                if ( ! isset($this->payment_method_objects[$classname])) {
+                    $this->payment_method_objects[$classname] = new $classname;
                 }
             }
         }
@@ -278,7 +278,7 @@ 
      */
     public function payment_method_class_from_type($type)
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -294,13 +294,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj = new $pm_type_class;
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -336,7 +336,7 @@ 
                         'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages&action=settings').'">',
                     '</a>'
                 ),
                 true
@@ -362,7 +362,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->defaultFrontendName(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), // automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                     array(array('PMD_type' => array('!=', 'Admin_Only')))
@@ -384,14 +384,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         // now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -534,10 +534,10 @@ 
                 )
             );
         }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = array();
+        if ( ! isset($payment_method_caps[$role])) {
+            $payment_method_caps[$role] = array();
         }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
                                           . strtolower($payment_method_name);
         return $payment_method_caps;
     }

admin_pages/payments/Payment_Log_Admin_List_Table.class.php

Indentation +225 added lines, -225 removed lines

@@ -13,111 +13,111 @@ 
 class Payment_Log_Admin_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * @param \EE_Admin_Page $admin_page
-     * @return Payment_Log_Admin_List_Table
-     */
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * _setup_data
-     *
-     * @return void
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page);
-        // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') {
-        //     $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false);
-        // } else {
-        //     $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false);
-        // }
-        $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true);
-        add_action(
-            'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-            array($this, 'add_download_logs_checkbox')
-        );
-    }
-
-
-    /**
-     * add_download_logs_checkbox
-     * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters
-     *
-     * @return void
-     */
-    public function add_download_logs_checkbox()
-    {
-        echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='"
-             . __(
-                 'Download Results',
-                 'event_espresso'
-             ) . "'>";
-    }
-
-
-    /**
-     * _set_properties
-     *
-     * @return void
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('payment log', 'event_espresso'),
-            'plural'   => __('payment logs', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'       => '<input type="checkbox" />',
-            'id'       => __('ID', 'event_espresso'),
-            'LOG_time' => __('Time', 'event_espresso'),
-            'PMD_ID'   => __('Payment Method', 'event_espresso'),
-            'TXN_ID'   => __('Transaction ID', 'event_espresso'),
-        );
-        $this->_sortable_columns = array(
-            'LOG_time' => array('LOG_time' => true),
-        );
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * _get_table_filters
-     *
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-        // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods.
-        $payment_methods = EEM_Payment_Method::instance()->get_all();
-        $payment_method_names = array(
-            array('id' => 'all', 'text' => __("All", 'event_espresso')),
-            array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')),
-        );
-        foreach ($payment_methods as $payment_method) {
-            $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name());
-        }
-        $filters[] = EEH_Form_Fields::select_input(
-            '_payment_method',
-            $payment_method_names,
-            isset($this->_req_data['_payment_method'])
-                ? $this->_req_data['_payment_method'] : 'all'
-        );
-        $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags(
-            $this->_req_data['payment-filter-start-date']
-        ) : date('m/d/Y', strtotime('-6 months'));
-        $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags(
-            $this->_req_data['payment-filter-end-date']
-        ) : date('m/d/Y');
-        ob_start();
-        ?>
+	/**
+	 * @param \EE_Admin_Page $admin_page
+	 * @return Payment_Log_Admin_List_Table
+	 */
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * _setup_data
+	 *
+	 * @return void
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page);
+		// if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') {
+		//     $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false);
+		// } else {
+		//     $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false);
+		// }
+		$this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true);
+		add_action(
+			'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+			array($this, 'add_download_logs_checkbox')
+		);
+	}
+
+
+	/**
+	 * add_download_logs_checkbox
+	 * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters
+	 *
+	 * @return void
+	 */
+	public function add_download_logs_checkbox()
+	{
+		echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='"
+			 . __(
+				 'Download Results',
+				 'event_espresso'
+			 ) . "'>";
+	}
+
+
+	/**
+	 * _set_properties
+	 *
+	 * @return void
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('payment log', 'event_espresso'),
+			'plural'   => __('payment logs', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'       => '<input type="checkbox" />',
+			'id'       => __('ID', 'event_espresso'),
+			'LOG_time' => __('Time', 'event_espresso'),
+			'PMD_ID'   => __('Payment Method', 'event_espresso'),
+			'TXN_ID'   => __('Transaction ID', 'event_espresso'),
+		);
+		$this->_sortable_columns = array(
+			'LOG_time' => array('LOG_time' => true),
+		);
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * _get_table_filters
+	 *
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+		// todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods.
+		$payment_methods = EEM_Payment_Method::instance()->get_all();
+		$payment_method_names = array(
+			array('id' => 'all', 'text' => __("All", 'event_espresso')),
+			array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')),
+		);
+		foreach ($payment_methods as $payment_method) {
+			$payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name());
+		}
+		$filters[] = EEH_Form_Fields::select_input(
+			'_payment_method',
+			$payment_method_names,
+			isset($this->_req_data['_payment_method'])
+				? $this->_req_data['_payment_method'] : 'all'
+		);
+		$start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags(
+			$this->_req_data['payment-filter-start-date']
+		) : date('m/d/Y', strtotime('-6 months'));
+		$end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags(
+			$this->_req_data['payment-filter-end-date']
+		) : date('m/d/Y');
+		ob_start();
+		?>
         <label for="txn-filter-start-date"><?php _e('Display Transactions from ', 'event_espresso'); ?></label>
         <input id="payment-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>"
                name="payment-filter-start-date" size="15"/>
@@ -125,124 +125,124 @@ 
         <input id="payment-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>"
                name="payment-filter-end-date" size="15"/>
         <?php
-        $filters[] = ob_get_clean();
-        return $filters;
-    }
-
-
-    /**
-     * _add_view_counts
-     *
-     * @return void
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->get_payment_logs(
-            $this->_per_page,
-            $this->_current_page,
-            true
-        );
-    }
-
-
-    /**
-     * column_cb
-     *
-     * @param \EE_Change_Log $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID());
-    }
-
-
-    /**
-     * column_id
-     *
-     * @param \EE_Change_Log $item
-     * @return string
-     */
-    public function column_id(EE_Change_Log $item)
-    {
-        $details_query_args = array(
-            'action' => 'payment_log_details',
-            'ID'     => $item->ID(),
-        );
-        $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL);
-        return "<a href='$url'>{$item->ID()}</a>";
-    }
-
-
-    /**
-     * column_LOG_time
-     *
-     * @param \EE_Change_Log $item
-     * @return string
-     */
-    public function column_LOG_time(EE_Change_Log $item)
-    {
-        return $item->get_datetime('LOG_time');
-    }
-
-
-    /**
-     * column_PMD_ID
-     *
-     * @param \EE_Change_Log $item
-     * @return string
-     */
-    public function column_PMD_ID(EE_Change_Log $item)
-    {
-        if ($item->object() instanceof EE_Payment_Method) {
-            return $item->object()->admin_name();
-        } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) {
-            return $item->object()->payment_method()->admin_name();
-        } elseif ($item->object() instanceof EE_Transaction) {
-            return esc_html__('Unknown', 'event_espresso');
-        } else {
-            return esc_html__("No longer exists", 'event_espresso');
-        }
-    }
-
-
-    /**
-     * column_TXN_ID
-     *
-     * @param \EE_Change_Log $item
-     * @return string
-     */
-    public function column_TXN_ID(EE_Change_Log $item)
-    {
-        if ($item->object() instanceof EE_Payment) {
-            $transaction_id = $item->object()->TXN_ID();
-        } elseif ($item->object() instanceof EE_Transaction) {
-            $transaction_id = $item->object()->ID();
-        } else {
-            $transaction_id = null;
-        }
-        if ($transaction_id
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction',
-                $transaction_id
-            )) {
-            $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'view_transaction', 'TXN_ID' => $transaction_id),
-                TXN_ADMIN_URL
-            );
-            return '<a href="'
-                   . $view_txn_lnk_url
-                   . '"  title="'
-                   . sprintf(
-                       esc_attr__('click to view transaction #%s', 'event_espresso'),
-                       $transaction_id
-                   )
-                   . '">'
-                   . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id)
-                   . '</a>';
-        }
-        // No transaction id or use can not view the transaction.
-        return __("Unable to find transaction", 'event_espresso');
-    }
+		$filters[] = ob_get_clean();
+		return $filters;
+	}
+
+
+	/**
+	 * _add_view_counts
+	 *
+	 * @return void
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->get_payment_logs(
+			$this->_per_page,
+			$this->_current_page,
+			true
+		);
+	}
+
+
+	/**
+	 * column_cb
+	 *
+	 * @param \EE_Change_Log $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID());
+	}
+
+
+	/**
+	 * column_id
+	 *
+	 * @param \EE_Change_Log $item
+	 * @return string
+	 */
+	public function column_id(EE_Change_Log $item)
+	{
+		$details_query_args = array(
+			'action' => 'payment_log_details',
+			'ID'     => $item->ID(),
+		);
+		$url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL);
+		return "<a href='$url'>{$item->ID()}</a>";
+	}
+
+
+	/**
+	 * column_LOG_time
+	 *
+	 * @param \EE_Change_Log $item
+	 * @return string
+	 */
+	public function column_LOG_time(EE_Change_Log $item)
+	{
+		return $item->get_datetime('LOG_time');
+	}
+
+
+	/**
+	 * column_PMD_ID
+	 *
+	 * @param \EE_Change_Log $item
+	 * @return string
+	 */
+	public function column_PMD_ID(EE_Change_Log $item)
+	{
+		if ($item->object() instanceof EE_Payment_Method) {
+			return $item->object()->admin_name();
+		} elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) {
+			return $item->object()->payment_method()->admin_name();
+		} elseif ($item->object() instanceof EE_Transaction) {
+			return esc_html__('Unknown', 'event_espresso');
+		} else {
+			return esc_html__("No longer exists", 'event_espresso');
+		}
+	}
+
+
+	/**
+	 * column_TXN_ID
+	 *
+	 * @param \EE_Change_Log $item
+	 * @return string
+	 */
+	public function column_TXN_ID(EE_Change_Log $item)
+	{
+		if ($item->object() instanceof EE_Payment) {
+			$transaction_id = $item->object()->TXN_ID();
+		} elseif ($item->object() instanceof EE_Transaction) {
+			$transaction_id = $item->object()->ID();
+		} else {
+			$transaction_id = null;
+		}
+		if ($transaction_id
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction',
+				$transaction_id
+			)) {
+			$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'view_transaction', 'TXN_ID' => $transaction_id),
+				TXN_ADMIN_URL
+			);
+			return '<a href="'
+				   . $view_txn_lnk_url
+				   . '"  title="'
+				   . sprintf(
+					   esc_attr__('click to view transaction #%s', 'event_espresso'),
+					   $transaction_id
+				   )
+				   . '">'
+				   . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id)
+				   . '</a>';
+		}
+		// No transaction id or use can not view the transaction.
+		return __("Unable to find transaction", 'event_espresso');
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.65.rc.010');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.65.rc.010');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }