eventespresso / event-espresso-core

acceptance_tests/tests/e-TestContextActivationToggleCept.php

Indentation +62 added lines, -62 removed lines

@@ -8,8 +8,8 @@ 
 $event_label = 'Testing Context Deactivation';
 
 $I->wantTo(
-    'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
-    . ' expected'
+	'Test that the context activation toggle for turning on or off specific contexts for message sending works as'
+	. ' expected'
 );
 
 $I->loginAsAdmin();
@@ -34,7 +34,7 @@ 
 $I->see('The template for Primary Registrant Recipient is currently inactive.');
 
 $I->amGoingTo(
-    'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
+	'Trigger Registration Approved Messages and verify primary registrant context is excluded from sent messages.'
 );
 $I->amOnDefaultEventsListTablePage();
 $I->click(EventsAdmin::ADD_NEW_EVENT_BUTTON_SELECTOR);
@@ -44,9 +44,9 @@ 
 $event_link = $I->observeLinkUrlAt(EventsAdmin::EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR);
 $event_id = $I->observeValueFromInputAt(EventsAdmin::EVENT_EDITOR_EVT_ID_SELECTOR);
 $test_registration_details = array(
-    'fname' => 'ContextTestGuy',
-    'lname' => 'ContextTestDude',
-    'email' => 'contexttestguy@example.org',
+	'fname' => 'ContextTestGuy',
+	'lname' => 'ContextTestDude',
+	'email' => 'contexttestguy@example.org',
 );
 $I->logOut();
 $I->amOnUrl($event_link);
@@ -63,48 +63,48 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 
 $I->amGoingTo(
-    'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
-    . ' field to an empty string to verify the message does not send for that context.'
+	'Deactivate primary registrant context for Registration Approved Message Templates and restore the "To"'
+	. ' field to an empty string to verify the message does not send for that context.'
 );
 $I->amOnDefaultMessageTemplateListTablePage();
 $I->clickToEditMessageTemplateByMessageType('registration', 'primary_attendee');
