eventespresso / event-espresso-core

admin_pages/payments/Payments_Admin_Page.core.php

Indentation +1207 added lines, -1207 removed lines

@@ -16,1211 +16,1211 @@
  */
 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.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_PAYMENTS_PG_SLUG;
-        $this->page_label = esc_html__('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' => esc_html__('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',
-            ),
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_page_config()
-    {
-        $payment_method_list_config = array(
-            'nav'           => array(
-                'label' => esc_html__('Payment Methods', 'event_espresso'),
-                'icon' => 'dashicons-bank',
-                'order' => 10,
-            ),
-            'metaboxes'     => $this->_default_espresso_metaboxes,
-            'help_tabs'     => array_merge(
-                array(
-                    'payment_methods_overview_help_tab' => array(
-                        'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
-                        'filename' => 'payment_methods_overview',
-                    ),
-                ),
-                $this->_add_payment_method_help_tabs()
-            ),
-            'require_nonce' => false,
-        );
-        $this->_page_config = array(
-            'default'          => $payment_method_list_config,
-            'payment_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'icon' => 'dashicons-admin-generic',
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'payment_methods_settings_help_tab' => array(
-                        'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_settings',
-                    ),
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'payment_log'      => array(
-                'nav'           => array(
-                    'label' => esc_html__("Logs", 'event_espresso'),
-                    'icon' => 'dashicons-text-page',
-                    'order' => 30,
-                ),
-                'list_table'    => 'Payment_Log_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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/' . $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()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_style('ee-text-links-css');
-        wp_register_style(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-text-links-js');
-        wp_enqueue_script(
-            'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
-            ['ee-datepicker'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_style('espresso_payments');
-        wp_enqueue_style('ee-text-links-css');
-    }
-
-
-    public function load_scripts_styles_payment_log_details()
-    {
-        wp_enqueue_style('espresso_payments');
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _payment_methods_list()
-    {
-        /**
-         * first let's ensure payment methods have been set up.
-         * We do this here because when people activate a payment method for the first time (as an addon),
-         * it may not set up its capabilities or get registered correctly due to the loading process.
-         * However, people MUST set up the details for the payment method,
-         * so it's safe to do a recheck here.
-         */
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        EEM_Payment_Method::instance()->verify_button_urls();
-        // set up 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) {
-                $this->addMetaBox(
-                    // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
-                    // title
-                    sprintf(esc_html__('%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' => esc_html__('Modify this Payment Method', 'event_espresso'),
-                    'slug'  => $payment_method->slug(),
-                    'icon'  => $payment_method->active()
-                        ? '<span class="dashicons dashicons-yes-alt"></span>'
-                        : '<span class="dashicons dashicons-remove"></span>',
-                );
-            }
-        }
-        $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
-     * @throws EE_Error
-     */
-    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']);
-        }
-        /** @var EE_Payment_Method $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
-     * @throws EE_Error
-     */
-    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 void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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(
-                esc_html__(
-                    '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 wp_kses($form->form_open() . $form->get_html_and_js() . $form->form_close(), AllowedTags::getWithFormTags());
-        } else {
-            echo wp_kses($this->_activate_payment_method_button($payment_method)->get_html_and_js(), AllowedTags::getWithFormTags());
-        }
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     */
-    protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method = null)
-    {
-        if (! $payment_method instanceof EE_Payment_Method) {
-            return new EE_Form_Section_Proper();
-        }
-        $subsections = apply_filters(
-            'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
-            [
-                '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
-        );
-        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'     => array_filter($subsections),
-            )
-        );
-    }
-
-
-    /**
-     * _pci_dss_compliance
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML|null
-     * @throws EE_Error
-     */
-    protected function _pci_dss_compliance(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
-    {
-        if (!$payment_method->type_obj()->requires_https()) {
-            return null;
-        }
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(
-                                esc_html__('IMPORTANT', 'event_espresso'),
-                                '',
-                                'important-notice'
-                            )
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            esc_html__(
-                                'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
-                                'event_espresso'
-                            )
-                        )
-                        .
-                        EEH_HTML::br()
-                        .
-                        esc_html__('Learn more about ', 'event_espresso')
-                        . EEH_HTML::link(
-                            'https://www.pcisecuritystandards.org/merchants/index.php',
-                            esc_html__('PCI DSS compliance', 'event_espresso')
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _currency_support
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_HTML|null
-     * @throws EE_Error
-     */
-    protected function _currency_support(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
-    {
-        if ($payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
-            return null;
-        }
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th(
-                        EEH_HTML::label(
-                            EEH_HTML::strong(
-                                esc_html__('IMPORTANT', 'event_espresso'),
-                                '',
-                                'important-notice'
-                            )
-                        )
-                    ) .
-                    EEH_HTML::td(
-                        EEH_HTML::strong(
-                            sprintf(
-                                esc_html__(
-                                    '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
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     */
-    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', // don't 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(
-                    esc_html__(
-                        '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
-     * @throws EE_Error
-     */
-    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(
-                    esc_html__('Update %s Payment Settings', 'event_espresso'),
-                    $payment_method->admin_name()
-                ),
-                'html_label' => EEH_HTML::nbsp(),
-            )
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::no_row(EEH_HTML::br(2)) .
-                EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('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_HTML
-     */
-    protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
-            $payment_method->admin_name()
-        );
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('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(),
-                            'button button--secondary'
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _activate_payment_method_button
-     *
-     * @access protected
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
-    {
-        $link_text_and_title = sprintf(
-            esc_html__('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::table(
-                                EEH_HTML::tr(
-                                    EEH_HTML::td(
-                                        $payment_method->type_obj()->introductory_html(),
-                                        '',
-                                        '',
-                                        '',
-                                        'colspan="2"'
-                                    )
-                                ) .
-                                EEH_HTML::tr(
-                                    EEH_HTML::th(
-                                        EEH_HTML::label(esc_html__('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(),
-                                            'button button--primary-alt'
-                                        )
-                                    )
-                                )
-                            )
-                        ),
-                    ),
-                    $payment_method
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _fine_print
-     *
-     * @access protected
-     * @return EE_Form_Section_HTML
-     */
-    protected function _fine_print()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_HTML::table(
-                EEH_HTML::tr(
-                    EEH_HTML::th() .
-                    EEH_HTML::td(
-                        EEH_HTML::p(esc_html__('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)
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @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'));
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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) {
-                if ($payment_method instanceof EE_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(
-                    esc_html__(
-                        "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(
-                            esc_html__(
-                                '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(
-                        esc_html__(
-                            '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()
-                            : esc_html__('"(unknown)"', 'event_espresso')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws 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'] = EEH_HTML::div(
-            $form->get_html_and_js(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     *        _update_payment_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws 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
-        );
-
-        $what = esc_html__('Payment Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            esc_html__('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 InvalidDataTypeException
-     * @throws 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,
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    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' => esc_html__('View All Logs', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return array|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 want an 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> '
-                . sprintf(
-                    esc_html__('Payment Logs for %1$s', 'event_espresso'),
-                    esc_url_raw(site_url())
-                )
-                . '</h1 >';
-            echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($query_params, true));
-            echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
-            echo esc_html(var_export($wpdb_results, true));
-            die;
-        }
-        return EEM_Change_Log::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * 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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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;
-        }
-        return $comparison;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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_no_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.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_PAYMENTS_PG_SLUG;
+		$this->page_label = esc_html__('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' => esc_html__('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',
+			),
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_page_config()
+	{
+		$payment_method_list_config = array(
+			'nav'           => array(
+				'label' => esc_html__('Payment Methods', 'event_espresso'),
+				'icon' => 'dashicons-bank',
+				'order' => 10,
+			),
+			'metaboxes'     => $this->_default_espresso_metaboxes,
+			'help_tabs'     => array_merge(
+				array(
+					'payment_methods_overview_help_tab' => array(
+						'title'    => esc_html__('Payment Methods Overview', 'event_espresso'),
+						'filename' => 'payment_methods_overview',
+					),
+				),
+				$this->_add_payment_method_help_tabs()
+			),
+			'require_nonce' => false,
+		);
+		$this->_page_config = array(
+			'default'          => $payment_method_list_config,
+			'payment_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'icon' => 'dashicons-admin-generic',
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'payment_methods_settings_help_tab' => array(
+						'title'    => esc_html__('Payment Method Settings', 'event_espresso'),
+						'filename' => 'payment_methods_settings',
+					),
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'payment_log'      => array(
+				'nav'           => array(
+					'label' => esc_html__("Logs", 'event_espresso'),
+					'icon' => 'dashicons-text-page',
+					'order' => 30,
+				),
+				'list_table'    => 'Payment_Log_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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/' . $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()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_style('ee-text-links-css');
+		wp_register_style(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-text-links-js');
+		wp_enqueue_script(
+			'espresso_payments',
+			EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+			['ee-datepicker'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_style('espresso_payments');
+		wp_enqueue_style('ee-text-links-css');
+	}
+
+
+	public function load_scripts_styles_payment_log_details()
+	{
+		wp_enqueue_style('espresso_payments');
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _payment_methods_list()
+	{
+		/**
+		 * first let's ensure payment methods have been set up.
+		 * We do this here because when people activate a payment method for the first time (as an addon),
+		 * it may not set up its capabilities or get registered correctly due to the loading process.
+		 * However, people MUST set up the details for the payment method,
+		 * so it's safe to do a recheck here.
+		 */
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		EEM_Payment_Method::instance()->verify_button_urls();
+		// set up 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) {
+				$this->addMetaBox(
+					// html id
+					'espresso_' . $payment_method->slug() . '_payment_settings',
+					// title
+					sprintf(esc_html__('%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' => esc_html__('Modify this Payment Method', 'event_espresso'),
+					'slug'  => $payment_method->slug(),
+					'icon'  => $payment_method->active()
+						? '<span class="dashicons dashicons-yes-alt"></span>'
+						: '<span class="dashicons dashicons-remove"></span>',
+				);
+			}
+		}
+		$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
+	 * @throws EE_Error
+	 */
+	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']);
+		}
+		/** @var EE_Payment_Method $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
+	 * @throws EE_Error
+	 */
+	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 void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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(
+				esc_html__(
+					'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 wp_kses($form->form_open() . $form->get_html_and_js() . $form->form_close(), AllowedTags::getWithFormTags());
+		} else {
+			echo wp_kses($this->_activate_payment_method_button($payment_method)->get_html_and_js(), AllowedTags::getWithFormTags());
+		}
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 */
+	protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method = null)
+	{
+		if (! $payment_method instanceof EE_Payment_Method) {
+			return new EE_Form_Section_Proper();
+		}
+		$subsections = apply_filters(
+			'FHEE__Payments_Admin_Page___generate_payment_method_settings_form__form_subsections',
+			[
+				'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
+		);
+		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'     => array_filter($subsections),
+			)
+		);
+	}
+
+
+	/**
+	 * _pci_dss_compliance
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML|null
+	 * @throws EE_Error
+	 */
+	protected function _pci_dss_compliance(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
+	{
+		if (!$payment_method->type_obj()->requires_https()) {
+			return null;
+		}
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(
+								esc_html__('IMPORTANT', 'event_espresso'),
+								'',
+								'important-notice'
+							)
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							esc_html__(
+								'You are responsible for your own website security and Payment Card Industry Data Security Standards (PCI DSS) compliance.',
+								'event_espresso'
+							)
+						)
+						.
+						EEH_HTML::br()
+						.
+						esc_html__('Learn more about ', 'event_espresso')
+						. EEH_HTML::link(
+							'https://www.pcisecuritystandards.org/merchants/index.php',
+							esc_html__('PCI DSS compliance', 'event_espresso')
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _currency_support
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_HTML|null
+	 * @throws EE_Error
+	 */
+	protected function _currency_support(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
+	{
+		if ($payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+			return null;
+		}
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th(
+						EEH_HTML::label(
+							EEH_HTML::strong(
+								esc_html__('IMPORTANT', 'event_espresso'),
+								'',
+								'important-notice'
+							)
+						)
+					) .
+					EEH_HTML::td(
+						EEH_HTML::strong(
+							sprintf(
+								esc_html__(
+									'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
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 */
+	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', // don't 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(
+					esc_html__(
+						'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
+	 * @throws EE_Error
+	 */
+	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(
+					esc_html__('Update %s Payment Settings', 'event_espresso'),
+					$payment_method->admin_name()
+				),
+				'html_label' => EEH_HTML::nbsp(),
+			)
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::no_row(EEH_HTML::br(2)) .
+				EEH_HTML::tr(
+					EEH_HTML::th(esc_html__('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_HTML
+	 */
+	protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('Deactivate %1$s Payments?', 'event_espresso'),
+			$payment_method->admin_name()
+		);
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th(esc_html__('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(),
+							'button button--secondary'
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _activate_payment_method_button
+	 *
+	 * @access protected
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _activate_payment_method_button(EE_Payment_Method $payment_method)
+	{
+		$link_text_and_title = sprintf(
+			esc_html__('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::table(
+								EEH_HTML::tr(
+									EEH_HTML::td(
+										$payment_method->type_obj()->introductory_html(),
+										'',
+										'',
+										'',
+										'colspan="2"'
+									)
+								) .
+								EEH_HTML::tr(
+									EEH_HTML::th(
+										EEH_HTML::label(esc_html__('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(),
+											'button button--primary-alt'
+										)
+									)
+								)
+							)
+						),
+					),
+					$payment_method
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _fine_print
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_HTML
+	 */
+	protected function _fine_print()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_HTML::table(
+				EEH_HTML::tr(
+					EEH_HTML::th() .
+					EEH_HTML::td(
+						EEH_HTML::p(esc_html__('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)
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @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'));
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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) {
+				if ($payment_method instanceof EE_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(
+					esc_html__(
+						"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(
+							esc_html__(
+								'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(
+						esc_html__(
+							'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()
+							: esc_html__('"(unknown)"', 'event_espresso')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Displays payment settings (not payment METHOD settings, that's _payment_method_settings)
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws 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'] = EEH_HTML::div(
+			$form->get_html_and_js(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 *        _update_payment_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws 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
+		);
+
+		$what = esc_html__('Payment Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			esc_html__('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 InvalidDataTypeException
+	 * @throws 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,
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	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' => esc_html__('View All Logs', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return array|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 want an 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> '
+				. sprintf(
+					esc_html__('Payment Logs for %1$s', 'event_espresso'),
+					esc_url_raw(site_url())
+				)
+				. '</h1 >';
+			echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($query_params, true));
+			echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
+			echo esc_html(var_export($wpdb_results, true));
+			die;
+		}
+		return EEM_Change_Log::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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;
+		}
+		return $comparison;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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_no_sidebar();
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -198,10 +198,10 @@ 
             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(
+                $all_pmt_help_tabs_config[$help_tab_name] = array(
                     'title'   => $config['title'],
                     'content' => EEH_Template::display_template(
-                        $payment_method_type->file_folder() . 'help_tabs/' . $config['filename'] . '.help_tab.php',
+                        $payment_method_type->file_folder().'help_tabs/'.$config['filename'].'.help_tab.php',
                         $template_args,
                         true
                     ),
@@ -245,7 +245,7 @@ 
         wp_enqueue_style('ee-text-links-css');
         wp_register_style(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+            EE_PAYMENTS_ASSETS_URL.'ee-payments.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -254,7 +254,7 @@ 
         wp_enqueue_script('ee-text-links-js');
         wp_enqueue_script(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+            EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
             ['ee-datepicker'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -309,7 +309,7 @@ 
             }
             // 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) {
+            if ( ! $payment_method instanceof EE_Payment_Method) {
                 $payment_method = EE_Payment_Method::new_instance(
                     array(
                         'PMD_slug'       => sanitize_key($pmt_obj->system_name()),
@@ -319,7 +319,7 @@ 
                     )
                 );
             }
-            $payment_methods[ $payment_method->slug() ] = $payment_method;
+            $payment_methods[$payment_method->slug()] = $payment_method;
         }
         $payment_methods = apply_filters(
             'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
@@ -329,7 +329,7 @@ 
             if ($payment_method instanceof EE_Payment_Method) {
                 $this->addMetaBox(
                     // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'espresso_'.$payment_method->slug().'_payment_settings',
                     // title
                     sprintf(esc_html__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
                     // callback
@@ -344,10 +344,10 @@ 
                     array('payment_method' => $payment_method)
                 );
                 // setup for tabbed content
-                $tabs[ $payment_method->slug() ] = array(
+                $tabs[$payment_method->slug()] = array(
                     'label' => $payment_method->admin_name(),
                     'class' => $payment_method->active() ? 'gateway-active' : '',
-                    'href'  => 'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'href'  => 'espresso_'.$payment_method->slug().'_payment_settings',
                     'title' => esc_html__('Modify this Payment Method', 'event_espresso'),
                     'slug'  => $payment_method->slug(),
                     'icon'  => $payment_method->active()
@@ -383,7 +383,7 @@ 
         /** @var EE_Payment_Method $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)) {
+        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
@@ -435,7 +435,7 @@ 
     {
         $payment_method = isset($metabox['args'], $metabox['args']['payment_method'])
             ? $metabox['args']['payment_method'] : null;
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             throw new EE_Error(
                 esc_html__(
                     'Payment method metabox setup incorrectly. No Payment method object was supplied',
@@ -450,7 +450,7 @@ 
             if ($form->form_data_present_in($this->_req_data)) {
                 $form->receive_form_submission($this->_req_data);
             }
-            echo wp_kses($form->form_open() . $form->get_html_and_js() . $form->form_close(), AllowedTags::getWithFormTags());
+            echo wp_kses($form->form_open().$form->get_html_and_js().$form->form_close(), AllowedTags::getWithFormTags());
         } else {
             echo wp_kses($this->_activate_payment_method_button($payment_method)->get_html_and_js(), AllowedTags::getWithFormTags());
         }
@@ -467,7 +467,7 @@ 
      */
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method = null)
     {
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             return new EE_Form_Section_Proper();
         }
         $subsections = apply_filters(
@@ -484,8 +484,8 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
+                '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',
@@ -510,7 +510,7 @@ 
      */
     protected function _pci_dss_compliance(EE_Payment_Method $payment_method): ?EE_Form_Section_HTML
     {
-        if (!$payment_method->type_obj()->requires_https()) {
+        if ( ! $payment_method->type_obj()->requires_https()) {
             return null;
         }
         return new EE_Form_Section_HTML(
@@ -524,7 +524,7 @@ 
                                 'important-notice'
                             )
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             esc_html__(
@@ -571,7 +571,7 @@ 
                                 'important-notice'
                             )
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             sprintf(
@@ -651,7 +651,7 @@ 
         $update_button = new EE_Submit_Input(
             array(
                 'name'       => 'submit',
-                'html_id'    => 'save_' . $payment_method->slug() . '_settings',
+                'html_id'    => 'save_'.$payment_method->slug().'_settings',
                 'default'    => sprintf(
                     esc_html__('Update %s Payment Settings', 'event_espresso'),
                     $payment_method->admin_name()
@@ -661,9 +661,9 @@ 
         );
         return new EE_Form_Section_HTML(
             EEH_HTML::table(
-                EEH_HTML::no_row(EEH_HTML::br(2)) .
+                EEH_HTML::no_row(EEH_HTML::br(2)).
                 EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('Update Settings', 'event_espresso')) .
+                    EEH_HTML::th(esc_html__('Update Settings', 'event_espresso')).
                     EEH_HTML::td(
                         $update_button->get_html_for_input()
                     )
@@ -689,7 +689,7 @@ 
         return new EE_Form_Section_HTML(
             EEH_HTML::table(
                 EEH_HTML::tr(
-                    EEH_HTML::th(esc_html__('Deactivate Payment Method', 'event_espresso')) .
+                    EEH_HTML::th(esc_html__('Deactivate Payment Method', 'event_espresso')).
                     EEH_HTML::td(
                         EEH_HTML::link(
                             EE_Admin_Page::add_query_args_and_nonce(
@@ -701,7 +701,7 @@ 
                             ),
                             $link_text_and_title,
                             $link_text_and_title,
-                            'deactivate_' . $payment_method->slug(),
+                            'deactivate_'.$payment_method->slug(),
                             'button button--secondary'
                         )
                     )
@@ -727,8 +727,8 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                'name'            => 'activate_' . $payment_method->slug() . '_settings_form',
-                'html_id'         => 'activate_' . $payment_method->slug() . '_settings_form',
+                '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(
@@ -744,11 +744,11 @@ 
                                         '',
                                         'colspan="2"'
                                     )
-                                ) .
+                                ).
                                 EEH_HTML::tr(
                                     EEH_HTML::th(
                                         EEH_HTML::label(esc_html__('Click to Activate ', 'event_espresso'))
-                                    ) .
+                                    ).
                                     EEH_HTML::td(
                                         EEH_HTML::link(
                                             EE_Admin_Page::add_query_args_and_nonce(
@@ -760,7 +760,7 @@ 
                                             ),
                                             $link_text_and_title,
                                             $link_text_and_title,
-                                            'activate_' . $payment_method->slug(),
+                                            'activate_'.$payment_method->slug(),
                                             'button button--primary-alt'
                                         )
                                     )
@@ -786,7 +786,7 @@ 
         return new EE_Form_Section_HTML(
             EEH_HTML::table(
                 EEH_HTML::tr(
-                    EEH_HTML::th() .
+                    EEH_HTML::th().
                     EEH_HTML::td(
                         EEH_HTML::p(esc_html__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
                     )
@@ -877,7 +877,7 @@ 
                 }
             }
             // if we couldn't find the correct payment method type...
-            if (! $correct_pmt_form_to_use) {
+            if ( ! $correct_pmt_form_to_use) {
                 EE_Error::add_error(
                     esc_html__(
                         "We could not find which payment method type your form submission related to. Please contact support",
@@ -892,7 +892,7 @@ 
             $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) {
+                if ( ! $payment_settings_subform instanceof EE_Payment_Method_Form) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1087,7 +1087,7 @@ 
         }
         // take into account search
         if (isset($this->_req_data['s']) && $this->_req_data['s']) {
-            $similarity_string = array('LIKE', '%' . str_replace("", "%", $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;
@@ -1108,8 +1108,8 @@ 
             $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';
+            $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);
@@ -1122,7 +1122,7 @@ 
                 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(
+            $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'
@@ -1141,23 +1141,23 @@ 
             $query_params['order_by'] = array('LOG_time' => 'DESC');
         }
         $offset = ($current_page - 1) * $per_page;
-        if (! isset($this->_req_data['download_results'])) {
+        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()));
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
             echo '<h1> '
                 . sprintf(
                     esc_html__('Payment Logs for %1$s', 'event_espresso'),
                     esc_url_raw(site_url())
                 )
                 . '</h1 >';
-            echo '<h3>' . esc_html__('Query:', 'event_espresso') . '</h3>';
+            echo '<h3>'.esc_html__('Query:', 'event_espresso').'</h3>';
             echo esc_html(var_export($query_params, true));
-            echo '<h3>' . esc_html__('Results:', 'event_espresso') . '</h3>';
+            echo '<h3>'.esc_html__('Results:', 'event_espresso').'</h3>';
             echo esc_html(var_export($wpdb_results, true));
             die;
         }
@@ -1213,7 +1213,7 @@ 
             }
         }
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EE_PAYMENTS_TEMPLATE_PATH . 'payment_log_details.template.php',
+            EE_PAYMENTS_TEMPLATE_PATH.'payment_log_details.template.php',
             array(
                 'payment_log'    => $payment_log,
                 'payment_method' => $payment_method,

core/services/graphql/connections/ConnectionCollection.php

Indentation +74 added lines, -74 removed lines

@@ -20,86 +20,86 @@
  */
 class ConnectionCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_connections';
+	const COLLECTION_NAME = 'espresso_graphql_connections';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
-    /**
-     * ConnectionCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            'EventEspresso\core\services\graphql\connections\ConnectionInterface',
-            ConnectionCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * ConnectionCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			'EventEspresso\core\services\graphql\connections\ConnectionInterface',
+			ConnectionCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    ConnectionCollection::COLLECTION_NAME,
-                    // collection interface
-                    'EventEspresso\core\services\graphql\connections\ConnectionInterface',
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_ConnectionCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\connections']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					ConnectionCollection::COLLECTION_NAME,
+					// collection interface
+					'EventEspresso\core\services\graphql\connections\ConnectionInterface',
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_ConnectionCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\connections']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function loadConnections()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function loadConnections()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return string
-     */
-    public function getIdentifier($object, $identifier = null): string
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return string
+	 */
+	public function getIdentifier($object, $identifier = null): string
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/graphql/enums/EnumCollection.php

Indentation +74 added lines, -74 removed lines

@@ -20,86 +20,86 @@
  */
 class EnumCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_enums';
+	const COLLECTION_NAME = 'espresso_graphql_enums';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
-    /**
-     * EnumCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            'EventEspresso\core\services\graphql\enums\EnumInterface',
-            EnumCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * EnumCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			'EventEspresso\core\services\graphql\enums\EnumInterface',
+			EnumCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    EnumCollection::COLLECTION_NAME,
-                    // collection interface
-                    'EventEspresso\core\services\graphql\enums\EnumInterface',
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_EnumCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\enums']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					EnumCollection::COLLECTION_NAME,
+					// collection interface
+					'EventEspresso\core\services\graphql\enums\EnumInterface',
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_EnumCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\enums']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function loadEnums()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function loadEnums()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return string
-     */
-    public function getIdentifier($object, $identifier = null): string
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return string
+	 */
+	public function getIdentifier($object, $identifier = null): string
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/graphql/types/TypeCollection.php

Indentation +75 added lines, -75 removed lines

@@ -20,89 +20,89 @@
  */
 class TypeCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_types';
+	const COLLECTION_NAME = 'espresso_graphql_types';
 
-    const COLLECTION_INTERFACE = 'EventEspresso\core\services\graphql\types\TypeInterface';
+	const COLLECTION_INTERFACE = 'EventEspresso\core\services\graphql\types\TypeInterface';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
 
-    /**
-     * TypeCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            TypeCollection::COLLECTION_INTERFACE,
-            TypeCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * TypeCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			TypeCollection::COLLECTION_INTERFACE,
+			TypeCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    TypeCollection::COLLECTION_NAME,
-                    // collection interface
-                    TypeCollection::COLLECTION_INTERFACE,
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_TypeCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\types']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					TypeCollection::COLLECTION_NAME,
+					// collection interface
+					TypeCollection::COLLECTION_INTERFACE,
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_TypeCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\types']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function loadTypes()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function loadTypes()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return string
-     */
-    public function getIdentifier($object, $identifier = null): string
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return string
+	 */
+	public function getIdentifier($object, $identifier = null): string
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/graphql/inputs/InputCollection.php

Indentation +74 added lines, -74 removed lines

@@ -20,86 +20,86 @@
  */
 class InputCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_inputs';
+	const COLLECTION_NAME = 'espresso_graphql_inputs';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
-    /**
-     * InputCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            'EventEspresso\core\services\graphql\inputs\InputInterface',
-            InputCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * InputCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			'EventEspresso\core\services\graphql\inputs\InputInterface',
+			InputCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    InputCollection::COLLECTION_NAME,
-                    // collection interface
-                    'EventEspresso\core\services\graphql\inputs\InputInterface',
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_InputCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\inputs']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					InputCollection::COLLECTION_NAME,
+					// collection interface
+					'EventEspresso\core\services\graphql\inputs\InputInterface',
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_InputCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\inputs']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function loadInputs()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function loadInputs()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return string
-     */
-    public function getIdentifier($object, $identifier = null): string
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return string
+	 */
+	public function getIdentifier($object, $identifier = null): string
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/graphql/resolvers/ResolverCollection.php

Indentation +74 added lines, -74 removed lines

@@ -20,86 +20,86 @@
  */
 class ResolverCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_resolvers';
+	const COLLECTION_NAME = 'espresso_graphql_resolvers';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
-    /**
-     * ResolverCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            'EventEspresso\core\services\graphql\ResolverInterface',
-            ResolverCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * ResolverCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			'EventEspresso\core\services\graphql\ResolverInterface',
+			ResolverCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    ResolverCollection::COLLECTION_NAME,
-                    // collection interface
-                    'EventEspresso\core\services\graphql\ResolverInterface',
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_ResolverCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\resolvers']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					ResolverCollection::COLLECTION_NAME,
+					// collection interface
+					'EventEspresso\core\services\graphql\ResolverInterface',
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_ResolverCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\resolvers']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since $VID:$
-     */
-    public function loadResolvers()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since $VID:$
+	 */
+	public function loadResolvers()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return string
-     */
-    public function getIdentifier($object, $identifier = null): string
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return string
+	 */
+	public function getIdentifier($object, $identifier = null): string
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/orm/ModelFieldFactory.php

Indentation +622 added lines, -622 removed lines

@@ -47,626 +47,626 @@
  */
 class ModelFieldFactory implements InterminableInterface
 {
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-
-    /**
-     * ModelFieldFactory constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_All_Caps_Text_Field
-     */
-    public function createAllCapsTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_All_Caps_Text_Field {
-        return $this->loader->getNew(
-            'EE_All_Caps_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @param string     $model_name
-     * @return EE_Any_Foreign_Model_Name_Field
-     */
-    public function createAnyForeignModelNameField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        string $model_name = ''
-    ): EE_Any_Foreign_Model_Name_Field {
-        return $this->loader->getNew(
-            'EE_Any_Foreign_Model_Name_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Boolean_Field
-     */
-    public function createBooleanField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Boolean_Field {
-        return $this->loader->getNew(
-            'EE_Boolean_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string      $table_column
-     * @param string      $nice_name
-     * @param bool|null   $nullable
-     * @param string|null $default_value
-     * @return EE_Datetime_Field
-     */
-    public function createDatetimeField(
-        string $table_column,
-        string $nice_name,
-        ?bool $nullable = false,
-        ?string $default_value = EE_Datetime_Field::now
-    ): EE_Datetime_Field {
-        return $this->loader->getNew(
-            'EE_Datetime_Field',
-            [
-                $table_column,
-                $nice_name,
-                $nullable,
-                $default_value,
-            ]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_DB_Only_Float_Field
-     */
-    public function createDbOnlyFloatField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Float_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Float_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_DB_Only_Int_Field
-     */
-    public function createDbOnlyIntField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Int_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Int_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_DB_Only_Text_Field
-     */
-    public function createDbOnlyTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Text_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string      $table_column
-     * @param string      $nice_name
-     * @param bool        $nullable
-     * @param string|null $default_value
-     * @return EE_Email_Field
-     */
-    public function createEmailField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = true,
-        string $default_value = ''
-    ): EE_Email_Field {
-        return $this->loader->getNew(
-            'EE_Email_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @param array      $allowed_enum_values keys are values to be used in the DB,
-     *                                        values are how they should be displayed
-     * @return EE_Enum_Integer_Field
-     */
-    public function createEnumIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        array $allowed_enum_values = []
-    ): EE_Enum_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Enum_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @param array      $allowed_enum_values keys are values to be used in the DB,
-     *                                        values are how they should be displayed
-     * @return EE_Enum_Text_Field
-     */
-    public function createEnumTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        array $allowed_enum_values
-    ): EE_Enum_Text_Field {
-        return $this->loader->getNew(
-            'EE_Enum_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Float_Field
-     */
-    public function createFloatField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Float_Field {
-        return $this->loader->getNew(
-            'EE_Float_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @param string     $model_name
-     * @return EE_Foreign_Key_Int_Field
-     */
-    public function createForeignKeyIntField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        string $model_name
-    ): EE_Foreign_Key_Int_Field {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_Int_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @param string     $model_name
-     * @return EE_Foreign_Key_String_Field
-     */
-    public function createForeignKeyStringField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        string $model_name
-    ): EE_Foreign_Key_String_Field {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_String_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Full_HTML_Field
-     */
-    public function createFullHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Full_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Full_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Infinite_Integer_Field
-     */
-    public function createInfiniteIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Infinite_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Infinite_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param int    $default_value
-     * @return EE_Integer_Field
-     */
-    public function createIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = false,
-        int $default_value = 0
-    ): EE_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Maybe_Serialized_Simple_HTML_Field
-     */
-    public function createMaybeSerializedSimpleHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Maybe_Serialized_Simple_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Simple_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Maybe_Serialized_Text_Field
-     */
-    public function createMaybeSerializedTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Maybe_Serialized_Text_Field {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Money_Field
-     */
-    public function createMoneyField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Money_Field {
-        return $this->loader->getNew(
-            'EE_Money_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Plain_Text_Field
-     */
-    public function createPlainTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = true,
-        string $default_value = ''
-    ): EE_Plain_Text_Field {
-        return $this->loader->getNew(
-            'EE_Plain_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Post_Content_Field
-     */
-    public function createPostContentField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Post_Content_Field {
-        return $this->loader->getNew(
-            'EE_Post_Content_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_Int_Field
-     */
-    public function createPrimaryKeyIntField(string $table_column, string $nice_name): EE_Primary_Key_Int_Field
-    {
-        return $this->loader->getNew('EE_Primary_Key_Int_Field', [$table_column, $nice_name]);
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_String_Field
-     */
-    public function createPrimaryKeyStringField(string $table_column, string $nice_name): EE_Primary_Key_String_Field
-    {
-        return $this->loader->getNew('EE_Primary_Key_String_Field', [$table_column, $nice_name]);
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Serialized_Text_Field
-     */
-    public function createSerializedTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Serialized_Text_Field {
-        return $this->loader->getNew(
-            'EE_Serialized_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Simple_HTML_Field
-     */
-    public function createSimpleHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Simple_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Simple_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Slug_Field
-     */
-    public function createSlugField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = false,
-        $default_value = null
-    ): EE_Slug_Field {
-        return $this->loader->getNew(
-            'EE_Slug_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string     $table_column
-     * @param string     $nice_name
-     * @param bool       $nullable
-     * @param mixed|null $default_value
-     * @return EE_Trashed_Flag_Field
-     */
-    public function createTrashedFlagField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Trashed_Flag_Field {
-        return $this->loader->getNew(
-            'EE_Trashed_Flag_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param mixed  $default_value
-     * @param array $values     If additional statuses are to be used other than the default WP statuses,
-     *                          then they can be registered via this property.
-     *                          The format of the array should be as follows:
-     *                          [
-     *                              'status_reference' => [
-     *                                  'label' => __('Status Reference Label', 'event_espresso'),
-     *                                  // whether status is shown on the frontend of the site
-     *                                  'public' => true,
-     *                                  // whether status is excluded from wp searches
-     *                                  'exclude_from_search' => false,
-     *                                  // whether status is included in queries
-     *                                  for the admin 'all' view in list table views.
-     *                                  'show_in_admin_all_list' => true,
-     *                                  // show in the list of statuses with post counts
-     *                                  // at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                  'show_in_admin_status_list' => true,
-     *                                  // the text to display on the admin screen
-     *                                  // ( or you won't see your status count )
-     *                                  'label_count' => _n_noop(
-     *                                      'Status Reference <span class="count">(%s)</span>',
-     *                                      'Status References <span class="count">(%s)</span>'
-     *                                  ),
-     *                              ]
-     *                          ]
-     * @return EE_WP_Post_Status_Field
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     */
-    public function createWpPostStatusField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        array $values = []
-    ): EE_WP_Post_Status_Field {
-        return $this->loader->getNew(
-            'EE_WP_Post_Status_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $values]
-        );
-    }
-
-
-    /**
-     * @param string $post_type
-     * @return EE_WP_Post_Type_Field
-     */
-    public function createWpPostTypeField(string $post_type): EE_WP_Post_Type_Field
-    {
-        return $this->loader->getNew('EE_WP_Post_Type_Field', [$post_type]);
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @return EE_WP_User_Field
-     */
-    public function createWpUserField(string $table_column, string $nice_name, bool $nullable): EE_WP_User_Field
-    {
-        return $this->loader->getNew('EE_WP_User_Field', [$table_column, $nice_name, $nullable]);
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+
+	/**
+	 * ModelFieldFactory constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_All_Caps_Text_Field
+	 */
+	public function createAllCapsTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_All_Caps_Text_Field {
+		return $this->loader->getNew(
+			'EE_All_Caps_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @param string     $model_name
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 */
+	public function createAnyForeignModelNameField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		string $model_name = ''
+	): EE_Any_Foreign_Model_Name_Field {
+		return $this->loader->getNew(
+			'EE_Any_Foreign_Model_Name_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Boolean_Field
+	 */
+	public function createBooleanField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Boolean_Field {
+		return $this->loader->getNew(
+			'EE_Boolean_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string      $table_column
+	 * @param string      $nice_name
+	 * @param bool|null   $nullable
+	 * @param string|null $default_value
+	 * @return EE_Datetime_Field
+	 */
+	public function createDatetimeField(
+		string $table_column,
+		string $nice_name,
+		?bool $nullable = false,
+		?string $default_value = EE_Datetime_Field::now
+	): EE_Datetime_Field {
+		return $this->loader->getNew(
+			'EE_Datetime_Field',
+			[
+				$table_column,
+				$nice_name,
+				$nullable,
+				$default_value,
+			]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_DB_Only_Float_Field
+	 */
+	public function createDbOnlyFloatField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Float_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Float_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_DB_Only_Int_Field
+	 */
+	public function createDbOnlyIntField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Int_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Int_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_DB_Only_Text_Field
+	 */
+	public function createDbOnlyTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Text_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string      $table_column
+	 * @param string      $nice_name
+	 * @param bool        $nullable
+	 * @param string|null $default_value
+	 * @return EE_Email_Field
+	 */
+	public function createEmailField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = true,
+		string $default_value = ''
+	): EE_Email_Field {
+		return $this->loader->getNew(
+			'EE_Email_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @param array      $allowed_enum_values keys are values to be used in the DB,
+	 *                                        values are how they should be displayed
+	 * @return EE_Enum_Integer_Field
+	 */
+	public function createEnumIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		array $allowed_enum_values = []
+	): EE_Enum_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Enum_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @param array      $allowed_enum_values keys are values to be used in the DB,
+	 *                                        values are how they should be displayed
+	 * @return EE_Enum_Text_Field
+	 */
+	public function createEnumTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		array $allowed_enum_values
+	): EE_Enum_Text_Field {
+		return $this->loader->getNew(
+			'EE_Enum_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Float_Field
+	 */
+	public function createFloatField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Float_Field {
+		return $this->loader->getNew(
+			'EE_Float_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @param string     $model_name
+	 * @return EE_Foreign_Key_Int_Field
+	 */
+	public function createForeignKeyIntField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		string $model_name
+	): EE_Foreign_Key_Int_Field {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_Int_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @param string     $model_name
+	 * @return EE_Foreign_Key_String_Field
+	 */
+	public function createForeignKeyStringField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		string $model_name
+	): EE_Foreign_Key_String_Field {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_String_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Full_HTML_Field
+	 */
+	public function createFullHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Full_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Full_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Infinite_Integer_Field
+	 */
+	public function createInfiniteIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Infinite_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Infinite_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param int    $default_value
+	 * @return EE_Integer_Field
+	 */
+	public function createIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = false,
+		int $default_value = 0
+	): EE_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Maybe_Serialized_Simple_HTML_Field
+	 */
+	public function createMaybeSerializedSimpleHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Maybe_Serialized_Simple_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Simple_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Maybe_Serialized_Text_Field
+	 */
+	public function createMaybeSerializedTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Maybe_Serialized_Text_Field {
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Money_Field
+	 */
+	public function createMoneyField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Money_Field {
+		return $this->loader->getNew(
+			'EE_Money_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Plain_Text_Field
+	 */
+	public function createPlainTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = true,
+		string $default_value = ''
+	): EE_Plain_Text_Field {
+		return $this->loader->getNew(
+			'EE_Plain_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Post_Content_Field
+	 */
+	public function createPostContentField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Post_Content_Field {
+		return $this->loader->getNew(
+			'EE_Post_Content_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_Int_Field
+	 */
+	public function createPrimaryKeyIntField(string $table_column, string $nice_name): EE_Primary_Key_Int_Field
+	{
+		return $this->loader->getNew('EE_Primary_Key_Int_Field', [$table_column, $nice_name]);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_String_Field
+	 */
+	public function createPrimaryKeyStringField(string $table_column, string $nice_name): EE_Primary_Key_String_Field
+	{
+		return $this->loader->getNew('EE_Primary_Key_String_Field', [$table_column, $nice_name]);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Serialized_Text_Field
+	 */
+	public function createSerializedTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Serialized_Text_Field {
+		return $this->loader->getNew(
+			'EE_Serialized_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Simple_HTML_Field
+	 */
+	public function createSimpleHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Simple_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Simple_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Slug_Field
+	 */
+	public function createSlugField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = false,
+		$default_value = null
+	): EE_Slug_Field {
+		return $this->loader->getNew(
+			'EE_Slug_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string     $table_column
+	 * @param string     $nice_name
+	 * @param bool       $nullable
+	 * @param mixed|null $default_value
+	 * @return EE_Trashed_Flag_Field
+	 */
+	public function createTrashedFlagField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Trashed_Flag_Field {
+		return $this->loader->getNew(
+			'EE_Trashed_Flag_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param mixed  $default_value
+	 * @param array $values     If additional statuses are to be used other than the default WP statuses,
+	 *                          then they can be registered via this property.
+	 *                          The format of the array should be as follows:
+	 *                          [
+	 *                              'status_reference' => [
+	 *                                  'label' => __('Status Reference Label', 'event_espresso'),
+	 *                                  // whether status is shown on the frontend of the site
+	 *                                  'public' => true,
+	 *                                  // whether status is excluded from wp searches
+	 *                                  'exclude_from_search' => false,
+	 *                                  // whether status is included in queries
+	 *                                  for the admin 'all' view in list table views.
+	 *                                  'show_in_admin_all_list' => true,
+	 *                                  // show in the list of statuses with post counts
+	 *                                  // at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                  'show_in_admin_status_list' => true,
+	 *                                  // the text to display on the admin screen
+	 *                                  // ( or you won't see your status count )
+	 *                                  'label_count' => _n_noop(
+	 *                                      'Status Reference <span class="count">(%s)</span>',
+	 *                                      'Status References <span class="count">(%s)</span>'
+	 *                                  ),
+	 *                              ]
+	 *                          ]
+	 * @return EE_WP_Post_Status_Field
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 */
+	public function createWpPostStatusField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		array $values = []
+	): EE_WP_Post_Status_Field {
+		return $this->loader->getNew(
+			'EE_WP_Post_Status_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $values]
+		);
+	}
+
+
+	/**
+	 * @param string $post_type
+	 * @return EE_WP_Post_Type_Field
+	 */
+	public function createWpPostTypeField(string $post_type): EE_WP_Post_Type_Field
+	{
+		return $this->loader->getNew('EE_WP_Post_Type_Field', [$post_type]);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @return EE_WP_User_Field
+	 */
+	public function createWpUserField(string $table_column, string $nice_name, bool $nullable): EE_WP_User_Field
+	{
+		return $this->loader->getNew('EE_WP_User_Field', [$table_column, $nice_name, $nullable]);
+	}
 }

core/services/bootstrap/BootstrapCore.php

Indentation +199 added lines, -199 removed lines

@@ -47,225 +47,225 @@
  */
 class BootstrapCore implements InterminableInterface
 {
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
-    /**
-     * @var RequestStackBuilder $request_stack_builder
-     */
-    protected $request_stack_builder;
+	/**
+	 * @var RequestStackBuilder $request_stack_builder
+	 */
+	protected $request_stack_builder;
 
-    /**
-     * @var RequestStack $request_stack
-     */
-    protected $request_stack;
+	/**
+	 * @var RequestStack $request_stack
+	 */
+	protected $request_stack;
 
 
-    /**
-     * BootstrapCore constructor.
-     */
-    public function __construct()
-    {
-        do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
-        // construct request stack and run middleware apps as soon as all WP plugins are loaded
-        add_action('plugins_loaded', array($this, 'initialize'), 0);
-    }
+	/**
+	 * BootstrapCore constructor.
+	 */
+	public function __construct()
+	{
+		do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
+		// construct request stack and run middleware apps as soon as all WP plugins are loaded
+		add_action('plugins_loaded', array($this, 'initialize'), 0);
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     * @throws InvalidRequestStackMiddlewareException
-     * @throws OutOfBoundsException
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->bootstrapDependencyInjectionContainer();
-        $this->bootstrapDomain();
-        $bootstrap_request = $this->bootstrapRequestResponseObjects();
-        add_action(
-            'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
-            array($bootstrap_request, 'setupLegacyRequest')
-        );
-        $this->runRequestStack();
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidRequestStackMiddlewareException
+	 * @throws OutOfBoundsException
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->bootstrapDependencyInjectionContainer();
+		$this->bootstrapDomain();
+		$bootstrap_request = $this->bootstrapRequestResponseObjects();
+		add_action(
+			'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
+			array($bootstrap_request, 'setupLegacyRequest')
+		);
+		$this->runRequestStack();
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws OutOfBoundsException
-     */
-    private function bootstrapDependencyInjectionContainer()
-    {
-        $bootstrap_di = new BootstrapDependencyInjectionContainer();
-        $bootstrap_di->buildLegacyDependencyInjectionContainer();
-        $bootstrap_di->buildLoader();
-        $registry = $bootstrap_di->getRegistry();
-        $dependency_map = $bootstrap_di->getDependencyMap();
-        $dependency_map->initialize();
-        $registry->initialize();
-        $this->loader = $bootstrap_di->getLoader();
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws OutOfBoundsException
+	 */
+	private function bootstrapDependencyInjectionContainer()
+	{
+		$bootstrap_di = new BootstrapDependencyInjectionContainer();
+		$bootstrap_di->buildLegacyDependencyInjectionContainer();
+		$bootstrap_di->buildLoader();
+		$registry = $bootstrap_di->getRegistry();
+		$dependency_map = $bootstrap_di->getDependencyMap();
+		$dependency_map->initialize();
+		$registry->initialize();
+		$this->loader = $bootstrap_di->getLoader();
+	}
 
 
-    /**
-     * configures the Domain object for core
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    private function bootstrapDomain()
-    {
-        DomainFactory::getEventEspressoCoreDomain();
-    }
+	/**
+	 * configures the Domain object for core
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	private function bootstrapDomain()
+	{
+		DomainFactory::getEventEspressoCoreDomain();
+	}
 
 
-    /**
-     * sets up the request and response objects
-     *
-     * @return BootstrapRequestResponseObjects
-     * @throws InvalidArgumentException
-     */
-    private function bootstrapRequestResponseObjects()
-    {
-        /** @var BootstrapRequestResponseObjects $bootstrap_request */
-        $bootstrap_request = $this->loader->getShared(
-            'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
-            array($this->loader)
-        );
-        $bootstrap_request->buildRequestResponse();
-        $bootstrap_request->shareRequestResponse();
-        $this->request = $this->loader->getShared('EventEspresso\core\services\request\Request');
-        $this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
-        return $bootstrap_request;
-    }
+	/**
+	 * sets up the request and response objects
+	 *
+	 * @return BootstrapRequestResponseObjects
+	 * @throws InvalidArgumentException
+	 */
+	private function bootstrapRequestResponseObjects()
+	{
+		/** @var BootstrapRequestResponseObjects $bootstrap_request */
+		$bootstrap_request = $this->loader->getShared(
+			'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
+			array($this->loader)
+		);
+		$bootstrap_request->buildRequestResponse();
+		$bootstrap_request->shareRequestResponse();
+		$this->request = $this->loader->getShared('EventEspresso\core\services\request\Request');
+		$this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
+		return $bootstrap_request;
+	}
 
 
-    /**
-     * run_request_stack
-     * construct request stack and run middleware apps
-     *
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function runRequestStack()
-    {
-        $this->loadAutoloader();
-        $this->setAutoloadersForRequiredFiles();
-        $this->request_stack_builder = $this->buildRequestStack();
-        $this->request_stack = $this->request_stack_builder->resolve(
-            new RequestStackCoreApp()
-        );
-        $this->request_stack->handleRequest($this->request, $this->response);
-        $this->request_stack->handleResponse();
-    }
+	/**
+	 * run_request_stack
+	 * construct request stack and run middleware apps
+	 *
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function runRequestStack()
+	{
+		$this->loadAutoloader();
+		$this->setAutoloadersForRequiredFiles();
+		$this->request_stack_builder = $this->buildRequestStack();
+		$this->request_stack = $this->request_stack_builder->resolve(
+			new RequestStackCoreApp()
+		);
+		$this->request_stack->handleRequest($this->request, $this->response);
+		$this->request_stack->handleResponse();
+	}
 
 
-    /**
-     * load_autoloader
-     *
-     * @throws EE_Error
-     */
-    protected function loadAutoloader()
-    {
-        // load interfaces
-        espresso_load_required(
-            'EEH_Autoloader',
-            EE_CORE . 'helpers/EEH_Autoloader.helper.php'
-        );
-        EEH_Autoloader::instance();
-    }
+	/**
+	 * load_autoloader
+	 *
+	 * @throws EE_Error
+	 */
+	protected function loadAutoloader()
+	{
+		// load interfaces
+		espresso_load_required(
+			'EEH_Autoloader',
+			EE_CORE . 'helpers/EEH_Autoloader.helper.php'
+		);
+		EEH_Autoloader::instance();
+	}
 
 
-    /**
-     * load_required_files
-     *
-     * @throws EE_Error
-     */
-    protected function setAutoloadersForRequiredFiles()
-    {
-        // load interfaces
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
-        // load helpers
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-        // register legacy request stack classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
-        // register legacy middleware classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
-    }
+	/**
+	 * load_required_files
+	 *
+	 * @throws EE_Error
+	 */
+	protected function setAutoloadersForRequiredFiles()
+	{
+		// load interfaces
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
+		// load helpers
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+		// register legacy request stack classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
+		// register legacy middleware classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
+	}
 
 
-    /**
-     * build_request_stack
-     *
-     * @return RequestStackBuilder
-     */
-    public function buildRequestStack()
-    {
-        $request_stack_builder = new RequestStackBuilder($this->loader);
-        /**
-         * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
-         * so items at the beginning of the final middleware stack will run last.
-         * First parameter is the middleware classname, second is an array of arguments
-         */
-        $stack_apps = apply_filters(
-            'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
-            array(
-                // first in last out
-                'EventEspresso\core\services\request\middleware\BotDetector'                 => array(),
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest'     => array(),
-                'EventEspresso\core\services\request\middleware\PreProductionVersionWarning' => array(),
-                'EventEspresso\core\services\request\middleware\RecommendedVersions'         => array(),
-                // last in first out
-                'EventEspresso\core\services\request\middleware\DetectLogin'                 => array(),
-            )
-        );
-        // legacy filter for backwards compatibility
-        $stack_apps = apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
-            $stack_apps
-        );
-        // load middleware onto stack : FILO (First In Last Out)
-        // items at the beginning of the $stack_apps array will run last
-        foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
-            $request_stack_builder->push(array($stack_app, $stack_app_args));
-        }
-        // finally, we'll add this on its own because we need it to always be part of the stack
-        // and we also need it to always run first because the rest of the system relies on it
-        $request_stack_builder->push(
-            array('EventEspresso\core\services\request\middleware\SetRequestTypeContextChecker', array())
-        );
-        return apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
-            $request_stack_builder
-        );
-    }
+	/**
+	 * build_request_stack
+	 *
+	 * @return RequestStackBuilder
+	 */
+	public function buildRequestStack()
+	{
+		$request_stack_builder = new RequestStackBuilder($this->loader);
+		/**
+		 * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
+		 * so items at the beginning of the final middleware stack will run last.
+		 * First parameter is the middleware classname, second is an array of arguments
+		 */
+		$stack_apps = apply_filters(
+			'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
+			array(
+				// first in last out
+				'EventEspresso\core\services\request\middleware\BotDetector'                 => array(),
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest'     => array(),
+				'EventEspresso\core\services\request\middleware\PreProductionVersionWarning' => array(),
+				'EventEspresso\core\services\request\middleware\RecommendedVersions'         => array(),
+				// last in first out
+				'EventEspresso\core\services\request\middleware\DetectLogin'                 => array(),
+			)
+		);
+		// legacy filter for backwards compatibility
+		$stack_apps = apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
+			$stack_apps
+		);
+		// load middleware onto stack : FILO (First In Last Out)
+		// items at the beginning of the $stack_apps array will run last
+		foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
+			$request_stack_builder->push(array($stack_app, $stack_app_args));
+		}
+		// finally, we'll add this on its own because we need it to always be part of the stack
+		// and we also need it to always run first because the rest of the system relies on it
+		$request_stack_builder->push(
+			array('EventEspresso\core\services\request\middleware\SetRequestTypeContextChecker', array())
+		);
+		return apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
+			$request_stack_builder
+		);
+	}
 }

core/services/commands/CommandHandlerInterface.php

Indentation +19 added lines, -19 removed lines

@@ -11,24 +11,24 @@
  */
 interface CommandHandlerInterface extends InterminableInterface
 {
-    /**
-     * verifies that the supplied command is the correct class for the handler.
-     *
-     * !!! IMPORTANT !!!
-     * Must return $this (ie: the handler itself)
-     * as the CommandBus utilizes method chaining
-     *
-     * @param CommandInterface $command
-     * @return CommandHandlerInterface
-     * @since 4.9.80.p
-     */
-    public function verify(CommandInterface $command): CommandHandlerInterface;
+	/**
+	 * verifies that the supplied command is the correct class for the handler.
+	 *
+	 * !!! IMPORTANT !!!
+	 * Must return $this (ie: the handler itself)
+	 * as the CommandBus utilizes method chaining
+	 *
+	 * @param CommandInterface $command
+	 * @return CommandHandlerInterface
+	 * @since 4.9.80.p
+	 */
+	public function verify(CommandInterface $command): CommandHandlerInterface;
 
-    /**
-     * Performs the command handler's logic.
-     *
-     * @param CommandInterface $command
-     * @return mixed
-     */
-    public function handle(CommandInterface $command);
+	/**
+	 * Performs the command handler's logic.
+	 *
+	 * @param CommandInterface $command
+	 * @return mixed
+	 */
+	public function handle(CommandInterface $command);
 }