eventespresso / event-espresso-core

public/Espresso_Arabica_2014/content-espresso_events-header.php

Spacing +2 added lines, -2 removed lines

@@ -5,9 +5,9 @@
 ?>
 <header class="event-header">
 	<?php echo "<{$tag}  id=\"event-details-{$tag}-{$post->ID}\" class=\"entry-title\">"; ?>
-		<a class="ee-event-header-lnk" href="<?php the_permalink(); ?>"<?php echo \EED_Events_Archive::link_target();?>>
+		<a class="ee-event-header-lnk" href="<?php the_permalink(); ?>"<?php echo \EED_Events_Archive::link_target(); ?>>
             <?php the_title(); ?>
         </a>
 	<?php echo "</{$tag}"; ?>
-	<?php if ( ! is_archive() && has_excerpt( $post->ID )): the_excerpt(); endif;?>
+	<?php if ( ! is_archive() && has_excerpt($post->ID)): the_excerpt(); endif; ?>
 </header>

core/domain/services/capabilities/CapCheck.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
 
 
     /**
-     * @param string|array $capability   - the capability to be checked, like: 'ee_edit_registrations',
+     * @param string $capability   - the capability to be checked, like: 'ee_edit_registrations',
      *                                   or an array of capability strings
      * @param string       $context      - what the user is attempting to do, like: 'Edit Registration'
      * @param int          $ID           - (optional) ID for item where current_user_can is being called from

Indentation +52 added lines, -52 removed lines

@@ -15,66 +15,66 @@
 class CapCheck implements CapCheckInterface
 {
 
-    /**
-     * @var string|array $capability
-     */
-    private $capability;
+	/**
+	 * @var string|array $capability
+	 */
+	private $capability;
 
-    /**
-     * @var string $context
-     */
-    private $context;
+	/**
+	 * @var string $context
+	 */
+	private $context;
 