@@ -128,41 +128,41 @@ 
 $I->amOnMessagesActivityListTablePage();
 //verify registrant context
 $I->see(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Registrant'
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 //verify admin context
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 //verify primary registrant context is NOT present.
 $I->dontSee(
-    $test_registration_details['email'],
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Approved',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	$test_registration_details['email'],
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Approved',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
\ No newline at end of file

public/Espresso_Arabica_2014/functions.php

Spacing +7 added lines, -7 removed lines

@@ -9,9 +9,9 @@ 
  * @ link			http://www.eventespresso.com
  * @ version		4+
  */
-define( 'EE_THEME_FUNCTIONS_LOADED', TRUE );
+define('EE_THEME_FUNCTIONS_LOADED', TRUE);
 
-if ( ! function_exists( 'espresso_pagination' ) ) {
+if ( ! function_exists('espresso_pagination')) {
 	/**
 	 *    espresso_pagination
 	 *
@@ -23,21 +23,21 @@ 
 		$big = 999999999; // need an unlikely integer
 		$pagination = paginate_links(
 			array(
-				'base'         => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
 				'format'       => '?paged=%#%',
-				'current'      => max( 1, get_query_var( 'paged' ) ),
+				'current'      => max(1, get_query_var('paged')),
 				'total'        => $wp_query->max_num_pages,
 				'show_all'     => true,
 				'end_size'     => 10,
 				'mid_size'     => 6,
 				'prev_next'    => true,
-				'prev_text'    => __( '‹ PREV', 'event_espresso' ),
-				'next_text'    => __( 'NEXT ›', 'event_espresso' ),
+				'prev_text'    => __('‹ PREV', 'event_espresso'),
+				'next_text'    => __('NEXT ›', 'event_espresso'),
 				'type'         => 'plain',
 				'add_args'     => false,
 				'add_fragment' => ''
 			)
 		);
-		echo ! empty( $pagination ) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
 	}
 }
\ No newline at end of file

admin_pages/messages/help_tabs/messages_settings_messengers.help_tab.php

Indentation +50 added lines, -50 removed lines

@@ -3,79 +3,79 @@
 </p>
 <p>
     <?php esc_html_e(
-        'You can select Messengers via the tabs across the top of the settings page. The available messengers you see depends on what version of Event Espresso you have and what addons are installed. Every install include an "Email" messenger tab.  When you click one of those tabs it will display that messenger.',
-        'event_espresso'
-    ); ?>
+		'You can select Messengers via the tabs across the top of the settings page. The available messengers you see depends on what version of Event Espresso you have and what addons are installed. Every install include an "Email" messenger tab.  When you click one of those tabs it will display that messenger.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'There are two ways to determine whether a messenger is active or not.  The first way is via the messenger tab itself.',
-        'event_espresso'
-    ); ?>
+		'There are two ways to determine whether a messenger is active or not.  The first way is via the messenger tab itself.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php printf(
-        esc_html__(
-            'The green colored gear %s indicates that this messenger is currently active.',
-            'event_espresso'
-        ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
-        . ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
-    );
-    printf(
-        esc_html__(
-            ' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
-            'event_espresso'
-        ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
-    ); ?>
+		esc_html__(
+			'The green colored gear %s indicates that this messenger is currently active.',
+			'event_espresso'
+		),
+		'<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
+		. ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
+	);
+	printf(
+		esc_html__(
+			' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
+			'event_espresso'
+		),
+		'<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
+		. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'The second way to determine whether a messenger is active or not is via the "on/off" button in the top right corner of the active messenger displayed content:',
-        'event_espresso'
-    ); ?>
+		'The second way to determine whether a messenger is active or not is via the "on/off" button in the top right corner of the active messenger displayed content:',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php printf(
-        esc_html__(
-            '%1$s means of course that the messenger is active and %2$s means the messenger is inactive.',
-            'event_espresso'
-        ),
-        '<div class="switch">'
-            . '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked" disabled>'
-            . '<label for="ee-on-off-toggle-on"></label>'
-        . '</div>',
-        '<div class="switch">'
-            . '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" disabled>'
-            . '<label for="ee-on-off-toggle-on"></label>'
-        . '</div>'
-    ); ?>
+		esc_html__(
+			'%1$s means of course that the messenger is active and %2$s means the messenger is inactive.',
+			'event_espresso'
+		),
+		'<div class="switch">'
+			. '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked" disabled>'
+			. '<label for="ee-on-off-toggle-on"></label>'
+		. '</div>',
+		'<div class="switch">'
+			. '<input class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" disabled>'
+			. '<label for="ee-on-off-toggle-on"></label>'
+		. '</div>'
+	); ?>
 </p>
 <p>
     <?php
-        esc_html_e(
-            'The on/off toggle is also what you use to activate or deactivate a messenger.',
-            'event_espresso'
-        ); ?>
+		esc_html_e(
+			'The on/off toggle is also what you use to activate or deactivate a messenger.',
+			'event_espresso'
+		); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'What happens when you click the toggle to activate is the messenger is activated and the system determines what default message types are activated with the messenger.  Then, if there are any default settings for either the messenger or message types those settings are saved.  Next, the system will generate any default templates (if none have been generated before, if there are previously generated templates then they are reactivated).  Finally, you will see the display change to reflect that the messenger is active. If the messenger has settings you can modify them then. Any message types that have settings will also automatically expand so you can see the default settings and make any changes as necessary to fit your needs. Usually the defaults are sufficient however.',
-        'event_espresso'
-    ); ?>
+		'What happens when you click the toggle to activate is the messenger is activated and the system determines what default message types are activated with the messenger.  Then, if there are any default settings for either the messenger or message types those settings are saved.  Next, the system will generate any default templates (if none have been generated before, if there are previously generated templates then they are reactivated).  Finally, you will see the display change to reflect that the messenger is active. If the messenger has settings you can modify them then. Any message types that have settings will also automatically expand so you can see the default settings and make any changes as necessary to fit your needs. Usually the defaults are sufficient however.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <?php esc_html_e(
-        'When you deactivate a messenger, the system will first check if there are any custom event templates for that messenger. If there are you will be unable to deactivate the messenger. This is a fail safe to make sure you know that no messages will go out for those specific events so you don\'t accidentally deactivate.  If this check passes, then the system will deactivate any global templates for that messenger (note the templates are not erased, they just become inactive, so if you decide to reactivate the messenger later all your customizations are preserved). Then the display will change to reflect the deactivation.',
-        'event_espresso'
-    ); ?>
+		'When you deactivate a messenger, the system will first check if there are any custom event templates for that messenger. If there are you will be unable to deactivate the messenger. This is a fail safe to make sure you know that no messages will go out for those specific events so you don\'t accidentally deactivate.  If this check passes, then the system will deactivate any global templates for that messenger (note the templates are not erased, they just become inactive, so if you decide to reactivate the messenger later all your customizations are preserved). Then the display will change to reflect the deactivation.',
+		'event_espresso'
+	); ?>
 </p>
 <p>
     <strong><?php esc_html_e('Important', 'event_espresso'); ?></strong><br/>
     <?php esc_html_e(
-        'Although customizations made to global templates are preserved when a messenger is deactivated, any settings for that messenger (or the message types that were attached to it) are lost on deactivation.  Also, once you deactivate a messenger, no more messages will be delivered using that messenger for any of your events.',
-        'event_espresso'
-    ); ?>
+		'Although customizations made to global templates are preserved when a messenger is deactivated, any settings for that messenger (or the message types that were attached to it) are lost on deactivation.  Also, once you deactivate a messenger, no more messages will be delivered using that messenger for any of your events.',
+		'event_espresso'
+	); ?>
 </p>

Spacing +4 added lines, -4 removed lines

@@ -19,16 +19,16 @@
             'The green colored gear %s indicates that this messenger is currently active.',
             'event_espresso'
         ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '"'
-        . ' alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />'
+        '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'.'"'
+        . ' alt="'.esc_attr__('Active Email Tab', 'event_espresso').'" />'
     );
     printf(
         esc_html__(
             ' The white colored gear %s indicates the messenger is inactive. This is very helpful for seeing at a glance all the messengers that are active when you first view the page.',
             'event_espresso'
         ),
-        '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />'
+        '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'
+        . '" alt="'.esc_attr__('Inactive Email Tab', 'event_espresso').'" />'
     ); ?>
 </p>
 <p>

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
     /**
      * This retrieves the EE_Venue from the available data object.
      *
-     * @return EE_Venue|null
+     * @return EE_Base_Class|null
      * @throws EE_Error
      * @throws EntityNotFoundException
      */

Indentation +311 added lines, -311 removed lines

@@ -17,315 +17,315 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-    /**
-     * Will hold the EE_Venue if available
-     *
-     * @var EE_Venue
-     */
-    protected $_venue;
-
-
-    /**
-     * Initialize properties
-     */
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Venue Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
-            '[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
-            '[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
-            '[VENUE_DETAILS_URL]'       => sprintf(
-                esc_html__(
-                    'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
-                    'event_espresso'
-                ),
-                '[VENUE_URL]'
-            ),
-            '[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
-            '[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
-            '[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
-            '[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
-            '[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
-            '[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
-            '[VENUE_FORMATTED_ADDRESS]' => esc_html__(
-                'This just outputs the venue address in a semantic address format.',
-                'event_espresso'
-            ),
-            '[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
-            '[VENUE_META_*]'            => esc_html__(
-                'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_URL]'          => esc_html__(
-                'URL for the google map associated with the venue.',
-                'event_espresso'
-            ),
-            '[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
-            '[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Parse incoming shortcode
-     *
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    protected function _parser($shortcode)
-    {
-        $this->_venue = $this->_get_venue();
-        // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        }
-
-        switch ($shortcode) {
-            case '[VENUE_TITLE]':
-                return $this->_venue('title');
-                break;
-
-            case '[VENUE_DESCRIPTION]':
-                return $this->_venue('description');
-                break;
-
-            case '[VENUE_URL]':
-                return $this->_venue('url');
-                break;
-
-            case '[VENUE_IMAGE]':
-                return $this->_venue('image');
-                break;
-
-            case '[VENUE_PHONE]':
-                return $this->_venue('phone');
-                break;
-
-            case '[VENUE_ADDRESS]':
-                return $this->_venue('address');
-                break;
-
-            case '[VENUE_ADDRESS2]':
-                return $this->_venue('address2');
-                break;
-
-            case '[VENUE_CITY]':
-                return $this->_venue('city');
-                break;
-
-            case '[VENUE_COUNTRY]':
-                return $this->_venue('country');
-                break;
-
-            case '[VENUE_STATE]':
-                return $this->_venue('state');
-                break;
-
-            case '[VENUE_ZIP]':
-                return $this->_venue('zip');
-                break;
-
-            case '[VENUE_FORMATTED_ADDRESS]':
-                return $this->_venue('formatted_address');
-                break;
-
-            case '[GOOGLE_MAP_URL]':
-                return $this->_venue('gmap_url');
-                break;
-
-            case '[GOOGLE_MAP_LINK]':
-                return $this->_venue('gmap_link');
-                break;
-
-            case '[GOOGLE_MAP_IMAGE]':
-                return $this->_venue('gmap_link_img');
-                break;
-
-            case '[VENUE_DETAILS_URL]':
-                return $this->_venue('permalink');
-                break;
-        }
-
-        if (strpos($shortcode, '[VENUE_META_*') !== false) {
-            $shortcode = str_replace('[VENUE_META_*', '', $shortcode);
-            $shortcode = trim(str_replace(']', '', $shortcode));
-
-            // pull the meta value from the venue post
-            $venue_meta = $this->_venue->get_post_meta($shortcode, true);
-
-            return ! empty($venue_meta) ? $venue_meta : '';
-        }
-    }
-
-    /**
-     * This retrieves the EE_Venue from the available data object.
-     *
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _get_venue()
-    {
-
-        // we need the EE_Event object to get the venue.
-        $this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
-
-        // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
-        // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
-            $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-            $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
-
-            $this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
-                ? $aee->reg_obj->event()
-                : null;
-
-            // if still empty do we have a ticket data item?
-            $this->_event = ! $this->_event instanceof EE_Event
-                            && $this->_data instanceof EE_Ticket
-                            && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
-                : $this->_event;
-
-            // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
-            // and use that.
-            $this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
-                ? reset($aee->events)
-                : $this->_event;
-        }
-
-        // If we have an event object use it to pull the venue.
-        if ($this->_event instanceof EE_Event) {
-            return $this->_event->get_first_related('Venue');
-        }
-
-        return null;
-    }
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-
-        if (! $this->_venue instanceof EE_Venue) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $this->_venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $this->_venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $this->_venue->get('VNU_url');
-                return empty($url) ? $this->_venue->get_permalink() : $url;
-                break;
-
-            case 'permalink':
-                return $this->_venue->get_permalink();
-                break;
-
-            case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $this->_venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $this->_venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $this->_venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $this->_venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $this->_venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $this->_venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $this->_venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $this->_venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($this->_venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($this->_venue, $field);
-                return EEH_Maps::google_map_link($atts);
-                break;
-        }
-        return '';
-    }
-
-
-    /**
-     * Generates the attributes for retrieving a google_map artifact.
-     *
-     * @param EE_Venue $venue
-     * @param string   $field
-     * @return array
-     * @throws EE_Error
-     */
-    protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
-    {
-        $state = $venue->state_obj();
-        $country = $venue->country_obj();
-        $atts = array(
-            'id'      => $venue->ID(),
-            'address' => $venue->get('VNU_address'),
-            'city'    => $venue->get('VNU_city'),
-            'state'   => is_object($state) ? $state->get('STA_name') : '',
-            'zip'     => $venue->get('VNU_zip'),
-            'country' => is_object($country) ? $country->get('CNT_name') : '',
-            'type'    => $field === 'gmap_link' ? 'url' : 'map',
-            'map_w'   => 200,
-            'map_h'   => 200,
-        );
-        if ($field === 'gmap_url') {
-            $atts['type'] = 'url_only';
-        }
-        return $atts;
-    }
+	/**
+	 * Will hold the EE_Event if available
+	 *
+	 * @var EE_Event
+	 */
+	protected $_event;
+
+	/**
+	 * Will hold the EE_Venue if available
+	 *
+	 * @var EE_Venue
+	 */
+	protected $_venue;
+
+
+	/**
+	 * Initialize properties
+	 */
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Venue Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to venue related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[VENUE_TITLE]'             => esc_html__('The title for the event venue', 'event_espresso'),
+			'[VENUE_DESCRIPTION]'       => esc_html__('The description for the event venue', 'event_espresso'),
+			'[VENUE_URL]'               => esc_html__('A url to a webpage for the venue', 'event_espresso'),
+			'[VENUE_DETAILS_URL]'       => sprintf(
+				esc_html__(
+					'This shortcode outputs the url or website address to the venue details page on this website. This differs from %s which outputs what is entered in the "url" field in the venue details page.',
+					'event_espresso'
+				),
+				'[VENUE_URL]'
+			),
+			'[VENUE_IMAGE]'             => esc_html__('An image representing the event venue', 'event_espresso'),
+			'[VENUE_PHONE]'             => esc_html__('The phone number for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS]'           => esc_html__('The address for the venue', 'event_espresso'),
+			'[VENUE_ADDRESS2]'          => esc_html__('Address 2 for the venue', 'event_espresso'),
+			'[VENUE_CITY]'              => esc_html__('The city the venue is in', 'event_espresso'),
+			'[VENUE_STATE]'             => esc_html__('The state the venue is located in', 'event_espresso'),
+			'[VENUE_COUNTRY]'           => esc_html__('The country the venue is located in', 'event_espresso'),
+			'[VENUE_FORMATTED_ADDRESS]' => esc_html__(
+				'This just outputs the venue address in a semantic address format.',
+				'event_espresso'
+			),
+			'[VENUE_ZIP]'               => esc_html__('The zip code for the venue address', 'event_espresso'),
+			'[VENUE_META_*]'            => esc_html__(
+				'This is a special dynamic shortcode. After the "*", add the exact name for your custom field, if there is a value set for that custom field within the venue then it will be output in place of this shortcode.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_URL]'          => esc_html__(
+				'URL for the google map associated with the venue.',
+				'event_espresso'
+			),
+			'[GOOGLE_MAP_LINK]'         => esc_html__('Link to a google map for the venue', 'event_espresso'),
+			'[GOOGLE_MAP_IMAGE]'        => esc_html__('Google map for venue wrapped in image tags', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Parse incoming shortcode
+	 *
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	protected function _parser($shortcode)
+	{
+		$this->_venue = $this->_get_venue();
+		// If there is no venue object by now then get out.
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		}
+
+		switch ($shortcode) {
+			case '[VENUE_TITLE]':
+				return $this->_venue('title');
+				break;
+
+			case '[VENUE_DESCRIPTION]':
+				return $this->_venue('description');
+				break;
+
+			case '[VENUE_URL]':
+				return $this->_venue('url');
+				break;
+
+			case '[VENUE_IMAGE]':
+				return $this->_venue('image');
+				break;
+
+			case '[VENUE_PHONE]':
+				return $this->_venue('phone');
+				break;
+
+			case '[VENUE_ADDRESS]':
+				return $this->_venue('address');
+				break;
+
+			case '[VENUE_ADDRESS2]':
+				return $this->_venue('address2');
+				break;
+
+			case '[VENUE_CITY]':
+				return $this->_venue('city');
+				break;
+
+			case '[VENUE_COUNTRY]':
+				return $this->_venue('country');
+				break;
+
+			case '[VENUE_STATE]':
+				return $this->_venue('state');
+				break;
+
+			case '[VENUE_ZIP]':
+				return $this->_venue('zip');
+				break;
+
+			case '[VENUE_FORMATTED_ADDRESS]':
+				return $this->_venue('formatted_address');
+				break;
+
+			case '[GOOGLE_MAP_URL]':
+				return $this->_venue('gmap_url');
+				break;
+
+			case '[GOOGLE_MAP_LINK]':
+				return $this->_venue('gmap_link');
+				break;
+
+			case '[GOOGLE_MAP_IMAGE]':
+				return $this->_venue('gmap_link_img');
+				break;
+
+			case '[VENUE_DETAILS_URL]':
+				return $this->_venue('permalink');
+				break;
+		}
+
+		if (strpos($shortcode, '[VENUE_META_*') !== false) {
+			$shortcode = str_replace('[VENUE_META_*', '', $shortcode);
+			$shortcode = trim(str_replace(']', '', $shortcode));
+
+			// pull the meta value from the venue post
+			$venue_meta = $this->_venue->get_post_meta($shortcode, true);
+
+			return ! empty($venue_meta) ? $venue_meta : '';
+		}
+	}
+
+	/**
+	 * This retrieves the EE_Venue from the available data object.
+	 *
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _get_venue()
+	{
+
+		// we need the EE_Event object to get the venue.
+		$this->_event = $this->_data instanceof EE_Event ? $this->_data : null;
+
+		// if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
+		// reg_obj instead.
+		if (! $this->_event instanceof EE_Event) {
+			$aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+			$aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
+
+			$this->_event = $aee instanceof EE_Messages_Addressee && $aee->reg_obj instanceof EE_Registration
+				? $aee->reg_obj->event()
+				: null;
+
+			// if still empty do we have a ticket data item?
+			$this->_event = ! $this->_event instanceof EE_Event
+							&& $this->_data instanceof EE_Ticket
+							&& $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+				: $this->_event;
+
+			// if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
+			// and use that.
+			$this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
+				? reset($aee->events)
+				: $this->_event;
+		}
+
+		// If we have an event object use it to pull the venue.
+		if ($this->_event instanceof EE_Event) {
+			return $this->_event->get_first_related('Venue');
+		}
+
+		return null;
+	}
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+
+		if (! $this->_venue instanceof EE_Venue) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $this->_venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $this->_venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $this->_venue->get('VNU_url');
+				return empty($url) ? $this->_venue->get_permalink() : $url;
+				break;
+
+			case 'permalink':
+				return $this->_venue->get_permalink();
+				break;
+
+			case 'image':
+				return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $this->_venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $this->_venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $this->_venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $this->_venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $this->_venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $this->_venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $this->_venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $this->_venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($this->_venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($this->_venue, $field);
+				return EEH_Maps::google_map_link($atts);
+				break;
+		}
+		return '';
+	}
+
+
+	/**
+	 * Generates the attributes for retrieving a google_map artifact.
+	 *
+	 * @param EE_Venue $venue
+	 * @param string   $field
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function get_map_attributes(EE_Venue $venue, $field = 'gmap_link')
+	{
+		$state = $venue->state_obj();
+		$country = $venue->country_obj();
+		$atts = array(
+			'id'      => $venue->ID(),
+			'address' => $venue->get('VNU_address'),
+			'city'    => $venue->get('VNU_city'),
+			'state'   => is_object($state) ? $state->get('STA_name') : '',
+			'zip'     => $venue->get('VNU_zip'),
+			'country' => is_object($country) ? $country->get('CNT_name') : '',
+			'type'    => $field === 'gmap_link' ? 'url' : 'map',
+			'map_w'   => 200,
+			'map_h'   => 200,
+		);
+		if ($field === 'gmap_url') {
+			$atts['type'] = 'url_only';
+		}
+		return $atts;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -88,7 +88,7 @@ 
     {
         $this->_venue = $this->_get_venue();
         // If there is no venue object by now then get out.
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         }
 
@@ -184,7 +184,7 @@ 
 
         // if no event, then let's see if there is a reg_obj.  If there IS, then we'll try and grab the event from the
         // reg_obj instead.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             $aee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
             $aee = $this->_extra_data instanceof EE_Messages_Addressee ? $this->_extra_data : $aee;
 
@@ -196,7 +196,7 @@ 
             $this->_event = ! $this->_event instanceof EE_Event
                             && $this->_data instanceof EE_Ticket
                             && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->tickets[ $this->_data->ID() ]['EE_Event']
+                ? $this->_extra_data['data']->tickets[$this->_data->ID()]['EE_Event']
                 : $this->_event;
 
             // if STILL empty event, let's try to get the first event in the list of events via EE_Messages_Addressee
@@ -225,7 +225,7 @@ 
     private function _venue($field)
     {
 
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         } //no venue so get out.
 
@@ -248,11 +248,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $this->_venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$this->_venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $this->_venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

core/libraries/form_sections/inputs/EE_Radio_Button_Input.input.php

Indentation +17 added lines, -17 removed lines

@@ -15,22 +15,22 @@
 class EE_Radio_Button_Input extends EE_Form_Input_With_Options_Base
 {
 
-    /**
-     * @param array $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
-        $this->_add_validation_strategy(
-            new EE_Enum_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        $this->_multiple_selections = false;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Radio_Button_Display_Strategy());
+		$this->_add_validation_strategy(
+			new EE_Enum_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		$this->_multiple_selections = false;
+		parent::__construct($answer_options, $input_settings);
+	}
 
 }

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
             )
         );
         parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' datepicker');
+        $this->set_html_class($this->html_class().' datepicker');
         // add some style and make it dance
         add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
         add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
@@ -48,7 +48,7 @@ 
         // load css
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );

Indentation +38 added lines, -38 removed lines

@@ -10,45 +10,45 @@
 class EE_Datepicker_Input extends EE_Form_Input_Base
 {
 
-    /**
-     * @param array $input_settings
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        // we could do better for validation, but at least verify its plaintext
-        $this->_add_validation_strategy(
-            new EE_Plaintext_Validation_Strategy(
-                isset($input_settings['validation_error_message'])
-                    ? $input_settings['validation_error_message']
-                    : null
-            )
-        );
-        parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . ' datepicker');
-        // add some style and make it dance
-        add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
-        add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
-    }
+	/**
+	 * @param array $input_settings
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		// we could do better for validation, but at least verify its plaintext
+		$this->_add_validation_strategy(
+			new EE_Plaintext_Validation_Strategy(
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
+					: null
+			)
+		);
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class() . ' datepicker');
+		// add some style and make it dance
+		add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+		add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+	}
 
 
 
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-    }
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+	}
 }

public/Espresso_Arabica_2014/loop-espresso_event_attendees.php

Indentation +18 added lines, -18 removed lines

@@ -22,15 +22,15 @@ 
 
 <div class="event-attendees">
     <?php do_action_ref_array(
-        'AHEE__loop-espresso_event_attendees__before',
-        array(
-            $contacts,
-            $event,
-            $datetime,
-            $ticket,
-            $show_gravatar,
-        )
-    ); ?>
+		'AHEE__loop-espresso_event_attendees__before',
+		array(
+			$contacts,
+			$event,
+			$datetime,
+			$ticket,
+			$show_gravatar,
+		)
+	); ?>
 	<?php if ( $contacts ) : ?>
 		<ul class="event-attendees-list">
 			<?php foreach( $contacts as $contact ) :
@@ -47,13 +47,13 @@ 
 		<p><?php echo $no_attendees_message; ?></p>
 	<?php endif; ?>
     <?php do_action_ref_array(
-        'AHEE__loop-espresso_event_attendees__after',
-        array(
-            $contacts,
-            $event,
-            $datetime,
-            $ticket,
-            $show_gravatar,
-        )
-    ); ?>
+		'AHEE__loop-espresso_event_attendees__after',
+		array(
+			$contacts,
+			$event,
+			$datetime,
+			$ticket,
+			$show_gravatar,
+		)
+	); ?>
 </div>
\ No newline at end of file

Spacing +5 added lines, -5 removed lines

@@ -15,7 +15,7 @@ 
  * @type bool       $show_gravatar  whether to show gravatar or not.
  */
 
-$no_attendees_message =  apply_filters( 'FHEE__loop-espresso_attendees-shortcode__template__no_attendees_message', __('No Attendees Yet', 'event_espresso' ) );
+$no_attendees_message = apply_filters('FHEE__loop-espresso_attendees-shortcode__template__no_attendees_message', __('No Attendees Yet', 'event_espresso'));
 
 
 ?>
@@ -31,16 +31,16 @@ 
             $show_gravatar,
         )
     ); ?>
-	<?php if ( $contacts ) : ?>
+	<?php if ($contacts) : ?>
 		<ul class="event-attendees-list">
-			<?php foreach( $contacts as $contact ) :
-				EEH_Template::get_template_part( 'content', 'espresso_event_attendees', array( 
+			<?php foreach ($contacts as $contact) :
+				EEH_Template::get_template_part('content', 'espresso_event_attendees', array( 
 					'contact'       => $contact, 
 					'event'         => $event,
 					'datetime'      => $datetime,
 					'ticket'        => $ticket,
 					'show_gravatar' => $show_gravatar 
-				) );
+				));
 				endforeach; ?>
 		</ul>
 	<?php else : ?>

Braces +5 added lines, -2 removed lines

@@ -43,8 +43,11 @@
 				) );
 				endforeach; ?>
 		</ul>
-	<?php else : ?>
-		<p><?php echo $no_attendees_message; ?></p>
+	<?php else {
+	: ?>
+		<p><?php echo $no_attendees_message;
+}
+?></p>
 	<?php endif; ?>
     <?php do_action_ref_array(
         'AHEE__loop-espresso_event_attendees__after',

core/business/EE_Registration_Processor.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -734,7 +734,7 @@
      * @since 4.9.1
      * @param int                   $att_nmbr
      * @param EE_Line_Item | string $item
-     * @return string
+     * @return RegUrlLink
      * @throws InvalidArgumentException
      */
     public function generate_reg_url_link($att_nmbr, $item)

Indentation +763 added lines, -763 removed lines

@@ -24,767 +24,767 @@
 class EE_Registration_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * initial reg status at the beginning of this request.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_old_reg_status = array();
-
-    /**
-     * reg status at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected $_new_reg_status = array();
-
-    /**
-     * amounts paid at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected static $_amount_paid = array();
-
-    /**
-     * Cache of the reg final price for registrations corresponding to a ticket line item
-     *
-     * @deprecated
-     * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
-     */
-    protected $_reg_final_price_per_tkt_line_item;
-
-    /**
-     * @var EE_Request $request
-     */
-    protected $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Request|null $request
-     * @return EE_Registration_Processor instance
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public static function instance(EE_Request $request = null)
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof EE_Request) {
-                $request = LoaderFactory::getLoader()->getShared('EE_Request');
-            }
-            self::$_instance = new self($request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * EE_Registration_Processor constructor.
-     *
-     * @param EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function old_reg_status($REG_ID)
-    {
-        return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $old_reg_status
-     */
-    public function set_old_reg_status($REG_ID, $old_reg_status)
-    {
-        // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
-        }
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function new_reg_status($REG_ID)
-    {
-        return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $new_reg_status
-     */
-    public function set_new_reg_status($REG_ID, $new_reg_status)
-    {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @param int $REG_ID
-     * @return bool
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
-    {
-        $this->toggle_incomplete_registration_status_to_default($registration, false);
-        $this->toggle_registration_status_for_default_approved_events($registration, false);
-        $this->toggle_registration_status_if_no_monies_owing($registration, false);
-        $registration->save();
-        // trigger notifications
-        $this->trigger_registration_update_notifications($registration);
-    }
-
-
-    /**
-     *    manually_update_registration_status
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param string          $new_reg_status
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function manually_update_registration_status(
-        EE_Registration $registration,
-        $new_reg_status = '',
-        $save = true
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // set incoming REG_Status
-        $this->set_new_reg_status($registration->ID(), $new_reg_status);
-        // toggle reg status but only if it has changed and the user can do so
-        if ($this->reg_status_updated($registration->ID())
-            && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
-                || EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_registration',
-                    'toggle_registration_status',
-                    $registration->ID()
-                )
-            )
-        ) {
-            // change status to new value
-            $updated = $registration->set_status($this->new_reg_status($registration->ID()));
-            if ($updated && $save) {
-                $registration->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    toggle_incomplete_registration_status_to_default
-     *        changes any incomplete registrations to either the event or global default registration status
-     *
-     * @access public
-     * @param EE_Registration       $registration
-     * @param bool                  $save TRUE will save the registration if the status is updated, FALSE will leave
-     *                                    that up to client code
-     * @param ContextInterface|null $context
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_incomplete_registration_status_to_default(
-        EE_Registration $registration,
-        $save = true,
-        ContextInterface $context = null
-    ) {
-        $existing_reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $existing_reg_status);
-        // is the registration currently incomplete ?
-        if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
-            // grab default reg status for the event, if set
-            $event_default_registration_status = $registration->event()->default_registration_status();
-            // if no default reg status is set for the event, then use the global value
-            $STS_ID = ! empty($event_default_registration_status)
-                ? $event_default_registration_status
-                : EE_Registry::instance()->CFG->registration->default_STS_ID;
-            // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
-            $STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
-                : $STS_ID;
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), $STS_ID);
-            $registration->set_status($STS_ID, false, $context);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-        }
-    }
-
-
-    /**
-     *    toggle_registration_status_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
-    {
-        $reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $reg_status);
-        // if not already, toggle reg status to approved IF the event default reg status is approved
-        // ( as long as the registration wasn't cancelled or declined at some point )
-        if ($reg_status !== EEM_Registration::status_id_cancelled
-            && $reg_status
-               !== EEM_Registration::status_id_declined
-            && $reg_status !== EEM_Registration::status_id_approved
-            && $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
-        ) {
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
-     *                              to client code
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_if_no_monies_owing(
-        EE_Registration $registration,
-        $save = true,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // was a payment just made ?
-        $payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
-                   && $additional_details['payment_updates']
-                   && $additional_details['last_payment'] instanceof EE_Payment
-            ? $additional_details['last_payment']
-            : null;
-        $total_paid = array_sum(self::$_amount_paid);
-        // toggle reg status to approved IF
-        if (// REG status is pending payment
-            $registration->status_ID() === EEM_Registration::status_id_pending_payment
-            // AND no monies are owing
-            && (
-                (
-                    $registration->transaction()->is_completed()
-                    || $registration->transaction()->is_overpaid()
-                    || $registration->transaction()->is_free()
-                    || apply_filters(
-                        'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
-                        false,
-                        $registration
-                    )
-                )
-                || (
-                    $payment instanceof EE_Payment && $payment->is_approved()
-                    && // this specific registration has not yet been paid for
-                    ! isset(self::$_amount_paid[ $registration->ID() ])
-                    && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
-                    $payment->amount() - $total_paid >= $registration->final_price()
-                )
-            )
-        ) {
-            // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
-            // track new REG_Status
-            $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
-            // toggle status to approved
-            $registration->set_status(EEM_Registration::status_id_approved);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    registration_status_changed
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return void
-     */
-    public function trigger_registration_update_notifications($registration, array $additional_details = array())
-    {
-        try {
-            if (! $registration instanceof EE_Registration) {
-                throw new EE_Error(
-                    esc_html__('An invalid registration was received.', 'event_espresso')
-                );
-            }
-            // EE_Registry::instance()->load_helper('Debug_Tools');
-            // EEH_Debug_Tools::log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     array($registration->transaction(), $additional_details),
-            //     false,
-            //     'EE_Transaction: ' . $registration->transaction()->ID()
-            // );
-            if (! $registration->is_primary_registrant()) {
-                return;
-            }
-            do_action(
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-                $registration,
-                $additional_details
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
-        }
-    }
-
-
-    /**
-     * sets reg status based either on passed param or on transaction status and event pre-approval setting
-     *
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_after_checkout_or_payment(
-        EE_Registration $registration,
-        array $additional_details = array()
-    ) {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // if the registration status gets updated, then save the registration
-        if ($this->toggle_registration_status_for_default_approved_events($registration, false)
-            || $this->toggle_registration_status_if_no_monies_owing(
-                $registration,
-                false,
-                $additional_details
-            )
-        ) {
-            $registration->save();
-        }
-        // set new  REG_Status
-        $this->set_new_reg_status($registration->ID(), $registration->status_ID());
-        return $this->reg_status_updated($registration->ID())
-               && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
-    }
-
-
-    /**
-     * Updates the registration' final prices based on the current line item tree (taking into account
-     * discounts, taxes, and other line items unrelated to tickets.)
-     *
-     * @param EE_Transaction $transaction
-     * @param boolean        $save_regs whether to immediately save registrations in this function or not
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function update_registration_final_prices($transaction, $save_regs = true)
-    {
-        $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-            $transaction->total_line_item()
-        );
-        foreach ($transaction->registrations() as $registration) {
-            /** @var EE_Line_Item $line_item */
-            $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
-                if ($save_regs) {
-                    $registration->save();
-                }
-            }
-        }
-        // and make sure there's no rounding problem
-        $this->fix_reg_final_price_rounding_issue($transaction);
-    }
-
-
-    /**
-     * Makes sure there is no rounding errors for the REG_final_prices.
-     * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
-     * they will each be for $0.99333333, which gets rounded to $1 again.
-     * So the transaction total will be $2.99, but each registration will be for $1,
-     * so if each registrant paid individually they will have overpaid by $0.01.
-     * So in order to overcome this, we check for any difference, and if there is a difference
-     * we just grab one registrant at random and make them responsible for it.
-     * This should be used after setting REG_final_prices (it's done automatically as part of
-     * EE_Registration_Processor::update_registration_final_prices())
-     *
-     * @param EE_Transaction $transaction
-     * @return bool success verifying that there is NO difference after this method is done
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function fix_reg_final_price_rounding_issue($transaction)
-    {
-        $reg_final_price_sum = EEM_Registration::instance()->sum(
-            array(
-                array(
-                    'TXN_ID' => $transaction->ID(),
-                ),
-            ),
-            'REG_final_price'
-        );
-        $diff = $transaction->total() - $reg_final_price_sum;
-        // ok then, just grab one of the registrations
-        if ($diff !== 0) {
-            $a_reg = EEM_Registration::instance()->get_one(
-                array(
-                    array(
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                )
-            );
-            return $a_reg instanceof EE_Registration
-                ? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
-                : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * update_registration_after_being_canceled_or_declined
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_registration_after_being_canceled_or_declined(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
-        $registration->set_final_price(0);
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * update_canceled_or_declined_registration_after_being_reinstated
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function update_canceled_or_declined_registration_after_being_reinstated(
-        EE_Registration $registration,
-        array $closed_reg_statuses = array(),
-        $update_reg = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket for Registration %1$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        $registration->set_final_price($ticket->price());
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * generate_ONE_registration_from_line_item
-     * Although a ticket line item may have a quantity greater than 1,
-     * this method will ONLY CREATE ONE REGISTRATION !!!
-     * Regardless of the ticket line item quantity.
-     * This means that any code calling this method is responsible for ensuring
-     * that the final registration count matches the ticket line item quantity.
-     * This was done to make it easier to match the number of registrations
-     * to the number of tickets in the cart, when the cart has been edited
-     * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
-     * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Line_Item    $line_item
-     * @param \EE_Transaction $transaction
-     * @param int             $att_nmbr
-     * @param int             $total_ticket_count
-     * @return EE_Registration | null
-     * @throws \OutOfRangeException
-     * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function generate_ONE_registration_from_line_item(
-        EE_Line_Item $line_item,
-        EE_Transaction $transaction,
-        $att_nmbr = 1,
-        $total_ticket_count = 1
-    ) {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // grab the related ticket object for this line_item
-        $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $line_item->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $registration_service = new CreateRegistrationService();
-        // then generate a new registration from that
-        return $registration_service->create(
-            $ticket->get_related_event(),
-            $transaction,
-            $ticket,
-            $line_item,
-            $att_nmbr,
-            $total_ticket_count
-        );
-    }
-
-
-    /**
-     * generates reg_url_link
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param int                   $att_nmbr
-     * @param EE_Line_Item | string $item
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_url_link($att_nmbr, $item)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegUrlLink'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return new RegUrlLink($att_nmbr, $item);
-    }
-
-
-    /**
-     * generates reg code
-     *
-     * @deprecated
-     * @since 4.9.1
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     */
-    public function generate_reg_code(EE_Registration $registration)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EventEspresso\core\domain\entities\RegCode'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        return apply_filters(
-            'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
-            new RegCode(
-                RegUrlLink::fromRegistration($registration),
-                $registration->transaction(),
-                $registration->ticket()
-            ),
-            $registration
-        );
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * initial reg status at the beginning of this request.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_old_reg_status = array();
+
+	/**
+	 * reg status at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected $_new_reg_status = array();
+
+	/**
+	 * amounts paid at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected static $_amount_paid = array();
+
+	/**
+	 * Cache of the reg final price for registrations corresponding to a ticket line item
+	 *
+	 * @deprecated
+	 * @var array @see EEH_Line_Item::calculate_reg_final_prices_per_line_item()'s return value
+	 */
+	protected $_reg_final_price_per_tkt_line_item;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Request|null $request
+	 * @return EE_Registration_Processor instance
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public static function instance(EE_Request $request = null)
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registration_Processor) {
+			if (! $request instanceof EE_Request) {
+				$request = LoaderFactory::getLoader()->getShared('EE_Request');
+			}
+			self::$_instance = new self($request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * EE_Registration_Processor constructor.
+	 *
+	 * @param EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function old_reg_status($REG_ID)
+	{
+		return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $old_reg_status
+	 */
+	public function set_old_reg_status($REG_ID, $old_reg_status)
+	{
+		// only set the first time
+		if (! isset($this->_old_reg_status[ $REG_ID ])) {
+			$this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+		}
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function new_reg_status($REG_ID)
+	{
+		return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $new_reg_status
+	 */
+	public function set_new_reg_status($REG_ID, $new_reg_status)
+	{
+		$this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @param int $REG_ID
+	 * @return bool
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
+	{
+		$this->toggle_incomplete_registration_status_to_default($registration, false);
+		$this->toggle_registration_status_for_default_approved_events($registration, false);
+		$this->toggle_registration_status_if_no_monies_owing($registration, false);
+		$registration->save();
+		// trigger notifications
+		$this->trigger_registration_update_notifications($registration);
+	}
+
+
+	/**
+	 *    manually_update_registration_status
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param string          $new_reg_status
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function manually_update_registration_status(
+		EE_Registration $registration,
+		$new_reg_status = '',
+		$save = true
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// set incoming REG_Status
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
+		// toggle reg status but only if it has changed and the user can do so
+		if ($this->reg_status_updated($registration->ID())
+			&& (
+				(! $this->request->isAdmin() || $this->request->isFrontAjax())
+				|| EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_registration',
+					'toggle_registration_status',
+					$registration->ID()
+				)
+			)
+		) {
+			// change status to new value
+			$updated = $registration->set_status($this->new_reg_status($registration->ID()));
+			if ($updated && $save) {
+				$registration->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    toggle_incomplete_registration_status_to_default
+	 *        changes any incomplete registrations to either the event or global default registration status
+	 *
+	 * @access public
+	 * @param EE_Registration       $registration
+	 * @param bool                  $save TRUE will save the registration if the status is updated, FALSE will leave
+	 *                                    that up to client code
+	 * @param ContextInterface|null $context
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_incomplete_registration_status_to_default(
+		EE_Registration $registration,
+		$save = true,
+		ContextInterface $context = null
+	) {
+		$existing_reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $existing_reg_status);
+		// is the registration currently incomplete ?
+		if ($registration->status_ID() === EEM_Registration::status_id_incomplete) {
+			// grab default reg status for the event, if set
+			$event_default_registration_status = $registration->event()->default_registration_status();
+			// if no default reg status is set for the event, then use the global value
+			$STS_ID = ! empty($event_default_registration_status)
+				? $event_default_registration_status
+				: EE_Registry::instance()->CFG->registration->default_STS_ID;
+			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
+			$STS_ID = $STS_ID === EEM_Registration::status_id_approved ? EEM_Registration::status_id_pending_payment
+				: $STS_ID;
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$registration->set_status($STS_ID, false, $context);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+		}
+	}
+
+
+	/**
+	 *    toggle_registration_status_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_for_default_approved_events(EE_Registration $registration, $save = true)
+	{
+		$reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $reg_status);
+		// if not already, toggle reg status to approved IF the event default reg status is approved
+		// ( as long as the registration wasn't cancelled or declined at some point )
+		if ($reg_status !== EEM_Registration::status_id_cancelled
+			&& $reg_status
+			   !== EEM_Registration::status_id_declined
+			&& $reg_status !== EEM_Registration::status_id_approved
+			&& $registration->event()->default_registration_status() === EEM_Registration::status_id_approved
+		) {
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $save TRUE will save the registration if the status is updated, FALSE will leave that up
+	 *                              to client code
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_if_no_monies_owing(
+		EE_Registration $registration,
+		$save = true,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// was a payment just made ?
+		$payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+				   && $additional_details['payment_updates']
+				   && $additional_details['last_payment'] instanceof EE_Payment
+			? $additional_details['last_payment']
+			: null;
+		$total_paid = array_sum(self::$_amount_paid);
+		// toggle reg status to approved IF
+		if (// REG status is pending payment
+			$registration->status_ID() === EEM_Registration::status_id_pending_payment
+			// AND no monies are owing
+			&& (
+				(
+					$registration->transaction()->is_completed()
+					|| $registration->transaction()->is_overpaid()
+					|| $registration->transaction()->is_free()
+					|| apply_filters(
+						'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
+						false,
+						$registration
+					)
+				)
+				|| (
+					$payment instanceof EE_Payment && $payment->is_approved()
+					&& // this specific registration has not yet been paid for
+					! isset(self::$_amount_paid[ $registration->ID() ])
+					&& // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
+					$payment->amount() - $total_paid >= $registration->final_price()
+				)
+			)
+		) {
+			// mark as paid
+			self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+			// track new REG_Status
+			$this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
+			// toggle status to approved
+			$registration->set_status(EEM_Registration::status_id_approved);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    registration_status_changed
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return void
+	 */
+	public function trigger_registration_update_notifications($registration, array $additional_details = array())
+	{
+		try {
+			if (! $registration instanceof EE_Registration) {
+				throw new EE_Error(
+					esc_html__('An invalid registration was received.', 'event_espresso')
+				);
+			}
+			// EE_Registry::instance()->load_helper('Debug_Tools');
+			// EEH_Debug_Tools::log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     array($registration->transaction(), $additional_details),
+			//     false,
+			//     'EE_Transaction: ' . $registration->transaction()->ID()
+			// );
+			if (! $registration->is_primary_registrant()) {
+				return;
+			}
+			do_action(
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+				$registration,
+				$additional_details
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
+		}
+	}
+
+
+	/**
+	 * sets reg status based either on passed param or on transaction status and event pre-approval setting
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_checkout_or_payment(
+		EE_Registration $registration,
+		array $additional_details = array()
+	) {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// if the registration status gets updated, then save the registration
+		if ($this->toggle_registration_status_for_default_approved_events($registration, false)
+			|| $this->toggle_registration_status_if_no_monies_owing(
+				$registration,
+				false,
+				$additional_details
+			)
+		) {
+			$registration->save();
+		}
+		// set new  REG_Status
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID())
+			   && $this->new_reg_status($registration->ID()) === EEM_Registration::status_id_approved;
+	}
+
+
+	/**
+	 * Updates the registration' final prices based on the current line item tree (taking into account
+	 * discounts, taxes, and other line items unrelated to tickets.)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param boolean        $save_regs whether to immediately save registrations in this function or not
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_final_prices($transaction, $save_regs = true)
+	{
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+			$transaction->total_line_item()
+		);
+		foreach ($transaction->registrations() as $registration) {
+			/** @var EE_Line_Item $line_item */
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+				if ($save_regs) {
+					$registration->save();
+				}
+			}
+		}
+		// and make sure there's no rounding problem
+		$this->fix_reg_final_price_rounding_issue($transaction);
+	}
+
+
+	/**
+	 * Makes sure there is no rounding errors for the REG_final_prices.
+	 * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
+	 * they will each be for $0.99333333, which gets rounded to $1 again.
+	 * So the transaction total will be $2.99, but each registration will be for $1,
+	 * so if each registrant paid individually they will have overpaid by $0.01.
+	 * So in order to overcome this, we check for any difference, and if there is a difference
+	 * we just grab one registrant at random and make them responsible for it.
+	 * This should be used after setting REG_final_prices (it's done automatically as part of
+	 * EE_Registration_Processor::update_registration_final_prices())
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return bool success verifying that there is NO difference after this method is done
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function fix_reg_final_price_rounding_issue($transaction)
+	{
+		$reg_final_price_sum = EEM_Registration::instance()->sum(
+			array(
+				array(
+					'TXN_ID' => $transaction->ID(),
+				),
+			),
+			'REG_final_price'
+		);
+		$diff = $transaction->total() - $reg_final_price_sum;
+		// ok then, just grab one of the registrations
+		if ($diff !== 0) {
+			$a_reg = EEM_Registration::instance()->get_one(
+				array(
+					array(
+						'TXN_ID' => $transaction->ID(),
+					),
+				)
+			);
+			return $a_reg instanceof EE_Registration
+				? (bool) $a_reg->save(array('REG_final_price' => $a_reg->final_price() + $diff))
+				: false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * update_registration_after_being_canceled_or_declined
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_being_canceled_or_declined(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		// release a reserved ticket by decrementing ticket and datetime reserved values
+		$registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+		$registration->set_final_price(0);
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * update_canceled_or_declined_registration_after_being_reinstated
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function update_canceled_or_declined_registration_after_being_reinstated(
+		EE_Registration $registration,
+		array $closed_reg_statuses = array(),
+		$update_reg = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		$ticket = $registration->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Ticket for Registration %1$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		$registration->set_final_price($ticket->price());
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * generate_ONE_registration_from_line_item
+	 * Although a ticket line item may have a quantity greater than 1,
+	 * this method will ONLY CREATE ONE REGISTRATION !!!
+	 * Regardless of the ticket line item quantity.
+	 * This means that any code calling this method is responsible for ensuring
+	 * that the final registration count matches the ticket line item quantity.
+	 * This was done to make it easier to match the number of registrations
+	 * to the number of tickets in the cart, when the cart has been edited
+	 * after SPCO has already been initialized. So if an additional ticket was added to the cart, you can simply pass
+	 * the line item to this method to add a second ticket, and in this case, you would not want to add 2 tickets.
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Line_Item    $line_item
+	 * @param \EE_Transaction $transaction
+	 * @param int             $att_nmbr
+	 * @param int             $total_ticket_count
+	 * @return EE_Registration | null
+	 * @throws \OutOfRangeException
+	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function generate_ONE_registration_from_line_item(
+		EE_Line_Item $line_item,
+		EE_Transaction $transaction,
+		$att_nmbr = 1,
+		$total_ticket_count = 1
+	) {
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// grab the related ticket object for this line_item
+		$ticket = $line_item->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$line_item->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$registration_service = new CreateRegistrationService();
+		// then generate a new registration from that
+		return $registration_service->create(
+			$ticket->get_related_event(),
+			$transaction,
+			$ticket,
+			$line_item,
+			$att_nmbr,
+			$total_ticket_count
+		);
+	}
+
+
+	/**
+	 * generates reg_url_link
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param int                   $att_nmbr
+	 * @param EE_Line_Item | string $item
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_url_link($att_nmbr, $item)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegUrlLink'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return new RegUrlLink($att_nmbr, $item);
+	}
+
+
+	/**
+	 * generates reg code
+	 *
+	 * @deprecated
+	 * @since 4.9.1
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 */
+	public function generate_reg_code(EE_Registration $registration)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EventEspresso\core\domain\entities\RegCode'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		return apply_filters(
+			'FHEE__EE_Registration_Processor___generate_reg_code__new_reg_code',
+			new RegCode(
+				RegUrlLink::fromRegistration($registration),
+				$registration->transaction(),
+				$registration->ticket()
+			),
+			$registration
+		);
+	}
 }

Spacing +24 added lines, -24 removed lines

@@ -79,8 +79,8 @@ 
     public static function instance(EE_Request $request = null)
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof EE_Request) {
+        if ( ! self::$_instance instanceof EE_Registration_Processor) {
+            if ( ! $request instanceof EE_Request) {
                 $request = LoaderFactory::getLoader()->getShared('EE_Request');
             }
             self::$_instance = new self($request);
@@ -106,7 +106,7 @@ 
      */
     public function old_reg_status($REG_ID)
     {
-        return isset($this->_old_reg_status[ $REG_ID ]) ? $this->_old_reg_status[ $REG_ID ] : null;
+        return isset($this->_old_reg_status[$REG_ID]) ? $this->_old_reg_status[$REG_ID] : null;
     }
 
 
@@ -117,8 +117,8 @@ 
     public function set_old_reg_status($REG_ID, $old_reg_status)
     {
         // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+        if ( ! isset($this->_old_reg_status[$REG_ID])) {
+            $this->_old_reg_status[$REG_ID] = $old_reg_status;
         }
     }
 
@@ -129,7 +129,7 @@ 
      */
     public function new_reg_status($REG_ID)
     {
-        return isset($this->_new_reg_status[ $REG_ID ]) ? $this->_new_reg_status[ $REG_ID ] : null;
+        return isset($this->_new_reg_status[$REG_ID]) ? $this->_new_reg_status[$REG_ID] : null;
     }
 
 
@@ -139,7 +139,7 @@ 
      */
     public function set_new_reg_status($REG_ID, $new_reg_status)
     {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+        $this->_new_reg_status[$REG_ID] = $new_reg_status;
     }
 
 
@@ -205,7 +205,7 @@ 
         // toggle reg status but only if it has changed and the user can do so
         if ($this->reg_status_updated($registration->ID())
             && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
+                ( ! $this->request->isAdmin() || $this->request->isFrontAjax())
                 || EE_Registry::instance()->CAP->current_user_can(
                     'ee_edit_registration',
                     'toggle_registration_status',
@@ -268,7 +268,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -326,7 +326,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -398,14 +398,14 @@ 
                 || (
                     $payment instanceof EE_Payment && $payment->is_approved()
                     && // this specific registration has not yet been paid for
-                    ! isset(self::$_amount_paid[ $registration->ID() ])
+                    ! isset(self::$_amount_paid[$registration->ID()])
                     && // payment amount, less what we have already attributed to other registrations, is greater than this reg's final price
                     $payment->amount() - $total_paid >= $registration->final_price()
                 )
             )
         ) {
             // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+            self::$_amount_paid[$registration->ID()] = $registration->final_price();
             // track new REG_Status
             $this->set_new_reg_status($registration->ID(), EEM_Registration::status_id_approved);
             // toggle status to approved
@@ -414,7 +414,7 @@ 
                 $registration->save();
             }
             // don't trigger notifications during IPNs because they will get triggered by EE_Payment_Processor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true', 10);
             }
@@ -448,7 +448,7 @@ 
     public function trigger_registration_update_notifications($registration, array $additional_details = array())
     {
         try {
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 throw new EE_Error(
                     esc_html__('An invalid registration was received.', 'event_espresso')
                 );
@@ -462,7 +462,7 @@ 
             //     false,
             //     'EE_Transaction: ' . $registration->transaction()->ID()
             // );
-            if (! $registration->is_primary_registrant()) {
+            if ( ! $registration->is_primary_registrant()) {
                 return;
             }
             do_action(
@@ -534,8 +534,8 @@ 
         foreach ($transaction->registrations() as $registration) {
             /** @var EE_Line_Item $line_item */
             $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+            if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+                $registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
                 if ($save_regs) {
                     $registration->save();
                 }
@@ -611,11 +611,11 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+        $registration->release_reserved_ticket(true, 'RegProcessor:'.__LINE__);
         $registration->set_final_price(0);
         if ($update_reg) {
             $registration->save();
@@ -646,7 +646,7 @@ 
             return false;
         }
         $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -695,7 +695,7 @@ 
         $total_ticket_count = 1
     ) {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 '\EventEspresso\core\domain\services\registration\CreateRegistrationService::create()'
@@ -705,7 +705,7 @@ 
         );
         // grab the related ticket object for this line_item
         $ticket = $line_item->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
@@ -743,7 +743,7 @@ 
     public function generate_reg_url_link($att_nmbr, $item)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegUrlLink'
@@ -769,7 +769,7 @@ 
     public function generate_reg_code(EE_Registration $registration)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EventEspresso\core\domain\entities\RegCode'

core/admin/EE_Admin_Hooks.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -222,7 +222,7 @@
     /**
      * constructor
      *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
+     * @param EE_Admin_Page $adminpage the calling admin_page_object
      */
     public function __construct(EE_Admin_Page $adminpage)
     {

Indentation +703 added lines, -703 removed lines

@@ -13,707 +13,707 @@
 {
 
 
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     *
-     * @var string
-     */
-    public $caller;
-
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     *
-     * @var bool
-     */
-    protected $_extend;
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     *
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_ajax_func;
-
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_init_func;
-
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
-     *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
-     *        will be added to each route.
-     *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
-     *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
-     *        method arguments.
-     *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
-     *        automatically)
-     *        'priority' => 'default', //default 'default' (optional)
-     *        'label' => __('Localized Title', 'event_espresso'),
-     *        'context' => 'advanced' //advanced is default (optional),
-     *    'callback_args' => array() //any callback args to include (optional)
-     * )
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     *
-     * @var array
-     */
-    protected $_metaboxes;
-
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_remove_metaboxes;
-
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => __('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_scripts_styles;
-
-
-    /**
-     * This is a property that will contain the current route.
-     *
-     * @var string;
-     */
-    protected $_current_route;
-
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_wp_action_filters_priority;
-
-
-    /**
-     * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
-     *
-     * @var array
-     */
-    protected $_req_data;
-
-
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT
-     */
-    protected $_adminpage_obj;
-
-
-    /**
-     * Holds EE_Registry object
-     *
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
-     */
-    public function __construct(EE_Admin_Page $adminpage)
-    {
-
-        $this->_adminpage_obj = $adminpage;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
-            || (isset($this->_req_data['page'])
-                && $this->_adminpage_obj->page_slug
-                   != $this->_req_data['page'])) {
-            return;
-        } //get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
-        add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @access protected
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @access public
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = __(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    __(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $defaults = array(
-                    'type'    => 'js',
-                    'url'     => '',
-                    'depends' => array(),
-                    'version' => EVENT_ESPRESSO_VERSION,
-                    'footer'  => true,
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        __('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        __(
-                            'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                        $ref,
-                        $url,
-                        $depends,
-                        $version
-                    );
-            }
-            // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = array(
-                    'type' => 'js',
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                $type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
-        $this->_current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        $this->caller = get_class($this);
-        $this->_extend = stripos($this->caller, 'Extend') ? true : false;
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_object()
-    {
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
-        }
-        // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
-        // let's make sure the class exists
-        if (! class_exists($ref)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $ref
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $a = new ReflectionClass($ref);
-        $this->_page_object = $a->newInstance(false);
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (method_exists($this, $method_callback)) {
-            call_user_func(array($this, $method_callback));
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
-                10
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
-                10
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = array(
-            'admin_footer'                                                                            => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views'                                                                   => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-        );
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop throught the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    private function _ajax_hooks()
-    {
-
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _ajax_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, array($this, $method));
-        }
-    }
-
-
-    /**
-     * Loop throught the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _init_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', array($this, $method));
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @access public
-     * @return void
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    private function _handle_metabox_array($boxes, $add = true)
-    {
-
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            } //we dont' have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @access public
-     * @return void
-     */
-    public function remove_metaboxes()
-    {
-
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @access private
-     * @param array $args an array of args that have been set for this metabox by the child class
-     */
-    private function _add_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
-            'priority'      => 'default',
-            'label'         => $this->caller,
-            'context'       => 'advanced',
-            'callback_args' => array(),
-            'page'          => isset($args['page']) ? $args['page'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
-            $msg[] = sprintf(
-                __(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $func,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so lets add the metabox
-        add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'id'      => isset($args['id'])
-                ? $args['id']
-                : $this->_current_route
-                  . '_'
-                  . $this->caller
-                  . '_'
-                  . $func
-                  . '_metabox',
-            'context' => 'default',
-            'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 *
+	 * @var string
+	 */
+	public $caller;
+
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 *
+	 * @var bool
+	 */
+	protected $_extend;
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_ajax_func;
+
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_init_func;
+
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
+	 *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
+	 *        will be added to each route.
+	 *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
+	 *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
+	 *        method arguments.
+	 *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
+	 *        automatically)
+	 *        'priority' => 'default', //default 'default' (optional)
+	 *        'label' => __('Localized Title', 'event_espresso'),
+	 *        'context' => 'advanced' //advanced is default (optional),
+	 *    'callback_args' => array() //any callback args to include (optional)
+	 * )
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 *
+	 * @var array
+	 */
+	protected $_metaboxes;
+
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_remove_metaboxes;
+
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => __('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_scripts_styles;
+
+
+	/**
+	 * This is a property that will contain the current route.
+	 *
+	 * @var string;
+	 */
+	protected $_current_route;
+
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_wp_action_filters_priority;
+
+
+	/**
+	 * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
+	 *
+	 * @var array
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT
+	 */
+	protected $_adminpage_obj;
+
+
+	/**
+	 * Holds EE_Registry object
+	 *
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page the calling admin_page_object
+	 */
+	public function __construct(EE_Admin_Page $adminpage)
+	{
+
+		$this->_adminpage_obj = $adminpage;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// first let's verify we're on the right page
+		if (! isset($this->_req_data['page'])
+			|| (isset($this->_req_data['page'])
+				&& $this->_adminpage_obj->page_slug
+				   != $this->_req_data['page'])) {
+			return;
+		} //get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		$this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
+		add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = __(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$defaults = array(
+					'type'    => 'js',
+					'url'     => '',
+					'depends' => array(),
+					'version' => EVENT_ESPRESSO_VERSION,
+					'footer'  => true,
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				// let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						__(
+							'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+						$ref,
+						$url,
+						$depends,
+						$version
+					);
+			}
+			// k now lets do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = array(
+					'type' => 'js',
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				$type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
+		$this->_current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		$this->caller = get_class($this);
+		$this->_extend = stripos($this->caller, 'Extend') ? true : false;
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_object()
+	{
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
+		$ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
+		}
+		// if we've got an extended class we use that!
+		$ref = $this->_extend ? 'Extend_' . $ref : $ref;
+		// let's make sure the class exists
+		if (! class_exists($ref)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$ref
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$a = new ReflectionClass($ref);
+		$this->_page_object = $a->newInstance(false);
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (method_exists($this, $method_callback)) {
+			call_user_func(array($this, $method_callback));
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				array($this, '_redirect_action_early_' . $this->_current_route),
+				10
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_action_' . $this->_current_route),
+				10
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_filter_' . $this->_current_route),
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = array(
+			'admin_footer'                                                                            => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views'                                                                   => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+		);
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	private function _ajax_hooks()
+	{
+
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _ajax_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, array($this, $method));
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		$current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _init_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', array($this, $method));
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	private function _handle_metabox_array($boxes, $add = true)
+	{
+
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			} //we dont' have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function remove_metaboxes()
+	{
+
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @access private
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 */
+	private function _add_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'func'          => $func,
+			'id'            => $this->caller . '_' . $func . '_metabox',
+			'priority'      => 'default',
+			'label'         => $this->caller,
+			'context'       => 'advanced',
+			'callback_args' => array(),
+			'page'          => isset($args['page']) ? $args['page'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// make sure method exists
+		if (! method_exists($this, $func)) {
+			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+			$msg[] = sprintf(
+				__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$func,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so lets add the metabox
+		add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'id'      => isset($args['id'])
+				? $args['id']
+				: $this->_current_route
+				  . '_'
+				  . $this->caller
+				  . '_'
+				  . $func
+				  . '_metabox',
+			'context' => 'default',
+			'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

Spacing +41 added lines, -41 removed lines

@@ -205,7 +205,7 @@ 
         $this->_set_defaults();
         $this->_set_hooks_properties();
         // first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
+        if ( ! isset($this->_req_data['page'])
             || (isset($this->_req_data['page'])
                 && $this->_adminpage_obj->page_slug
                    != $this->_req_data['page'])) {
@@ -256,9 +256,9 @@ 
     public function enqueue_scripts_styles()
     {
 
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = __(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -268,7 +268,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -283,7 +283,7 @@ 
                 $details = wp_parse_args($details, $defaults);
                 extract($details);
                 // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -295,7 +295,7 @@ 
                             'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -311,29 +311,29 @@ 
                     );
             }
             // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
             foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -381,20 +381,20 @@ 
             throw new EE_Error(implode('||', $msg));
         }
         $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+        $ref = str_replace(' ', '_', ucwords($ref)).'_Admin_Page'; // take the message -> The_Message
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . DS . $ref . '.core.php';
+        $decaf_file = EE_ADMIN_PAGES.$this->_name.DS.$ref.'.core.php';
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . DS . 'Extend_' . $ref . '.core.php');
+            require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.DS.'Extend_'.$ref.'.core.php');
         }
         // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
+        $ref = $this->_extend ? 'Extend_'.$ref : $ref;
         // let's make sure the class exists
-        if (! class_exists($ref)) {
+        if ( ! class_exists($ref)) {
             $msg[] = __('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -436,28 +436,28 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
+                array($this, '_redirect_action_early_'.$this->_current_route),
                 10
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_action_'.$this->_current_route),
                 10
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_filter_'.$this->_current_route),
                 10,
                 2
             );
@@ -482,12 +482,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -504,21 +504,21 @@ 
             ),
         );
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
@@ -541,11 +541,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _ajax_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -556,7 +556,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, array($this, $method));
+            add_action('wp_ajax_'.$action, array($this, $method));
         }
     }
 
@@ -575,11 +575,11 @@ 
         $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _init_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -617,7 +617,7 @@ 
     {
 
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             } //we dont' have a valid array
             // let's make sure $box['page_route'] is an array so the "foreach" will work.
@@ -666,7 +666,7 @@ 
         // set defaults
         $defaults = array(
             'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
+            'id'            => $this->caller.'_'.$func.'_metabox',
             'priority'      => 'default',
             'label'         => $this->caller,
             'context'       => 'advanced',
@@ -676,8 +676,8 @@ 
         $args = wp_parse_args($args, $defaults);
         extract($args);
         // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+        if ( ! method_exists($this, $func)) {
+            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso').'<br />';
             $msg[] = sprintf(
                 __(
                     'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',