-    /**
-     * @var int|string $ID
-     */
-    private $ID;
+	/**
+	 * @var int|string $ID
+	 */
+	private $ID;
 
 
-    /**
-     * @param string|array $capability   - the capability to be checked, like: 'ee_edit_registrations',
-     *                                   or an array of capability strings
-     * @param string       $context      - what the user is attempting to do, like: 'Edit Registration'
-     * @param int          $ID           - (optional) ID for item where current_user_can is being called from
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($capability, $context, $ID = 0)
-    {
-        if (! (is_string($capability) || is_array($capability))) {
-            throw new InvalidDataTypeException('$capability', $capability, 'string or array');
-        }
-        if (! is_string($context)) {
-            throw new InvalidDataTypeException('$context', $context, 'string');
-        }
-        $this->capability = $capability;
-        $this->context = strtolower(str_replace(' ', '_', $context));
-        $this->ID = $ID;
-    }
+	/**
+	 * @param string|array $capability   - the capability to be checked, like: 'ee_edit_registrations',
+	 *                                   or an array of capability strings
+	 * @param string       $context      - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int          $ID           - (optional) ID for item where current_user_can is being called from
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($capability, $context, $ID = 0)
+	{
+		if (! (is_string($capability) || is_array($capability))) {
+			throw new InvalidDataTypeException('$capability', $capability, 'string or array');
+		}
+		if (! is_string($context)) {
+			throw new InvalidDataTypeException('$context', $context, 'string');
+		}
+		$this->capability = $capability;
+		$this->context = strtolower(str_replace(' ', '_', $context));
+		$this->ID = $ID;
+	}
 
 
-    /**
-     * @return string|array
-     */
-    public function capability()
-    {
-        return $this->capability;
-    }
+	/**
+	 * @return string|array
+	 */
+	public function capability()
+	{
+		return $this->capability;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function context()
-    {
-        return $this->context;
-    }
+	/**
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->context;
+	}
 
 
-    /**
-     * @return int|string
-     */
-    public function ID()
-    {
-        return $this->ID;
-    }
+	/**
+	 * @return int|string
+	 */
+	public function ID()
+	{
+		return $this->ID;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -40,10 +40,10 @@
      */
     public function __construct($capability, $context, $ID = 0)
     {
-        if (! (is_string($capability) || is_array($capability))) {
+        if ( ! (is_string($capability) || is_array($capability))) {
             throw new InvalidDataTypeException('$capability', $capability, 'string or array');
         }
-        if (! is_string($context)) {
+        if ( ! is_string($context)) {
             throw new InvalidDataTypeException('$context', $context, 'string');
         }
         $this->capability = $capability;

core/db_models/fields/EE_Primary_Key_String_Field.php

Doc Comments +3 added lines

@@ -4,6 +4,9 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
+    /**
+     * @param string $table_column
+     */
     public function __construct($table_column, $nicename)
     {
         parent::__construct($table_column, $nicename, null);

Indentation +17 added lines, -17 removed lines

@@ -3,22 +3,22 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags($value_inputted_for_field_on_model_object);
+	}
 }

public/Espresso_Arabica_2014/single-espresso_events.php

Spacing +4 added lines, -4 removed lines

@@ -19,11 +19,11 @@ 
 				<div id="espresso-event-details-dv" class="" >
 			<?php
 				// Start the Loop.
-				while ( have_posts() ) : the_post();
+				while (have_posts()) : the_post();
 					//  Include the post TYPE-specific template for the content.
-					espresso_get_template_part( 'content', 'espresso_events' );
+					espresso_get_template_part('content', 'espresso_events');
 					// If comments are open or we have at least one comment, load up the comment template.
-					if ( comments_open() || get_comments_number() ) {
+					if (comments_open() || get_comments_number()) {
 						comments_template();
 					}
 				endwhile;
@@ -35,6 +35,6 @@ 
 	</div><!-- #primary -->
 
 <?php
-get_sidebar( 'content' );
+get_sidebar('content');
 get_sidebar();
 get_footer();
\ No newline at end of file

admin_pages/registration_form/help_tabs/registration_form_edit_question.help_tab.php

Spacing +2 added lines, -2 removed lines

@@ -30,8 +30,8 @@
 <?php _e('This shows the type of question. Available options are Text, Textarea, Checkboxes, Radio Buttons, Dropdown, State/Province Dropdown, Country Dropdown, Date Picker, and HTML Textarea (allowed tags: a, abbr, acronym, b, br, blockquote ,cite, code, del ,em, i, li, ol, p, q, s, strike, strong, ul).', 'event_espresso'); ?>
 </li>
 <li>
-<strong><?php _e('Answer Options (for applicable question types)', 'event_espresso');?></strong>
-<strong><?php _e('Values do not allow any HTML, however, descriptions do allow HTML.', 'event_espresso');?></strong>
+<strong><?php _e('Answer Options (for applicable question types)', 'event_espresso'); ?></strong>
+<strong><?php _e('Values do not allow any HTML, however, descriptions do allow HTML.', 'event_espresso'); ?></strong>
 </li>
 <li>
 <strong><?php _e('Required Question', 'event_espresso'); ?></strong><br />

admin_pages/payments/Payments_Admin_Page.core.php

Doc Comments +4 added lines, -4 removed lines

@@ -470,7 +470,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _pci_dss_compliance(EE_Payment_Method $payment_method)
     {
@@ -506,7 +506,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
@@ -541,7 +541,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_HTML
+     * @return EE_Payment_Method_Form
      */
     protected function _payment_method_settings(EE_Payment_Method $payment_method)
     {
@@ -615,7 +615,7 @@ 
      *
      * @access protected
      * @param \EE_Payment_Method $payment_method
-     * @return \EE_Form_Section_Proper
+     * @return EE_Form_Section_HTML
      */
     protected function _deactivate_payment_method_button(EE_Payment_Method $payment_method)
     {

Indentation +1060 added lines, -1060 removed lines

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

Spacing +40 added lines, -40 removed lines

@@ -168,7 +168,7 @@ 
         $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(
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
                 $payment_method_type->cap_name(),
                 'specific_payment_method_type_access'
             )
@@ -178,10 +178,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' . DS . $config['filename'] . '.help_tab.php',
+                        $payment_method_type->file_folder().'help_tabs'.DS.$config['filename'].'.help_tab.php',
                         $template_args,
                         true
                     ),
@@ -224,7 +224,7 @@ 
         wp_enqueue_script('ee-text-links');
         wp_enqueue_script(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'espresso_payments_admin.js',
+            EE_PAYMENTS_ASSETS_URL.'espresso_payments_admin.js',
             array('espresso-ui-theme', 'ee-datepicker'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -237,7 +237,7 @@ 
         // styles
         wp_register_style(
             'espresso_payments',
-            EE_PAYMENTS_ASSETS_URL . 'ee-payments.css',
+            EE_PAYMENTS_ASSETS_URL.'ee-payments.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -266,7 +266,7 @@ 
                 continue;
             }
             // check access
-            if (! EE_Registry::instance()->CAP->current_user_can(
+            if ( ! EE_Registry::instance()->CAP->current_user_can(
                 $pmt_obj->cap_name(),
                 'specific_payment_method_type_access'
             )
@@ -275,7 +275,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()),
@@ -285,7 +285,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',
@@ -295,7 +295,7 @@ 
             if ($payment_method instanceof EE_Payment_Method) {
                 add_meta_box(
                     // html id
-                    'espresso_' . $payment_method->slug() . '_payment_settings',
+                    'espresso_'.$payment_method->slug().'_payment_settings',
                     // title
                     sprintf(__('%s Settings', 'event_espresso'), $payment_method->admin_name()),
                     // callback
@@ -310,10 +310,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' => __('Modify this Payment Method', 'event_espresso'),
                     'slug'  => $payment_method->slug(),
                 );
@@ -344,7 +344,7 @@ 
         }
         $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
@@ -393,7 +393,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(
                 sprintf(
                     __(
@@ -410,7 +410,7 @@ 
             if ($form->form_data_present_in($this->_req_data)) {
                 $form->receive_form_submission($this->_req_data);
             }
-            echo $form->form_open() . $form->get_html_and_js() . $form->form_close();
+            echo $form->form_open().$form->get_html_and_js().$form->form_close();
         } else {
             echo $this->_activate_payment_method_button($payment_method)->get_html_and_js();
         }
@@ -426,13 +426,13 @@ 
      */
     protected function _generate_payment_method_settings_form(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             return new EE_Form_Section_Proper();
         }
         return new EE_Form_Section_Proper(
             array(
-                'name'            => $payment_method->slug() . '_settings_form',
-                'html_id'         => $payment_method->slug() . '_settings_form',
+                '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',
@@ -474,7 +474,7 @@ 
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             __(
@@ -508,14 +508,14 @@ 
      */
     protected function _currency_support(EE_Payment_Method $payment_method)
     {
-        if (! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
+        if ( ! $payment_method->usable_for_currency(EE_Config::instance()->currency->code)) {
             return new EE_Form_Section_HTML(
                 EEH_HTML::tr(
                     EEH_HTML::th(
                         EEH_HTML::label(
                             EEH_HTML::strong(__('IMPORTANT', 'event_espresso'), '', 'important-notice')
                         )
-                    ) .
+                    ).
                     EEH_HTML::td(
                         EEH_HTML::strong(
                             sprintf(
@@ -595,7 +595,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(
                     __('Update %s Payment Settings', 'event_espresso'),
                     $payment_method->admin_name()
@@ -604,9 +604,9 @@ 
             )
         );
         return new EE_Form_Section_HTML(
-            EEH_HTML::no_row(EEH_HTML::br(2)) .
+            EEH_HTML::no_row(EEH_HTML::br(2)).
             EEH_HTML::tr(
-                EEH_HTML::th(__('Update Settings', 'event_espresso')) .
+                EEH_HTML::th(__('Update Settings', 'event_espresso')).
                 EEH_HTML::td(
                     $update_button->get_html_for_input()
                 )
@@ -630,7 +630,7 @@ 
         );
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')) .
+                EEH_HTML::th(__('Deactivate Payment Method', 'event_espresso')).
                 EEH_HTML::td(
                     EEH_HTML::link(
                         EE_Admin_Page::add_query_args_and_nonce(
@@ -642,7 +642,7 @@ 
                         ),
                         $link_text_and_title,
                         $link_text_and_title,
-                        'deactivate_' . $payment_method->slug(),
+                        'deactivate_'.$payment_method->slug(),
                         'espresso-button button-secondary'
                     )
                 )
@@ -666,8 +666,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(
@@ -682,11 +682,11 @@ 
                                     '',
                                     'colspan="2"'
                                 )
-                            ) .
+                            ).
                             EEH_HTML::tr(
                                 EEH_HTML::th(
                                     EEH_HTML::label(__('Click to Activate ', 'event_espresso'))
-                                ) .
+                                ).
                                 EEH_HTML::td(
                                     EEH_HTML::link(
                                         EE_Admin_Page::add_query_args_and_nonce(
@@ -698,7 +698,7 @@ 
                                         ),
                                         $link_text_and_title,
                                         $link_text_and_title,
-                                        'activate_' . $payment_method->slug(),
+                                        'activate_'.$payment_method->slug(),
                                         'espresso-button-green button-primary'
                                     )
                                 )
@@ -722,7 +722,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_HTML::tr(
-                EEH_HTML::th() .
+                EEH_HTML::th().
                 EEH_HTML::td(
                     EEH_HTML::p(__('All fields marked with a * are required fields', 'event_espresso'), '', 'grey-text')
                 )
@@ -805,7 +805,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(
                     __(
                         "We could not find which payment method type your form submission related to. Please contact support",
@@ -820,7 +820,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(
                             __(
@@ -948,7 +948,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;
@@ -968,8 +968,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);
@@ -1002,15 +1002,15 @@ 
             $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()));
-            echo "<h1>Payment Logs for " . site_url() . "</h1>";
+            header("Content-Disposition: attachment; filename=ee_payment_logs_for_".sanitize_key(site_url()));
+            echo "<h1>Payment Logs for ".site_url()."</h1>";
             echo "<h3>Query:</h3>";
             var_dump($query_params);
             echo "<h3>Results:</h3>";
@@ -1062,7 +1062,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/libraries/form_sections/base/EE_Model_Form_Section.form.php

Doc Comments +1 added lines

@@ -372,6 +372,7 @@
      * save the relations indicated
      *
      * @type string $relation_name
+     * @param integer $relation_name
      * @return bool
      * @throws EE_Error
      */

Indentation +455 added lines, -455 removed lines

@@ -14,459 +14,459 @@
 class EE_Model_Form_Section extends EE_Form_Section_Proper
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    /**
-     * @var EE_Base_Class
-     */
-    protected $_model_object = null;
-
-
-
-    /**
-     * @param array        $options_array   keys: {
-     * @type EEM_Base      $model
-     * @type EE_Base_Class $model_object
-     * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
-     *       values are the arrays as you would pass them to that subsection
-     *                                      }
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
-            $this->_model = $options_array['model'];
-        }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(sprintf(__(
-                "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
-                "event_espresso"
-            )));
-        }
-        if (isset($options_array['subsection_args'])) {
-            $subsection_args = $options_array['subsection_args'];
-        } else {
-            $subsection_args = array();
-        }
-        // gather fields and relations to convert to inputs
-        // but if they're just going to exclude a field anyways, don't bother converting it to an input
-        $exclude = $this->_subsections;
-        if (isset($options_array['exclude'])) {
-            $exclude = array_merge($exclude, array_flip($options_array['exclude']));
-        }
-        $model_fields = array_diff_key($this->_model->field_settings(), $exclude);
-        $model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
-        // convert fields and relations to inputs
-        $this->_subsections = array_merge(
-            $this->_convert_model_fields_to_inputs($model_fields),
-            $this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
-            $this->_subsections
-        );
-        parent::__construct($options_array);
-        if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
-            $this->populate_model_obj($options_array['model_object']);
-        }
-    }
-
-
-
-    /**
-     * For now, just makes inputs for only HABTM relations
-     *
-     * @param EE_Model_Relation_Base[] $relations
-     * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
-     *                                                  their values are {
-     * @type array {
-     * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
-     *                                                  }
-     *                                                  }
-     * @return array
-     */
-    protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
-    {
-        $inputs = array();
-        foreach ($relations as $relation_name => $relation_obj) {
-            $input_constructor_args = array(
-                array_merge(
-                    array(
-                        'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
-                        'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
-                            ? $relation_obj->get_other_model()->item_name(1)
-                            : $relation_obj->get_other_model()
-                                           ->item_name(2),
-                    ),
-                    $subsection_args
-                ),
-            );
-            $input = null;
-            switch (get_class($relation_obj)) {
-                case 'EE_HABTM_Relation':
-                    if (isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
-                    ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
-                    } else {
-                        $model_objects = $relation_obj->get_other_model()->get_all();
-                    }
-                    $input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
-                    break;
-                default:
-            }
-            if ($input) {
-                $inputs[ $relation_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Changes model fields into form section inputs
-     *
-     * @param EE_Model_Field_Base[] $model_fields keys are the model's name
-     * @throws EE_Error
-     * @return EE_Form_Input_Base[]
-     */
-    protected function _convert_model_fields_to_inputs($model_fields = array())
-    {
-        $inputs = array();
-        foreach ($model_fields as $field_name => $model_field) {
-            if ($model_field instanceof EE_Model_Field_Base) {
-                $input_constructor_args = array(
-                    array(
-                        'required'        => ! $model_field->is_nullable()
-                                             && $model_field->get_default_value()
-                                                === null,
-                        'html_label_text' => $model_field->get_nicename(),
-                        'default'         => $model_field->get_default_value(),
-                    ),
-                );
-                switch (get_class($model_field)) {
-                    case 'EE_All_Caps_Text_Field':
-                    case 'EE_Any_Foreign_Model_Name_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Boolean_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_Datetime_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Email_Field':
-                        $input_class = 'EE_Email_Input';
-                        break;
-                    case 'EE_Enum_Integer_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Enum_Text_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Float_Field':
-                        $input_class = 'EE_Float_Input';
-                        break;
-                    case 'EE_Foreign_Key_Int_Field':
-                    case 'EE_Foreign_Key_String_Field':
-                    case 'EE_WP_User_Field':
-                        $models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
-                            ? $model_field->get_model_class_names_pointed_to() : array();
-                        if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
-                            $input_class = 'EE_Text_Input';
-                        } else {
-                            // so its just one model
-                            $model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
-                            $model = EE_Registry::instance()->load_model($model_name);
-                            $model_names = $model->get_all_names(array('limit' => 10));
-                            if ($model_field->is_nullable()) {
-                                array_unshift($model_names, __("Please Select", 'event_espresso'));
-                            }
-                            $input_constructor_args[1] = $input_constructor_args[0];
-                            $input_constructor_args[0] = $model_names;
-                            $input_class = 'EE_Select_Input';
-                        }
-                        break;
-                    case 'EE_Full_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Infinite_Integer':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Integer_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Maybe_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Money_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_Post_Content_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Plain_Text_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Primary_Key_Int_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        $input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
-                        break;
-                    case 'EE_Primary_Key_String_Field':
-                        $input_class = 'EE_Hidden_Input';
-                        break;
-                    case 'EE_Serialized_Text_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        break;
-                    case 'EE_Simple_HTML_Field':
-                        $input_class = 'EE_Text_Area_Input';
-                        $input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
-                        break;
-                    case 'EE_Slug_Field':
-                        $input_class = 'EE_Text_Input';
-                        break;
-                    case 'EE_Trashed_Flag_Field':
-                        $input_class = 'EE_Yes_No_Input';
-                        break;
-                    case 'EE_WP_Post_Status_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    case 'EE_WP_Post_Type_Field':
-                        throw new EE_Error(sprintf(__(
-                            "Model field '%s' does not yet have a known conversion to form input",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                        break;
-                    default:
-                        throw new EE_Error(sprintf(__(
-                            "Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
-                            "event_espresso"
-                        ), get_class($model_field)));
-                }
-                $reflection = new ReflectionClass($input_class);
-                $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Mostly the same as populate_defaults , except takes a model object as input, not an array,
-     * and also sets the form's _model_object
-     *
-     * @param EE_Base_Class $model_obj
-     * @return void
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        $this->_model_object = $model_obj;
-        $defaults = $model_obj->model_field_array();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            $subsection = $this->get_subsection($relation_name, false);
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    // then we only expect there to be one
-                    $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
-                } else {
-                    $related_items = $this->_model_object->get_many_related($relation_name);
-                    $ids = array();
-                    foreach ($related_items as $related_item) {
-                        $ids[] = $related_item->ID();
-                    }
-                    $defaults[ $relation_name ] = $ids;
-                }
-            }
-        }
-        $defaults = apply_filters(
-            'FHEE__EE_Model_Form_Section__populate_model_obj',
-            $defaults,
-            $this
-        );
-        $this->populate_defaults($defaults);
-    }
-
-
-
-    /**
-     * Gets all the input values that correspond to model fields. Keys are the input/field names,
-     * values are their normalized values
-     *
-     * @return array
-     */
-    public function inputs_values_corresponding_to_model_fields()
-    {
-        return array_intersect_key($this->input_values(), $this->_model->field_settings());
-    }
-
-
-
-    /**
-     * After we've normalized the data as normal, set the corresponding model object
-     * on the form.
-     *
-     * @param array $req_data should usually be $_REQUEST (the default).
-     * @return void
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
-            // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
-            $pk_name = $this->_model->primary_key_name();
-            $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-            if ($model_obj) {
-                $this->_model_object = $model_obj;
-            } else {
-                $this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
-            }
-        }
-    }
-
-
-
-    /**
-     * After this form has been initialized and is verified to be valid,
-     * either creates a model object from its data and saves it, or updates
-     * the model object its data represents
-     *
-     * @throws EE_Error
-     * @return int, 1 on a successful update, the ID of
-     *                    the new entry on insert; 0 on failure
-     */
-    public function save()
-    {
-        if (! $this->_model_object) {
-            throw new EE_Error(sprintf(__(
-                "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
-                "event_espresso"
-            ), get_class($this->_model)));
-        }
-        // ok so the model object is set. Just set it with the submitted form data
-        foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
-            // only set the non-primary key
-            if ($field_name != $this->_model->primary_key_name()) {
-                $this->_model_object->set($field_name, $field_value);
-            }
-        }
-        $success = $this->_model_object->save();
-        foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
-                $success = $this->_save_related_info($relation_name);
-            }
-        }
-        do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
-        return $success;
-    }
-
-
-
-    /**
-     * Automatically finds the related model info from the form, if present, and
-     * save the relations indicated
-     *
-     * @type string $relation_name
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _save_related_info($relation_name)
-    {
-        $relation_obj = $this->_model->related_settings_for($relation_name);
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            // there is just a foreign key on this model pointing to that one
-            $this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-        } elseif ($relation_obj instanceof EE_Has_Many_Relation) {
-            // then we want to consider all of its currently-related things.
-            // if they're in this list, keep them
-            // if they're not in this list, remove them
-            // and lastly add all the new items
-            throw new EE_Error(sprintf(__(
-                'Automatic saving of related info across a "has many" relation is not yet supported',
-                "event_espresso"
-            )));
-        } elseif ($relation_obj instanceof EE_HABTM_Relation) {
-            // delete everything NOT in this list
-            $normalized_input_value = $this->get_input_value($relation_name);
-            if ($normalized_input_value && is_array($normalized_input_value)) {
-                $where_query_params = array(
-                    $relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
-                );
-            } else {
-                $where_query_params = array();
-            }
-            $this->_model_object->_remove_relations($relation_name, $where_query_params);
-            foreach ($normalized_input_value as $id) {
-                $this->_model_object->_add_relation_to($id, $relation_name);
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the model of this model form
-     *
-     * @return EEM_Base
-     */
-    public function get_model()
-    {
-        return $this->_model;
-    }
-
-
-
-    /**
-     * Gets the model object for this model form, which was either set
-     * upon construction (using the $options_array arg 'model_object'), by using
-     * set_model_object($model_obj), or implicitly
-     * when receive_form_submission($req_data) was called.
-     *
-     * @return EE_Base_Class
-     */
-    public function get_model_object()
-    {
-        return $this->_model_object;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	/**
+	 * @var EE_Base_Class
+	 */
+	protected $_model_object = null;
+
+
+
+	/**
+	 * @param array        $options_array   keys: {
+	 * @type EEM_Base      $model
+	 * @type EE_Base_Class $model_object
+	 * @type array         $subsection_args array keys should be subsection names (that either do or will exist), and
+	 *       values are the arrays as you would pass them to that subsection
+	 *                                      }
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
+			$this->_model = $options_array['model'];
+		}
+		if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(__(
+				"Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
+				"event_espresso"
+			)));
+		}
+		if (isset($options_array['subsection_args'])) {
+			$subsection_args = $options_array['subsection_args'];
+		} else {
+			$subsection_args = array();
+		}
+		// gather fields and relations to convert to inputs
+		// but if they're just going to exclude a field anyways, don't bother converting it to an input
+		$exclude = $this->_subsections;
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
+		}
+		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
+		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
+		// convert fields and relations to inputs
+		$this->_subsections = array_merge(
+			$this->_convert_model_fields_to_inputs($model_fields),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
+			$this->_subsections
+		);
+		parent::__construct($options_array);
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
+			$this->populate_model_obj($options_array['model_object']);
+		}
+	}
+
+
+
+	/**
+	 * For now, just makes inputs for only HABTM relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations
+	 * @param array                    $subsection_args keys should be existing or soon-to-be-existing input names, and
+	 *                                                  their values are {
+	 * @type array {
+	 * @type EE_Base_Class[]           $model_objects   if the subsection is an EE_Select_Multi_Model_Input
+	 *                                                  }
+	 *                                                  }
+	 * @return array
+	 */
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array())
+	{
+		$inputs = array();
+		foreach ($relations as $relation_name => $relation_obj) {
+			$input_constructor_args = array(
+				array_merge(
+					array(
+						'required'        => $relation_obj instanceof EE_Belongs_To_Relation,
+						'html_label_text' => $relation_obj instanceof EE_Belongs_To_Relation
+							? $relation_obj->get_other_model()->item_name(1)
+							: $relation_obj->get_other_model()
+										   ->item_name(2),
+					),
+					$subsection_args
+				),
+			);
+			$input = null;
+			switch (get_class($relation_obj)) {
+				case 'EE_HABTM_Relation':
+					if (isset($subsection_args[ $relation_name ])
+						&& isset($subsection_args[ $relation_name ]['model_objects'])
+					) {
+						$model_objects = $subsection_args[ $relation_name ]['model_objects'];
+					} else {
+						$model_objects = $relation_obj->get_other_model()->get_all();
+					}
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
+					break;
+				default:
+			}
+			if ($input) {
+				$inputs[ $relation_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Changes model fields into form section inputs
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields keys are the model's name
+	 * @throws EE_Error
+	 * @return EE_Form_Input_Base[]
+	 */
+	protected function _convert_model_fields_to_inputs($model_fields = array())
+	{
+		$inputs = array();
+		foreach ($model_fields as $field_name => $model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
+				$input_constructor_args = array(
+					array(
+						'required'        => ! $model_field->is_nullable()
+											 && $model_field->get_default_value()
+												=== null,
+						'html_label_text' => $model_field->get_nicename(),
+						'default'         => $model_field->get_default_value(),
+					),
+				);
+				switch (get_class($model_field)) {
+					case 'EE_All_Caps_Text_Field':
+					case 'EE_Any_Foreign_Model_Name_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Boolean_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_Datetime_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Email_Field':
+						$input_class = 'EE_Email_Input';
+						break;
+					case 'EE_Enum_Integer_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Enum_Text_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Float_Field':
+						$input_class = 'EE_Float_Input';
+						break;
+					case 'EE_Foreign_Key_Int_Field':
+					case 'EE_Foreign_Key_String_Field':
+					case 'EE_WP_User_Field':
+						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name
+							? $model_field->get_model_class_names_pointed_to() : array();
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
+							$input_class = 'EE_Text_Input';
+						} else {
+							// so its just one model
+							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
+							$model = EE_Registry::instance()->load_model($model_name);
+							$model_names = $model->get_all_names(array('limit' => 10));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, __("Please Select", 'event_espresso'));
+							}
+							$input_constructor_args[1] = $input_constructor_args[0];
+							$input_constructor_args[0] = $model_names;
+							$input_class = 'EE_Select_Input';
+						}
+						break;
+					case 'EE_Full_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Infinite_Integer':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Integer_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Maybe_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Money_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_Post_Content_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
+						break;
+					case 'EE_Plain_Text_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Primary_Key_Int_Field':
+						$input_class = 'EE_Hidden_Input';
+						$input_constructor_args['normalization_strategy'] = new EE_Int_Normalization();
+						break;
+					case 'EE_Primary_Key_String_Field':
+						$input_class = 'EE_Hidden_Input';
+						break;
+					case 'EE_Serialized_Text_Field':
+						$input_class = 'EE_Text_Area_Input';
+						break;
+					case 'EE_Simple_HTML_Field':
+						$input_class = 'EE_Text_Area_Input';
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
+						break;
+					case 'EE_Slug_Field':
+						$input_class = 'EE_Text_Input';
+						break;
+					case 'EE_Trashed_Flag_Field':
+						$input_class = 'EE_Yes_No_Input';
+						break;
+					case 'EE_WP_Post_Status_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					case 'EE_WP_Post_Type_Field':
+						throw new EE_Error(sprintf(__(
+							"Model field '%s' does not yet have a known conversion to form input",
+							"event_espresso"
+						), get_class($model_field)));
+						break;
+					default:
+						throw new EE_Error(sprintf(__(
+							"Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement",
+							"event_espresso"
+						), get_class($model_field)));
+				}
+				$reflection = new ReflectionClass($input_class);
+				$input = $reflection->newInstanceArgs($input_constructor_args);
+				$inputs[ $field_name ] = $input;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Mostly the same as populate_defaults , except takes a model object as input, not an array,
+	 * and also sets the form's _model_object
+	 *
+	 * @param EE_Base_Class $model_obj
+	 * @return void
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		$this->_model_object = $model_obj;
+		$defaults = $model_obj->model_field_array();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			$subsection = $this->get_subsection($relation_name, false);
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					// then we only expect there to be one
+					$related_item = $this->_model_object->get_first_related($relation_name);
+					$defaults[ $relation_name ] = $related_item->ID();
+				} else {
+					$related_items = $this->_model_object->get_many_related($relation_name);
+					$ids = array();
+					foreach ($related_items as $related_item) {
+						$ids[] = $related_item->ID();
+					}
+					$defaults[ $relation_name ] = $ids;
+				}
+			}
+		}
+		$defaults = apply_filters(
+			'FHEE__EE_Model_Form_Section__populate_model_obj',
+			$defaults,
+			$this
+		);
+		$this->populate_defaults($defaults);
+	}
+
+
+
+	/**
+	 * Gets all the input values that correspond to model fields. Keys are the input/field names,
+	 * values are their normalized values
+	 *
+	 * @return array
+	 */
+	public function inputs_values_corresponding_to_model_fields()
+	{
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
+	}
+
+
+
+	/**
+	 * After we've normalized the data as normal, set the corresponding model object
+	 * on the form.
+	 *
+	 * @param array $req_data should usually be $_REQUEST (the default).
+	 * @return void
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		// create or set the model object, if it isn't already
+		if (! $this->_model_object) {
+			// check to see if the form indicates a PK, in which case we want to only retrieve it and update it
+			$pk_name = $this->_model->primary_key_name();
+			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
+			if ($model_obj) {
+				$this->_model_object = $model_obj;
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
+			}
+		}
+	}
+
+
+
+	/**
+	 * After this form has been initialized and is verified to be valid,
+	 * either creates a model object from its data and saves it, or updates
+	 * the model object its data represents
+	 *
+	 * @throws EE_Error
+	 * @return int, 1 on a successful update, the ID of
+	 *                    the new entry on insert; 0 on failure
+	 */
+	public function save()
+	{
+		if (! $this->_model_object) {
+			throw new EE_Error(sprintf(__(
+				"Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
+				"event_espresso"
+			), get_class($this->_model)));
+		}
+		// ok so the model object is set. Just set it with the submitted form data
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name => $field_value) {
+			// only set the non-primary key
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
+			}
+		}
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[ $relation_name ])) {
+				$success = $this->_save_related_info($relation_name);
+			}
+		}
+		do_action('AHEE__EE_Model_Form_Section__save__done', $this, $success);
+		return $success;
+	}
+
+
+
+	/**
+	 * Automatically finds the related model info from the form, if present, and
+	 * save the relations indicated
+	 *
+	 * @type string $relation_name
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _save_related_info($relation_name)
+	{
+		$relation_obj = $this->_model->related_settings_for($relation_name);
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			// there is just a foreign key on this model pointing to that one
+			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
+		} elseif ($relation_obj instanceof EE_Has_Many_Relation) {
+			// then we want to consider all of its currently-related things.
+			// if they're in this list, keep them
+			// if they're not in this list, remove them
+			// and lastly add all the new items
+			throw new EE_Error(sprintf(__(
+				'Automatic saving of related info across a "has many" relation is not yet supported',
+				"event_espresso"
+			)));
+		} elseif ($relation_obj instanceof EE_HABTM_Relation) {
+			// delete everything NOT in this list
+			$normalized_input_value = $this->get_input_value($relation_name);
+			if ($normalized_input_value && is_array($normalized_input_value)) {
+				$where_query_params = array(
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value),
+				);
+			} else {
+				$where_query_params = array();
+			}
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the model of this model form
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_model()
+	{
+		return $this->_model;
+	}
+
+
+
+	/**
+	 * Gets the model object for this model form, which was either set
+	 * upon construction (using the $options_array arg 'model_object'), by using
+	 * set_model_object($model_obj), or implicitly
+	 * when receive_form_submission($req_data) was called.
+	 *
+	 * @return EE_Base_Class
+	 */
+	public function get_model_object()
+	{
+		return $this->_model_object;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -40,7 +40,7 @@ 
         if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
             $this->_model = $options_array['model'];
         }
-        if (! $this->_model || ! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model || ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(sprintf(__(
                 "Model Form Sections must first specify the _model property to be a subclass of EEM_Base",
                 "event_espresso"
@@ -104,10 +104,10 @@ 
             $input = null;
             switch (get_class($relation_obj)) {
                 case 'EE_HABTM_Relation':
-                    if (isset($subsection_args[ $relation_name ])
-                        && isset($subsection_args[ $relation_name ]['model_objects'])
+                    if (isset($subsection_args[$relation_name])
+                        && isset($subsection_args[$relation_name]['model_objects'])
                     ) {
-                        $model_objects = $subsection_args[ $relation_name ]['model_objects'];
+                        $model_objects = $subsection_args[$relation_name]['model_objects'];
                     } else {
                         $model_objects = $relation_obj->get_other_model()->get_all();
                     }
@@ -116,7 +116,7 @@ 
                 default:
             }
             if ($input) {
-                $inputs[ $relation_name ] = $input;
+                $inputs[$relation_name] = $input;
             }
         }
         return $inputs;
@@ -266,7 +266,7 @@ 
                 }
                 $reflection = new ReflectionClass($input_class);
                 $input = $reflection->newInstanceArgs($input_constructor_args);
-                $inputs[ $field_name ] = $input;
+                $inputs[$field_name] = $input;
             }
         }
         return $inputs;
@@ -292,14 +292,14 @@ 
                 if ($relation_obj instanceof EE_Belongs_To_Relation) {
                     // then we only expect there to be one
                     $related_item = $this->_model_object->get_first_related($relation_name);
-                    $defaults[ $relation_name ] = $related_item->ID();
+                    $defaults[$relation_name] = $related_item->ID();
                 } else {
                     $related_items = $this->_model_object->get_many_related($relation_name);
                     $ids = array();
                     foreach ($related_items as $related_item) {
                         $ids[] = $related_item->ID();
                     }
-                    $defaults[ $relation_name ] = $ids;
+                    $defaults[$relation_name] = $ids;
                 }
             }
         }
@@ -337,7 +337,7 @@ 
     {
         parent::_normalize($req_data);
         // create or set the model object, if it isn't already
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             // check to see if the form indicates a PK, in which case we want to only retrieve it and update it
             $pk_name = $this->_model->primary_key_name();
             $model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
@@ -362,7 +362,7 @@ 
      */
     public function save()
     {
-        if (! $this->_model_object) {
+        if ( ! $this->_model_object) {
             throw new EE_Error(sprintf(__(
                 "Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically",
                 "event_espresso"
@@ -377,7 +377,7 @@ 
         }
         $success = $this->_model_object->save();
         foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
-            if (isset($this->_subsections[ $relation_name ])) {
+            if (isset($this->_subsections[$relation_name])) {
                 $success = $this->_save_related_info($relation_name);
             }
         }
@@ -464,8 +464,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }

core/libraries/form_sections/payment_methods/EE_Payment_Method_Form.form.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
 
 
     /**
-     * @param $payment_method_type
+     * @param EE_PMT_Base $payment_method_type
      * @throws EE_Error
      */
     public function set_payment_method_type($payment_method_type)

Indentation +191 added lines, -191 removed lines

@@ -9,195 +9,195 @@
 class EE_Payment_Method_Form extends EE_Model_Form_Section
 {
 
-    /**
-     * All the subsection inputs that correspond ot extra meta rows
-     * for this payment method
-     *
-     * @var EE_Form_Input_Base[]
-     */
-    protected $_extra_meta_inputs = array();
-
-    /**
-     * Because payment method form might DELAY part of construction, we want to remember
-     * what options were passed in
-     *
-     * @var array
-     */
-    protected $_options_array = array();
-
-    /**
-     * The payment method type for this form
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_payment_method_type;
-
-
-
-    /**
-     * @param array      $options_array       {
-     * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
-     *                                        will be _subsections and will be saved as extra meta on the payment
-     *                                        method object;
-     * @type EE_PMT_Base $payment_method_type the payment method type this form is for
-     * @see EE_Model_Form_Section::__construct() for more
-     *                                        }
-     */
-    public function __construct($options_array = array())
-    {
-        $this->_model = EEM_Payment_Method::instance();
-        $this->_options_array = $options_array;
-        if (isset($options_array['payment_method_type'])) {
-            $this->_payment_method_type = $options_array['payment_method_type'];
-        }
-        $options_array = $this->_options_array;
-        if (isset($options_array['extra_meta_inputs'])) {
-            $this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
-        }
-        if ($this->_extra_meta_inputs) {
-            $this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
-        }
-        $this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
-            array('html_label_text' => __('Button URL', 'event_espresso'))
-        );
-        $this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
-            EEM_Payment_Method::instance()->scopes(),
-            array(
-                'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
-                                     . EEH_Template::get_help_tab_link('payment_methods_overview'),
-            )
-        );
-        // setup the currency options
-        $this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
-            EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
-            array(
-                'html_label_text' => __('Currencies Supported', 'event_espresso'),
-                'required'        => true,
-            )
-        );
-        $this->_subsections['PMD_order'] = new EE_Text_Input(array(
-            'html_label_text'        => __('Order', 'event_espresso'),
-            'html_help_text'         => __('Lowest numbers will be shown first', 'event_espresso'),
-            'normalization_strategy' => new EE_Int_Normalization(),
-            'validation_strategies'  => array(
-                new EE_Int_Validation_Strategy(),
-            ),
-            'default'                => 0,
-        ));
-        $this->_layout_strategy = new EE_Admin_Two_Column_Layout();
-        parent::__construct($options_array);
-        $debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
-        if ($debug_mode instanceof EE_Form_Input_Base) {
-            $debug_mode->set_html_help_text(__(
-                'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
-                'event_espresso'
-            ));
-        }
-    }
-
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(__(
-                'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
-                'event_espresso'
-            )));
-        }
-        // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
-            $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
-                    . "_Settings_Form";
-        }
-        parent::_construct_finalize($parent_form_section, $name);
-    }
-
-
-
-    /**
-     * @param $payment_method_type
-     * @throws EE_Error
-     */
-    public function set_payment_method_type($payment_method_type)
-    {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
-            throw new EE_Error(sprintf(__(
-                "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
-                "event_espresso"
-            )));
-        }
-        $this->_payment_method_type = $payment_method_type;
-    }
-
-
-
-    /**
-     * extends the model form section's save method to also save the extra meta field values
-     *
-     * @return int ID of the payment method inserted, or true on update
-     */
-    public function save()
-    {
-        $parent_save_val = parent::save();
-        if ($this->_model_object && $this->_model_object->ID()) {
-            foreach ($this->_extra_meta_inputs as $input_name => $input) {
-                $this->_model_object->update_extra_meta($input_name, $input->normalized_value());
-            }
-        }
-        return $parent_save_val;
-    }
-
-
-
-    /**
-     * Overrides parent's populate_model_obj to also populate the extra meta fields
-     *
-     * @param EE_Base_Class $model_obj
-     */
-    public function populate_model_obj($model_obj)
-    {
-        $model_obj = $this->_model->ensure_is_obj($model_obj);
-        parent::populate_model_obj($model_obj);
-        $extra_meta = $model_obj->all_extra_meta_array();
-        foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
-            }
-        }
-    }
-
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-            $this->_name = $default_name;
-        }
-    }
-
-
-
-    /**
-     * Gets all the extra meta inputs in this form
-     *
-     * @return EE_Form_Input_Base[]
-     */
-    public function extra_meta_inputs()
-    {
-        return $this->_extra_meta_inputs;
-    }
+	/**
+	 * All the subsection inputs that correspond ot extra meta rows
+	 * for this payment method
+	 *
+	 * @var EE_Form_Input_Base[]
+	 */
+	protected $_extra_meta_inputs = array();
+
+	/**
+	 * Because payment method form might DELAY part of construction, we want to remember
+	 * what options were passed in
+	 *
+	 * @var array
+	 */
+	protected $_options_array = array();
+
+	/**
+	 * The payment method type for this form
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_payment_method_type;
+
+
+
+	/**
+	 * @param array      $options_array       {
+	 * @type string      $extra_meta_inputs   should be EE_Form_Section_Validatable[] which
+	 *                                        will be _subsections and will be saved as extra meta on the payment
+	 *                                        method object;
+	 * @type EE_PMT_Base $payment_method_type the payment method type this form is for
+	 * @see EE_Model_Form_Section::__construct() for more
+	 *                                        }
+	 */
+	public function __construct($options_array = array())
+	{
+		$this->_model = EEM_Payment_Method::instance();
+		$this->_options_array = $options_array;
+		if (isset($options_array['payment_method_type'])) {
+			$this->_payment_method_type = $options_array['payment_method_type'];
+		}
+		$options_array = $this->_options_array;
+		if (isset($options_array['extra_meta_inputs'])) {
+			$this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
+		}
+		if ($this->_extra_meta_inputs) {
+			$this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
+		}
+		$this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
+			array('html_label_text' => __('Button URL', 'event_espresso'))
+		);
+		$this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
+			EEM_Payment_Method::instance()->scopes(),
+			array(
+				'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename()
+									 . EEH_Template::get_help_tab_link('payment_methods_overview'),
+			)
+		);
+		// setup the currency options
+		$this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
+			EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
+			array(
+				'html_label_text' => __('Currencies Supported', 'event_espresso'),
+				'required'        => true,
+			)
+		);
+		$this->_subsections['PMD_order'] = new EE_Text_Input(array(
+			'html_label_text'        => __('Order', 'event_espresso'),
+			'html_help_text'         => __('Lowest numbers will be shown first', 'event_espresso'),
+			'normalization_strategy' => new EE_Int_Normalization(),
+			'validation_strategies'  => array(
+				new EE_Int_Validation_Strategy(),
+			),
+			'default'                => 0,
+		));
+		$this->_layout_strategy = new EE_Admin_Two_Column_Layout();
+		parent::__construct($options_array);
+		$debug_mode = isset($this->_subsections['PMD_debug_mode']) ? $this->_subsections['PMD_debug_mode'] : null;
+		if ($debug_mode instanceof EE_Form_Input_Base) {
+			$debug_mode->set_html_help_text(__(
+				'This payment method has a Sandbox Server (also known as Testing Server, Development Server, Quality Assurance Server, etc). While in debug mode and using this sandbox server, real payments will not be processed.',
+				'event_espresso'
+			));
+		}
+	}
+
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(__(
+				'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
+				'event_espresso'
+			)));
+		}
+		// set the name of this form based on the payment method type
+		if (! $this->_name && ! $name) {
+			$name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
+					. "_Settings_Form";
+		}
+		parent::_construct_finalize($parent_form_section, $name);
+	}
+
+
+
+	/**
+	 * @param $payment_method_type
+	 * @throws EE_Error
+	 */
+	public function set_payment_method_type($payment_method_type)
+	{
+		if (! $payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(__(
+				"Payment Method forms MUST set a payment method type by using _set_payment_method_type",
+				"event_espresso"
+			)));
+		}
+		$this->_payment_method_type = $payment_method_type;
+	}
+
+
+
+	/**
+	 * extends the model form section's save method to also save the extra meta field values
+	 *
+	 * @return int ID of the payment method inserted, or true on update
+	 */
+	public function save()
+	{
+		$parent_save_val = parent::save();
+		if ($this->_model_object && $this->_model_object->ID()) {
+			foreach ($this->_extra_meta_inputs as $input_name => $input) {
+				$this->_model_object->update_extra_meta($input_name, $input->normalized_value());
+			}
+		}
+		return $parent_save_val;
+	}
+
+
+
+	/**
+	 * Overrides parent's populate_model_obj to also populate the extra meta fields
+	 *
+	 * @param EE_Base_Class $model_obj
+	 */
+	public function populate_model_obj($model_obj)
+	{
+		$model_obj = $this->_model->ensure_is_obj($model_obj);
+		parent::populate_model_obj($model_obj);
+		$extra_meta = $model_obj->all_extra_meta_array();
+		foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
+			if (isset($extra_meta[ $input_name ])) {
+				$extra_meta_input->set_default($extra_meta[ $input_name ]);
+			}
+		}
+	}
+
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+			$this->_name = $default_name;
+		}
+	}
+
+
+
+	/**
+	 * Gets all the extra meta inputs in this form
+	 *
+	 * @return EE_Form_Input_Base[]
+	 */
+	public function extra_meta_inputs()
+	{
+		return $this->_extra_meta_inputs;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -106,14 +106,14 @@ 
      */
     public function _construct_finalize($parent_form_section, $name)
     {
-        if (! $this->_payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $this->_payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(__(
                 'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize',
                 'event_espresso'
             )));
         }
         // set the name of this form based on the payment method type
-        if (! $this->_name && ! $name) {
+        if ( ! $this->_name && ! $name) {
             $name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))
                     . "_Settings_Form";
         }
@@ -128,7 +128,7 @@ 
      */
     public function set_payment_method_type($payment_method_type)
     {
-        if (! $payment_method_type instanceof EE_PMT_Base) {
+        if ( ! $payment_method_type instanceof EE_PMT_Base) {
             throw new EE_Error(sprintf(__(
                 "Payment Method forms MUST set a payment method type by using _set_payment_method_type",
                 "event_espresso"
@@ -168,8 +168,8 @@ 
         parent::populate_model_obj($model_obj);
         $extra_meta = $model_obj->all_extra_meta_array();
         foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
-            if (isset($extra_meta[ $input_name ])) {
-                $extra_meta_input->set_default($extra_meta[ $input_name ]);
+            if (isset($extra_meta[$input_name])) {
+                $extra_meta_input->set_default($extra_meta[$input_name]);
             }
         }
     }
@@ -183,8 +183,8 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
-            $default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
+        if ( ! $this->_name) {
+            $default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
             $this->_name = $default_name;
         }
     }

core/libraries/shortcodes/EE_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -352,7 +352,7 @@
      *
      * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
      *
-     * @param $shortcode
+     * @param string $shortcode
      * @since 4.9.32
      * @return string
      */

Indentation +453 added lines, -453 removed lines

@@ -17,457 +17,457 @@
 abstract class EE_Shortcodes extends EE_Base
 {
 
-    /**
-     * holds label for library
-     * This is used for referencing the library label
-     *
-     * @access public
-     * @var string
-     */
-    public $label;
-
-
-    /**
-     * This property is used for referencing a short description of the library
-     *
-     * @access public
-     * @var string
-     */
-    public $description;
-
-
-    /**
-     * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
-     * label/description for the shortcode.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_shortcodes;
-
-
-    /**
-     * This will hold the incoming data item sent to the parser method
-     *
-     * @access protected
-     * @var mixed (array|object)
-     */
-    protected $_data;
-
-
-    /**
-     * some shortcodes may require extra data to parse.  This property is provided for that.
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-
-    /**
-     * EE_messenger used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-
-    /**
-     * message type used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-
-    /**
-     * context used for the template being parsed
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * Specific Message Template Group ID
-     *
-     * @since 4.5.0
-     * @var int
-     */
-    protected $_GRP_ID;
-
-
-    /**
-     * @since 4.9.0
-     * @type EE_Message
-     */
-    protected $_message;
-
-
-    /**
-     * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
-     * shortcodes
-     *
-     * @var EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_helper;
-
-
-    public function __construct()
-    {
-        $this->_set_defaults();
-        $this->_init_props();
-    }
-
-
-    /**
-     * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
-     * method
-     */
-    private function _set_defaults()
-    {
-        $this->name = $this->description = '';
-        $this->_shortcodes = array();
-        $this->_set_shortcode_helper();
-    }
-
-
-    /**
-     * loads an instance of the EE_Shortcode_Parser helper when requested
-     */
-    protected function _set_shortcode_helper()
-    {
-        // get shortcode_replace instance- set when _get_messages is called in child...
-        $this->_shortcode_helper = new EEH_Parse_Shortcodes();
-    }
-
-
-    public function get_shortcode_helper()
-    {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
-            $this->_set_shortcode_helper();
-        }
-        return $this->_shortcode_helper;
-    }
-
-
-    /**
-     * This is the public method for kicking of the parser included with each child.  It can be overridden by child
-     * classes if necessary (see EE_Questions_Answers for example)
-     *
-     * @param  string $shortcode incoming shortcode to be parsed
-     * @param  mixed (object|array) $data       incoming data to be be used for parsing
-     * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
-     * @return string            parsed shortcode.
-     */
-    public function parser($shortcode, $data, $extra_data = array())
-    {
-
-        // filter setup shortcodes
-        $this->_shortcodes = $this->get_shortcodes();
-
-        // we need to setup any dynamic shortcodes so that they work with the array_key_exists
-        $sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-        // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
-            return false;
-        } //get out, this parser doesn't handle the incoming shortcode.
-        $this->_data = $data;
-        $this->_extra_data = $extra_data;
-        $this->_set_messages_properties();
-        $parsed = apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
-            $this->_parser($shortcode),
-            $shortcode,
-            $data,
-            $extra_data,
-            $this
-        );
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        $parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
-        return $parsed;
-    }
-
-
-    /**
-     * This method just returns the shortcodes in the $_shortcodes array property.
-     *
-     * @access public
-     * @return array array of shortcodes => description pairs
-     */
-    public function get_shortcodes()
-    {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
-
-        // note the below filter applies to ALL shortcode parsers... be careful!
-        $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
-
-        return $this->_shortcodes;
-    }
-
-
-    /**
-     * Child classes use this method to set the $name, $description, and $_shortcodes properties.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_props();
-
-
-    /**
-     * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
-     * will have to take care of handling.
-     *
-     * @abstract
-     * @access protected
-     * @param string $shortcode    the shortcode to be parsed.
-     * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
-     *                             array because there are some shortcodes that might be replaced by prepared data that
-     *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
-     *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
-     *                             the data shoudl be in a properly formatted object.  The
-     *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
-     * @return string parsed shortcode
-     */
-    abstract protected function _parser($shortcode);
-
-
-    /**
-     * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
-     * meets their requirements
-     *
-     * @return mixed (void|exception) If validation fails we'll throw an exception.
-     */
-    protected function _validate_list_requirements()
-    {
-
-        // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Expecting an array for the data sent to %s. Instead it was %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    gettype($this->_data)
-                )
-            );
-        }
-
-        // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The incoming data does not have the required template index in its array',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-
-        // next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
-            throw new EE_Error(
-                __(
-                    'The incoming data does not have the required data index in its array',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // all is well let's make sure _extra_data always has the values needed.
-        // let's make sure that extra_data includes all templates (for later parsing if necessary)
-        if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
-            $this->_extra_data['data'] = $this->_data['data'];
-            $this->_extra_data['template'] = $this->_data['template'];
-        }
-    }
-
-
-    /**
-     * This returns any attributes that may be existing on an EE_Shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode incoming shortcode
-     * @return array An array with the attributes
-     */
-    protected function _get_shortcode_attrs($shortcode)
-    {
-        // make sure the required wp helper function is present
-        // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
-        }
-
-        // let's get any attributes that may be present and set the defaults.
-        $shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
-        return shortcode_parse_atts($shortcode_to_parse);
-    }
-
-
-    /**
-     * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
-     * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
-     * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
-     * conditional content.
-     *
-     * @since 4.9.32
-     *
-     * @param string $shortcode This should be original shortcode as used in the template and passed to the parser.
-     * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
-     *                          false means the opening and closing tags and the contained content are removed.
-     * @return string     The template for the shortcode is returned.
-     */
-    protected function _mutate_conditional_block_in_template($shortcode, $show = true)
-    {
-        // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
-
-        if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
-            // we need to hide all instances of the matches
-            foreach ($matches[0] as $index => $content_to_show_or_hide) {
-                $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement = $show ? $matches[4][ $index ] : '';
-                $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
-                    $replacement,
-                    $this->_data['template']
-                );
-            }
-        }
-        // return $template
-        return $this->_data['template'];
-    }
-
-
-    /**
-     * This returns the regex pattern to use for conditional shortcodes parsing.
-     *
-     * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
-     *
-     * @param $shortcode
-     * @since 4.9.32
-     * @return string
-     */
-    private function _get_conditional_block_regex($shortcode)
-    {
-        // get just the shortcode tag for the match
-        preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
-        if (empty($shortcode_tag_matches[1])) {
-            return $this->_data['template'];
-        }
-
-        $shortcode_tag = $shortcode_tag_matches[1];
-        // get attributes_part_of_tag
-        $attributes_part = preg_quote(str_replace(array($shortcode_tag, '[', ']'), '', $shortcode));
-        // escape
-        $shortcode_tag = preg_quote($shortcode_tag);
-
-        return
-            '\['                                  // Opening Bracket
-            . "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
-            . '(?![\w-])'                           // Not followed by word character or hyphen
-            . '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
-            . '[^\]\/]*'                          // Not a closing bracket or forward slash
-            . '(?:'
-            . '\/(?!\])'                      // A forward slash not followed by a closing bracket
-            . '[^\]\/]*'                      // Not a closing bracket or forward slash.
-            . ')*?'
-            . ')'
-            . '(?:'
-            . '(\/)'                              // 3. Self closing tag ...
-            . '\]'                                // ... and closing bracket
-            . '|'
-            . '\]'                                // Closing bracket
-            . '(?:'
-            . '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
-            . '[^\[]*+'                   // Not an opening bracket
-            . '(?:'
-            . '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
-            . '[^\[]*+'               // Not an opening bracket
-            . ')*+'
-            . ')'
-            . '\[\/\1\]'                      // Closing shortcode tag
-            . ')?'
-            . ')';
-    }
-
-
-    /**
-     * This sets the properties related to the messages system
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _set_messages_properties()
-    {
-        // should be in _extra_data
-        if (isset($this->_extra_data['messenger'])) {
-            $this->_messenger = $this->_extra_data['messenger'];
-            $this->_message_type = $this->_extra_data['message_type'];
-            $this->_context = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->context() : '';
-            $this->_GRP_ID = $this->_extra_data['message'] instanceof EE_Message
-                ? $this->_extra_data['message']->GRP_ID() : 0;
-            $this->_message = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']
-                : null;
-        }
-    }
-
-
-    /**
-     * This returns whatever the set message type object is that was set on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return EE_message_type
-     */
-    public function get_set_message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * This returns whatever the set messenger object is that was set on this shortcode parser
-     *
-     * @since 4.5.0
-     * @return EE_messenger
-     */
-    public function get_set_messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * This returns whatever the set context string is on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    public function get_set_context()
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * This returns whatever the set EE_Message object is on this shortcode.
-     *
-     * @since 4.9.0
-     * @return EE_Message
-     */
-    public function get_set_message()
-    {
-        return $this->_message;
-    }
+	/**
+	 * holds label for library
+	 * This is used for referencing the library label
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $label;
+
+
+	/**
+	 * This property is used for referencing a short description of the library
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $description;
+
+
+	/**
+	 * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
+	 * label/description for the shortcode.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_shortcodes;
+
+
+	/**
+	 * This will hold the incoming data item sent to the parser method
+	 *
+	 * @access protected
+	 * @var mixed (array|object)
+	 */
+	protected $_data;
+
+
+	/**
+	 * some shortcodes may require extra data to parse.  This property is provided for that.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+
+	/**
+	 * EE_messenger used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * message type used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * context used for the template being parsed
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * Specific Message Template Group ID
+	 *
+	 * @since 4.5.0
+	 * @var int
+	 */
+	protected $_GRP_ID;
+
+
+	/**
+	 * @since 4.9.0
+	 * @type EE_Message
+	 */
+	protected $_message;
+
+
+	/**
+	 * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
+	 * shortcodes
+	 *
+	 * @var EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_helper;
+
+
+	public function __construct()
+	{
+		$this->_set_defaults();
+		$this->_init_props();
+	}
+
+
+	/**
+	 * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
+	 * method
+	 */
+	private function _set_defaults()
+	{
+		$this->name = $this->description = '';
+		$this->_shortcodes = array();
+		$this->_set_shortcode_helper();
+	}
+
+
+	/**
+	 * loads an instance of the EE_Shortcode_Parser helper when requested
+	 */
+	protected function _set_shortcode_helper()
+	{
+		// get shortcode_replace instance- set when _get_messages is called in child...
+		$this->_shortcode_helper = new EEH_Parse_Shortcodes();
+	}
+
+
+	public function get_shortcode_helper()
+	{
+		if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+			$this->_set_shortcode_helper();
+		}
+		return $this->_shortcode_helper;
+	}
+
+
+	/**
+	 * This is the public method for kicking of the parser included with each child.  It can be overridden by child
+	 * classes if necessary (see EE_Questions_Answers for example)
+	 *
+	 * @param  string $shortcode incoming shortcode to be parsed
+	 * @param  mixed (object|array) $data       incoming data to be be used for parsing
+	 * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
+	 * @return string            parsed shortcode.
+	 */
+	public function parser($shortcode, $data, $extra_data = array())
+	{
+
+		// filter setup shortcodes
+		$this->_shortcodes = $this->get_shortcodes();
+
+		// we need to setup any dynamic shortcodes so that they work with the array_key_exists
+		$sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+		$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+		// first we want to make sure this is a valid shortcode
+		if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+			return false;
+		} //get out, this parser doesn't handle the incoming shortcode.
+		$this->_data = $data;
+		$this->_extra_data = $extra_data;
+		$this->_set_messages_properties();
+		$parsed = apply_filters(
+			'FHEE__' . get_class($this) . '__parser_after',
+			$this->_parser($shortcode),
+			$shortcode,
+			$data,
+			$extra_data,
+			$this
+		);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		$parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
+		return $parsed;
+	}
+
+
+	/**
+	 * This method just returns the shortcodes in the $_shortcodes array property.
+	 *
+	 * @access public
+	 * @return array array of shortcodes => description pairs
+	 */
+	public function get_shortcodes()
+	{
+		$this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+
+		// note the below filter applies to ALL shortcode parsers... be careful!
+		$this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
+
+		return $this->_shortcodes;
+	}
+
+
+	/**
+	 * Child classes use this method to set the $name, $description, and $_shortcodes properties.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_props();
+
+
+	/**
+	 * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
+	 * will have to take care of handling.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @param string $shortcode    the shortcode to be parsed.
+	 * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
+	 *                             array because there are some shortcodes that might be replaced by prepared data that
+	 *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
+	 *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
+	 *                             the data shoudl be in a properly formatted object.  The
+	 *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
+	 * @return string parsed shortcode
+	 */
+	abstract protected function _parser($shortcode);
+
+
+	/**
+	 * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
+	 * meets their requirements
+	 *
+	 * @return mixed (void|exception) If validation fails we'll throw an exception.
+	 */
+	protected function _validate_list_requirements()
+	{
+
+		// first test to make sure we've got an array!
+		if (! is_array($this->_data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Expecting an array for the data sent to %s. Instead it was %s',
+						'event_espresso'
+					),
+					get_class($this),
+					gettype($this->_data)
+				)
+			);
+		}
+
+		// next test to make sure we've got the required template in the index!
+		if (! isset($this->_data['template'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The incoming data does not have the required template index in its array',
+						'event_espresso'
+					)
+				)
+			);
+		}
+
+		// next test to make sure we've got got a data index in the incoming data array
+		if (! isset($this->_data['data'])) {
+			throw new EE_Error(
+				__(
+					'The incoming data does not have the required data index in its array',
+					'event_espresso'
+				)
+			);
+		}
+
+		// all is well let's make sure _extra_data always has the values needed.
+		// let's make sure that extra_data includes all templates (for later parsing if necessary)
+		if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
+			$this->_extra_data['data'] = $this->_data['data'];
+			$this->_extra_data['template'] = $this->_data['template'];
+		}
+	}
+
+
+	/**
+	 * This returns any attributes that may be existing on an EE_Shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode incoming shortcode
+	 * @return array An array with the attributes
+	 */
+	protected function _get_shortcode_attrs($shortcode)
+	{
+		// make sure the required wp helper function is present
+		// require the shortcode file if necessary
+		if (! function_exists('shortcode_parse_atts')) {
+			require_once(ABSPATH . WPINC . '/shortcodes.php');
+		}
+
+		// let's get any attributes that may be present and set the defaults.
+		$shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
+		return shortcode_parse_atts($shortcode_to_parse);
+	}
+
+
+	/**
+	 * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
+	 * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever
+	 * conditions existed in the opening tag.  This method handles parsing the actual template to show/hide this
+	 * conditional content.
+	 *
+	 * @since 4.9.32
+	 *
+	 * @param string $shortcode This should be original shortcode as used in the template and passed to the parser.
+	 * @param bool   $show      true means the opening and closing tags are removed and the content is left showing,
+	 *                          false means the opening and closing tags and the contained content are removed.
+	 * @return string     The template for the shortcode is returned.
+	 */
+	protected function _mutate_conditional_block_in_template($shortcode, $show = true)
+	{
+		// first let's get all the matches in the template for this particular shortcode.
+		preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+
+		if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
+			// we need to hide all instances of the matches
+			foreach ($matches[0] as $index => $content_to_show_or_hide) {
+				$content_to_show_or_hide = preg_quote($content_to_show_or_hide);
+				$replacement = $show ? $matches[4][ $index ] : '';
+				$this->_data['template'] = preg_replace(
+					'~' . $content_to_show_or_hide . '~',
+					$replacement,
+					$this->_data['template']
+				);
+			}
+		}
+		// return $template
+		return $this->_data['template'];
+	}
+
+
+	/**
+	 * This returns the regex pattern to use for conditional shortcodes parsing.
+	 *
+	 * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
+	 *
+	 * @param $shortcode
+	 * @since 4.9.32
+	 * @return string
+	 */
+	private function _get_conditional_block_regex($shortcode)
+	{
+		// get just the shortcode tag for the match
+		preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
+		if (empty($shortcode_tag_matches[1])) {
+			return $this->_data['template'];
+		}
+
+		$shortcode_tag = $shortcode_tag_matches[1];
+		// get attributes_part_of_tag
+		$attributes_part = preg_quote(str_replace(array($shortcode_tag, '[', ']'), '', $shortcode));
+		// escape
+		$shortcode_tag = preg_quote($shortcode_tag);
+
+		return
+			'\['                                  // Opening Bracket
+			. "($shortcode_tag)$attributes_part"    // 1: Shortcode Name
+			. '(?![\w-])'                           // Not followed by word character or hyphen
+			. '('                                   // 2: Unroll the loop: Inside the opening shortcode tag
+			. '[^\]\/]*'                          // Not a closing bracket or forward slash
+			. '(?:'
+			. '\/(?!\])'                      // A forward slash not followed by a closing bracket
+			. '[^\]\/]*'                      // Not a closing bracket or forward slash.
+			. ')*?'
+			. ')'
+			. '(?:'
+			. '(\/)'                              // 3. Self closing tag ...
+			. '\]'                                // ... and closing bracket
+			. '|'
+			. '\]'                                // Closing bracket
+			. '(?:'
+			. '('                             // 4: Unroll the loop: Optionally, anything between the opening and closing brackets
+			. '[^\[]*+'                   // Not an opening bracket
+			. '(?:'
+			. '\[(?!\/\1\])'          // An opening bracket not followed by the closing shortcode tag.
+			. '[^\[]*+'               // Not an opening bracket
+			. ')*+'
+			. ')'
+			. '\[\/\1\]'                      // Closing shortcode tag
+			. ')?'
+			. ')';
+	}
+
+
+	/**
+	 * This sets the properties related to the messages system
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _set_messages_properties()
+	{
+		// should be in _extra_data
+		if (isset($this->_extra_data['messenger'])) {
+			$this->_messenger = $this->_extra_data['messenger'];
+			$this->_message_type = $this->_extra_data['message_type'];
+			$this->_context = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->context() : '';
+			$this->_GRP_ID = $this->_extra_data['message'] instanceof EE_Message
+				? $this->_extra_data['message']->GRP_ID() : 0;
+			$this->_message = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']
+				: null;
+		}
+	}
+
+
+	/**
+	 * This returns whatever the set message type object is that was set on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return EE_message_type
+	 */
+	public function get_set_message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * This returns whatever the set messenger object is that was set on this shortcode parser
+	 *
+	 * @since 4.5.0
+	 * @return EE_messenger
+	 */
+	public function get_set_messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * This returns whatever the set context string is on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	public function get_set_context()
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * This returns whatever the set EE_Message object is on this shortcode.
+	 *
+	 * @since 4.9.0
+	 * @return EE_Message
+	 */
+	public function get_set_message()
+	{
+		return $this->_message;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -146,7 +146,7 @@ 
 
     public function get_shortcode_helper()
     {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+        if ( ! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
             $this->_set_shortcode_helper();
         }
         return $this->_shortcode_helper;
@@ -170,17 +170,17 @@ 
 
         // we need to setup any dynamic shortcodes so that they work with the array_key_exists
         $sc = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
         // first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+        if ( ! array_key_exists($sc_to_verify, $this->_shortcodes)) {
             return false;
         } //get out, this parser doesn't handle the incoming shortcode.
         $this->_data = $data;
         $this->_extra_data = $extra_data;
         $this->_set_messages_properties();
         $parsed = apply_filters(
-            'FHEE__' . get_class($this) . '__parser_after',
+            'FHEE__'.get_class($this).'__parser_after',
             $this->_parser($shortcode),
             $shortcode,
             $data,
@@ -202,7 +202,7 @@ 
      */
     public function get_shortcodes()
     {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+        $this->_shortcodes = apply_filters('FHEE__'.get_class($this).'__shortcodes', $this->_shortcodes, $this);
 
         // note the below filter applies to ALL shortcode parsers... be careful!
         $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
@@ -249,7 +249,7 @@ 
     {
 
         // first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
+        if ( ! is_array($this->_data)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -263,7 +263,7 @@ 
         }
 
         // next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
+        if ( ! isset($this->_data['template'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -275,7 +275,7 @@ 
         }
 
         // next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
+        if ( ! isset($this->_data['data'])) {
             throw new EE_Error(
                 __(
                     'The incoming data does not have the required data index in its array',
@@ -304,8 +304,8 @@ 
     {
         // make sure the required wp helper function is present
         // require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
+        if ( ! function_exists('shortcode_parse_atts')) {
+            require_once(ABSPATH.WPINC.'/shortcodes.php');
         }
 
         // let's get any attributes that may be present and set the defaults.
@@ -330,15 +330,15 @@ 
     protected function _mutate_conditional_block_in_template($shortcode, $show = true)
     {
         // first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+        preg_match_all('~'.$this->_get_conditional_block_regex($shortcode).'~', $this->_data['template'], $matches);
 
         if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
             // we need to hide all instances of the matches
             foreach ($matches[0] as $index => $content_to_show_or_hide) {
                 $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement = $show ? $matches[4][ $index ] : '';
+                $replacement = $show ? $matches[4][$index] : '';
                 $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
+                    '~'.$content_to_show_or_hide.'~',
                     $replacement,
                     $this->_data['template']
                 );