eventespresso / event-espresso-core

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
      */

Spacing +7 added lines, -7 removed lines

@@ -90,7 +90,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 '';
         }
 
@@ -188,7 +188,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;
 
@@ -205,7 +205,7 @@ 
 
             //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
+            $this->_event = ! $this->_event instanceof EE_Event && $aee instanceof EE_Messages_Addressee
                 ? reset($aee->events)
                 : $this->_event;
         }
@@ -229,7 +229,7 @@ 
     private function _venue($field)
     {
 
-        if (! $this->_venue instanceof EE_Venue) {
+        if ( ! $this->_venue instanceof EE_Venue) {
             return '';
         } //no venue so get out.
 
@@ -252,11 +252,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':

Indentation +313 added lines, -313 removed lines

@@ -19,317 +19,317 @@
 {
 
 
-    /**
-     * 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;
+	}
 }

core/EE_Maintenance_Mode.core.php

Indentation +317 added lines, -317 removed lines

@@ -17,362 +17,362 @@
 class EE_Maintenance_Mode implements ResettableInterface
 {
 
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
-     */
-    const level_0_not_in_maintenance = 0;
-
-    /**
-     * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
-     * but the admin backend should be running as normal. Maybe an admin can view the frontend though
-     */
-    const level_1_frontend_only_maintenance = 1;
-
-    /**
-     * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
-     * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
-     * migration scripts before taking the site out of maintenance mode
-     */
-    const level_2_complete_maintenance = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
-
-
-    /**
-     * @var EE_Maintenance_Mode $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Maintenance_Mode
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode
-     */
-    public static function reset()
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        return self::instance();
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct()
-    {
-        // if M-Mode level 2 is engaged, we still need basic assets loaded
-        add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode'));
-        // shut 'er down down for maintenance ?
-        add_filter('the_content', array($this, 'the_content'), 2);
-        // add powered by EE msg
-        add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10);
-    }
-
-
-
-    /**
-     * retrieves the maintenance mode option value from the db
-     *
-     * @return int
-     */
-    public function real_level()
-    {
-        return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
-    }
-
-
-
-    /**
-     * Returns whether or not the models reportedly are able to run queries or not
-     * (ie, if the system thinks their tables are present and up-to-date).
-     *
-     * @return boolean
-     */
-    public function models_can_query()
-    {
-        return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-
-    /**
-     * Determines whether or not we're in maintenance mode and what level. However, while the site
-     * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
-     * to them as if teh site isn't in maintenance mode.
-     * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
-     * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
-     * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
-     *
-     * @return int
-     */
-    public function level()
-    {
-        $maintenance_mode_level = $this->real_level();
-        // if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
-        if (
-            $maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
-            && ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
-            && current_user_can('administrator') // when the user is an admin
-        ) {
-            $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-        }
-        return $maintenance_mode_level;
-    }
-
-
-
-    /**
-     * Determines if we need to put EE in maintenance mode because the database needs updating
-     *
-     * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
-     */
-    public function set_maintenance_mode_if_db_old()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
-            return true;
-        }
-        if ($this->level() === self::level_2_complete_maintenance) {
-            //we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
-            //then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-            update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
-            return false;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level($level)
-    {
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
-        update_option(self::option_name_maintenance_mode, (int)$level);
-    }
-
-
-
-    /**
-     * returns TRUE if M-Mode is engaged and the current request is not for the admin
-     *
-     * @return    string
-     */
-    public static function disable_frontend_for_maintenance()
-    {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode()
-    {
-        if (
-            $this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
-            && ! wp_script_is('espresso_core')
-        ) {
-            wp_register_style(
-                'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                array('dashicons'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('espresso_default');
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                array('jquery'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-
-    /**
-     * replacement EE CPT template that displays message notifying site visitors
-     * that EE has been temporarily placed into maintenance mode
-     * does NOT get called on non-EE-CPT requests
-     *
-     * @return    string
-     */
-    public static function template_include()
-    {
-        // shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
-    }
-
-
-
-    /**
-     * displays message notifying site visitors that EE has been temporarily
-     * placed into maintenance mode when post_type != EE CPT
-     *
-     * @param string $the_content
-     * @return string
-     */
-    public function the_content($the_content)
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
-            // this can eventually be moved to a template, or edited via admin. But for now...
-            $the_content = sprintf(
-                esc_html__(
-                    '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '</h3><p>',
-                '</p>'
-            );
-        }
-        return $the_content;
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	const level_0_not_in_maintenance = 0;
+
+	/**
+	 * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
+	 * but the admin backend should be running as normal. Maybe an admin can view the frontend though
+	 */
+	const level_1_frontend_only_maintenance = 1;
+
+	/**
+	 * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
+	 * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
+	 * migration scripts before taking the site out of maintenance mode
+	 */
+	const level_2_complete_maintenance = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
+
+
+	/**
+	 * @var EE_Maintenance_Mode $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function reset()
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct()
+	{
+		// if M-Mode level 2 is engaged, we still need basic assets loaded
+		add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode'));
+		// shut 'er down down for maintenance ?
+		add_filter('the_content', array($this, 'the_content'), 2);
+		// add powered by EE msg
+		add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10);
+	}
+
+
+
+	/**
+	 * retrieves the maintenance mode option value from the db
+	 *
+	 * @return int
+	 */
+	public function real_level()
+	{
+		return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
+	}
+
+
+
+	/**
+	 * Returns whether or not the models reportedly are able to run queries or not
+	 * (ie, if the system thinks their tables are present and up-to-date).
+	 *
+	 * @return boolean
+	 */
+	public function models_can_query()
+	{
+		return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+
+	/**
+	 * Determines whether or not we're in maintenance mode and what level. However, while the site
+	 * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
+	 * to them as if teh site isn't in maintenance mode.
+	 * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
+	 * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
+	 * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
+	 *
+	 * @return int
+	 */
+	public function level()
+	{
+		$maintenance_mode_level = $this->real_level();
+		// if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
+		if (
+			$maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
+			&& ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
+			&& current_user_can('administrator') // when the user is an admin
+		) {
+			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
+		}
+		return $maintenance_mode_level;
+	}
+
+
+
+	/**
+	 * Determines if we need to put EE in maintenance mode because the database needs updating
+	 *
+	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
+	 */
+	public function set_maintenance_mode_if_db_old()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
+			return true;
+		}
+		if ($this->level() === self::level_2_complete_maintenance) {
+			//we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
+			//then we shouldn't be in mm2. (Maybe an addon got deactivated?)
+			update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
+			return false;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level($level)
+	{
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
+		update_option(self::option_name_maintenance_mode, (int)$level);
+	}
+
+
+
+	/**
+	 * returns TRUE if M-Mode is engaged and the current request is not for the admin
+	 *
+	 * @return    string
+	 */
+	public static function disable_frontend_for_maintenance()
+	{
+		return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode()
+	{
+		if (
+			$this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
+			&& ! wp_script_is('espresso_core')
+		) {
+			wp_register_style(
+				'espresso_default',
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				array('dashicons'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('espresso_default');
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				array('jquery'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+
+	/**
+	 * replacement EE CPT template that displays message notifying site visitors
+	 * that EE has been temporarily placed into maintenance mode
+	 * does NOT get called on non-EE-CPT requests
+	 *
+	 * @return    string
+	 */
+	public static function template_include()
+	{
+		// shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
+		return get_template_directory() . '/index.php';
+	}
+
+
+
+	/**
+	 * displays message notifying site visitors that EE has been temporarily
+	 * placed into maintenance mode when post_type != EE CPT
+	 *
+	 * @param string $the_content
+	 * @return string
+	 */
+	public function the_content($the_content)
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
+			// this can eventually be moved to a template, or edited via admin. But for now...
+			$the_content = sprintf(
+				esc_html__(
+					'%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'</h3><p>',
+				'</p>'
+			);
+		}
+		return $the_content;
+	}
 
 
 
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     */
-    public function display_maintenance_mode_notice()
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && $this->real_level()
-            && ! is_admin()
-            && current_user_can('administrator')
-            && EE_Registry::instance()->REQ->is_espresso_page()
-        ) {
-            printf(
-                esc_html__(
-                    '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
-                    'event_espresso'
-                ),
-                '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
-                '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
-                    array('page' => 'espresso_maintenance_settings'), admin_url('admin.php')
-                ) . '">',
-                '</a></p></div>'
-            );
-        }
-    }
-    // espresso-notices important-notice ee-attention
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 */
+	public function display_maintenance_mode_notice()
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& $this->real_level()
+			&& ! is_admin()
+			&& current_user_can('administrator')
+			&& EE_Registry::instance()->REQ->is_espresso_page()
+		) {
+			printf(
+				esc_html__(
+					'%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
+					'event_espresso'
+				),
+				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
+				'"><span class="dashicons dashicons-no"></span></a><p>',
+				' &raquo; <a href="' . add_query_arg(
+					array('page' => 'espresso_maintenance_settings'), admin_url('admin.php')
+				) . '">',
+				'</a></p></div>'
+			);
+		}
+	}
+	// espresso-notices important-notice ee-attention
 
 
 
-    /**
-     * override magic methods
-     */
-    final public function __destruct()
-    {
-    }
+	/**
+	 * override magic methods
+	 */
+	final public function __destruct()
+	{
+	}
 
 
 
-    final public function __call($a, $b)
-    {
-    }
+	final public function __call($a, $b)
+	{
+	}
 
 
 
-    final public function __get($a)
-    {
-    }
+	final public function __get($a)
+	{
+	}
 
 
 
-    final public function __set($a, $b)
-    {
-    }
+	final public function __set($a, $b)
+	{
+	}
 
 
 
-    final public function __isset($a)
-    {
-    }
+	final public function __isset($a)
+	{
+	}
 
 
 
-    final public function __unset($a)
-    {
-    }
+	final public function __unset($a)
+	{
+	}
 
 
 
-    final public function __sleep()
-    {
-        return array();
-    }
+	final public function __sleep()
+	{
+		return array();
+	}
 
 
 
-    final public function __wakeup()
-    {
-    }
+	final public function __wakeup()
+	{
+	}
 
 
 
-    final public function __invoke()
-    {
-    }
+	final public function __invoke()
+	{
+	}
 
 
 
-    final public static function __set_state($a = null)
-    {
-        return EE_Maintenance_Mode::instance();
-    }
+	final public static function __set_state($a = null)
+	{
+		return EE_Maintenance_Mode::instance();
+	}
 
 
 
-    final public function __clone()
-    {
-    }
+	final public function __clone()
+	{
+	}
 
 
 
-    final public static function __callStatic($a, $b)
-    {
-    }
+	final public static function __callStatic($a, $b)
+	{
+	}
 
 }
 // End of file EE_Maintenance_Mode.core.php

modules/add_new_state/EED_Add_New_State.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -698,7 +698,7 @@
 
     /**
      * @param EE_State[] $state_options
-     * @return array
+     * @return EE_State[]
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Indentation +724 added lines, -724 removed lines

@@ -19,730 +19,730 @@
 
 
 
-    /**
-     * @return EED_Module|EED_Add_New_State
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-        add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-            array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('ANS_TEMPLATES_PATH', str_replace(
-                                         '\\',
-                                         DS,
-                                         plugin_dir_path(__FILE__)) . 'templates' . DS
-        );
-    }
-
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ans_no_country']        = esc_html__(
-            'In order to proceed, you need to select the Country that your State/Province belongs to.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_name']           = esc_html__(
-            'In order to proceed, you need to enter the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_abbreviation']   = esc_html__(
-            'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_save_success']      = esc_html__(
-            'The new state was successfully saved to the database.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
-            'An unknown error has occurred on the server while saving the new state to the database.',
-            'event_espresso'
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function wp_enqueue_scripts()
-    {
-        if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
-                array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
-            wp_enqueue_script('add_new_state');
-        }
-    }
-
-
-
-    /**
-     * display_add_new_state_micro_form
-     *
-     * @param EE_Form_Section_Proper $question_group_reg_form
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    //	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
-    public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
-    {
-        // only add the 'new_state_micro_form' when displaying reg forms,
-        // not during processing since we process the 'new_state_micro_form' in it's own AJAX request
-        $action = EE_Registry::instance()->REQ->get('action', '');
-        // is the "state" question in this form section?
-        $input = $question_group_reg_form->get_subsection('state');
-        if ($action === 'process_reg_step' || $action === 'update_reg_step') {
-            //ok then all we need to do is make sure the input's HTML name is consistent
-            //by forcing it to set it now, like it did while getting the form for display
-            if ($input instanceof EE_State_Select_Input) {
-                $input->html_name();
-            }
-            return $question_group_reg_form;
-        }
-        // we're only doing this for state select inputs
-        if ($input instanceof EE_State_Select_Input) {
-            // grab any set values from the request
-            $country_name        = str_replace('state', 'nsmf_new_state_country', $input->html_name());
-            $state_name          = str_replace('state', 'nsmf_new_state_name', $input->html_name());
-            $abbrv_name          = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
-            $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
-            $country_options     = array();
-            $countries           = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
-                foreach ($countries as $country) {
-                    if ($country instanceof EE_Country) {
-                        $country_options[$country->ID()] = $country->name();
-                    }
-                }
-            }
-            $new_state_micro_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'new_state_micro_form',
-                    'html_id'         => 'new_state_micro_form',
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'subsections'     => array(
-                        // add hidden input to indicate that a new state is being added
-                        'add_new_state'               => new EE_Hidden_Input(
-                            array(
-                                'html_name' => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_name()
-                                ),
-                                'html_id'   => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_id()
-                                ),
-                                'default'   => 0,
-                            )
-                        ),
-                        // add link for displaying hidden container
-                        'click_here_link'             => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('click here to add a new state/province', 'event_espresso'),
-                                    '',
-                                    'display-' . $input->html_id(),
-                                    'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                            )
-                        ),
-                        // add initial html for hidden container
-                        'add_new_state_micro_form'    => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
-                                    'display: none;') .
-                                EEH_HTML::h6(
-                                    esc_html__(
-                                        'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::ul() .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'first select the Country that your State/Province belongs to',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'enter a two to six letter abbreviation for the name of your State/Province',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
-                                EEH_HTML::ulx()
-                            )
-                        ),
-                        // NEW STATE COUNTRY
-                        'new_state_country'           => new EE_Country_Select_Input(
-                            $country_options,
-                            array(
-                                'html_name'       => $country_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_country', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
-                                'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        // NEW STATE NAME
-                        'new_state_name'              => new EE_Text_Input(
-                            array(
-                                'html_name'       => $state_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_name', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
-                                'html_label_text' => esc_html__('New State/Province Name',
-                                    'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
-                        // NEW STATE NAME
-                        'new_state_abbrv'             => new EE_Text_Input(
-                            array(
-                                'html_name'             => $abbrv_name,
-                                'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
-                                    $input->html_id()),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
-                                'html_label_text'       => esc_html__(
-                                                               'New State/Province Abbreviation',
-                                                               'event_espresso'
-                                                           ) . ' *',
-                                'html_other_attributes' => 'size="24"',
-                                'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
-                                'required'              => false,
-                            )
-                        ),
-                        // "submit" button
-                        'add_new_state_submit_button' => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('ADD', 'event_espresso'),
-                                    '',
-                                    'submit-' . $new_state_submit_id,
-                                    'ee-form-add-new-state-submit button button-secondary',
-                                    '',
-                                    'data-target="' . $new_state_submit_id . '"'
-                                )
-                            )
-                        ),
-                        // extra info
-                        'add_new_state_extra'         => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
-                                EEH_HTML::br(2)
-                                .
-                                EEH_HTML::div('', '', 'small-text')
-                                .
-                                EEH_HTML::strong(
-                                    '* ' .
-                                    esc_html__(
-                                        'Don\'t know your State/Province Abbreviation?',
-                                        'event_espresso'
-                                    )
-                                )
-                                .
-                                EEH_HTML::br()
-                                .
-                                sprintf(
-                                    esc_html__(
-                                        'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
-                                        'event_espresso'
-                                    ),
-                                    EEH_HTML::link(
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        '',
-                                        '',
-                                        'ee-form-add-new-state-wiki-lnk',
-                                        '',
-                                        'target="_blank"'
-                                    )
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                                .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('cancel new State/Province', 'event_espresso'),
-                                    '',
-                                    'hide-' . $input->html_id(),
-                                    'ee-form-cancel-new-state-lnk smaller-text',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                            )
-                        ),
-                    ),
-                )
-            );
-            $question_group_reg_form->add_subsections(
-                array('new_state_micro_form' => $new_state_micro_form),
-                'state',
-                false
-            );
-        }
-        return $question_group_reg_form;
-    }
-
-
-
-    /**
-     * set_new_state_input_width
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_new_state()
-    {
-        $REQ = EE_Registry::instance()->load_core('Request_Handler');
-        if (absint($REQ->get('nsmf_add_new_state')) === 1) {
-            EE_Registry::instance()->load_model('State');
-            // grab country ISO code, new state name, and new state abbreviation
-            $state_country = $REQ->is_set('nsmf_new_state_country')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_country'))
-                : false;
-            $state_name    = $REQ->is_set('nsmf_new_state_name')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_name'))
-                : false;
-            $state_abbr    = $REQ->is_set('nsmf_new_state_abbrv')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
-                : false;
-            if ($state_country && $state_name && $state_abbr) {
-                $new_state = EED_Add_New_State::save_new_state_to_db(array(
-                    'CNT_ISO'    => strtoupper($state_country),
-                    'STA_abbrev' => strtoupper($state_abbr),
-                    'STA_name'   => ucwords($state_name),
-                    'STA_active' => false,
-                ));
-                if ($new_state instanceof EE_State) {
-                    // clean house
-                    EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
-                    // get any existing new states
-                    $new_states                   = EE_Registry::instance()->SSN->get_session_data(
-                        'nsmf_new_states'
-                    );
-                    $new_states[$new_state->ID()] = $new_state;
-                    EE_Registry::instance()->SSN->set_session_data(
-                        array('nsmf_new_states' => $new_states)
-                    );
-                    if (EE_Registry::instance()->REQ->ajax) {
-                        echo wp_json_encode(array(
-                            'success'      => true,
-                            'id'           => $new_state->ID(),
-                            'name'         => $new_state->name(),
-                            'abbrev'       => $new_state->abbrev(),
-                            'country_iso'  => $new_state->country_iso(),
-                            'country_name' => $new_state->country()->name(),
-                        ));
-                        exit();
-                    }
-                    return $new_state->ID();
-                }
-            } else {
-                $error = esc_html__(
-                    'A new State/Province could not be added because invalid or missing data was received.',
-                    'event_espresso'
-                );
-                if (EE_Registry::instance()->REQ->ajax) {
-                    echo wp_json_encode(array('error' => $error));
-                    exit();
-                }
-                EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * recursively drills down through request params to remove any that were added by this module
-     *
-     * @param array $request_params
-     * @return array
-     */
-    public static function filter_checkout_request_params($request_params)
-    {
-        foreach ($request_params as $form_section) {
-            if (is_array($form_section)) {
-                EED_Add_New_State::unset_new_state_request_params($form_section);
-                EED_Add_New_State::filter_checkout_request_params($form_section);
-            }
-        }
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $request_params
-     * @return array
-     */
-    public static function unset_new_state_request_params($request_params)
-    {
-        unset(
-            $request_params['new_state_micro_form'],
-            $request_params['new_state_micro_add_new_state'],
-            $request_params['new_state_micro_new_state_country'],
-            $request_params['new_state_micro_new_state_name'],
-            $request_params['new_state_micro_new_state_abbrv']
-        );
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $props_n_values
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function save_new_state_to_db($props_n_values = array())
-    {
-        $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
-            return array_pop($existing_state);
-        }
-        $new_state = EE_State::new_instance($props_n_values);
-        if ($new_state instanceof EE_State) {
-            // if not non-ajax admin
-            $new_state_key    = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
-            $new_state_notice = sprintf(
-                esc_html__(
-                    'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
-                    'event_espresso'
-                ),
-                '<b>' . $new_state->name() . '</b>',
-                '<b>' . $new_state->abbrev() . '</b>',
-                '<b>' . $new_state->country()->name() . '</b>',
-                '<a href="' . add_query_arg(array(
-                    'page'    => 'espresso_general_settings',
-                    'action'  => 'country_settings',
-                    'country' => $new_state->country_iso(),
-                ), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
-                    'event_espresso') . '</a>',
-                '<br />'
-            );
-            EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
-            $new_state->save();
-            EEM_State::instance()->reset_cached_states();
-            return $new_state;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $CNT_ISO
-     * @param string $STA_ID
-     * @param array  $cols_n_values
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
-    {
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
-            : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
-            $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-            if ($state instanceof EE_State) {
-                $STA_abbrev = $state->abbrev();
-            }
-        }
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
-    }
-
-
-
-    /**
-     * @param EE_State[]                            $state_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_state_into_options(
-        $state_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type() === EEM_Question::QST_type_state
-        ) {
-            $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
-                $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-                if ($state instanceof EE_State) {
-                    $country = $state->country();
-                    if ($country instanceof EE_Country) {
-                        if (! isset($state_options[$country->name()])) {
-                            $state_options[$country->name()] = array();
-                        }
-                        if (! isset($state_options[$country->name()][$STA_ID])) {
-                            $state_options[$country->name()][$STA_ID] = $state->name();
-                        }
-                    }
-                }
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @param EE_Country[]                          $country_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_country_into_options(
-        $country_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type()
-               === EEM_Question::QST_type_country
-        ) {
-            $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
-                $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-                if ($country instanceof EE_Country) {
-                    if (! isset($country_options[$CNT_ISO])) {
-                        $country_options[$CNT_ISO] = $country->name();
-                    }
-                }
-            }
-        }
-        return $country_options;
-    }
-
-
-
-    /**
-     * @param EE_State[] $state_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function state_options($state_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_new_states()
-    {
-        $new_states = array();
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            $new_states = EE_Registry::instance()->SSN->get_session_data(
-                'nsmf_new_states'
-            );
-        }
-        return is_array($new_states) ? $new_states : array();
-    }
-
-
-
-    /**
-     * @param EE_Country[] $country_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function country_options($country_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $country_options[$new_state->country()->ID()] = $new_state->country()->name();
-            }
-        }
-        return $country_options;
-    }
+	/**
+	 * @return EED_Module|EED_Add_New_State
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+		add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+			array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define('ANS_TEMPLATES_PATH', str_replace(
+										 '\\',
+										 DS,
+										 plugin_dir_path(__FILE__)) . 'templates' . DS
+		);
+	}
+
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ans_no_country']        = esc_html__(
+			'In order to proceed, you need to select the Country that your State/Province belongs to.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_name']           = esc_html__(
+			'In order to proceed, you need to enter the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_abbreviation']   = esc_html__(
+			'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_save_success']      = esc_html__(
+			'The new state was successfully saved to the database.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
+			'An unknown error has occurred on the server while saving the new state to the database.',
+			'event_espresso'
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts()
+	{
+		if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
+			wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
+				array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
+			wp_enqueue_script('add_new_state');
+		}
+	}
+
+
+
+	/**
+	 * display_add_new_state_micro_form
+	 *
+	 * @param EE_Form_Section_Proper $question_group_reg_form
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	//	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
+	public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
+	{
+		// only add the 'new_state_micro_form' when displaying reg forms,
+		// not during processing since we process the 'new_state_micro_form' in it's own AJAX request
+		$action = EE_Registry::instance()->REQ->get('action', '');
+		// is the "state" question in this form section?
+		$input = $question_group_reg_form->get_subsection('state');
+		if ($action === 'process_reg_step' || $action === 'update_reg_step') {
+			//ok then all we need to do is make sure the input's HTML name is consistent
+			//by forcing it to set it now, like it did while getting the form for display
+			if ($input instanceof EE_State_Select_Input) {
+				$input->html_name();
+			}
+			return $question_group_reg_form;
+		}
+		// we're only doing this for state select inputs
+		if ($input instanceof EE_State_Select_Input) {
+			// grab any set values from the request
+			$country_name        = str_replace('state', 'nsmf_new_state_country', $input->html_name());
+			$state_name          = str_replace('state', 'nsmf_new_state_name', $input->html_name());
+			$abbrv_name          = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
+			$new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
+			$country_options     = array();
+			$countries           = EEM_Country::instance()->get_all_countries();
+			if (! empty($countries)) {
+				foreach ($countries as $country) {
+					if ($country instanceof EE_Country) {
+						$country_options[$country->ID()] = $country->name();
+					}
+				}
+			}
+			$new_state_micro_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'new_state_micro_form',
+					'html_id'         => 'new_state_micro_form',
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'subsections'     => array(
+						// add hidden input to indicate that a new state is being added
+						'add_new_state'               => new EE_Hidden_Input(
+							array(
+								'html_name' => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_name()
+								),
+								'html_id'   => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_id()
+								),
+								'default'   => 0,
+							)
+						),
+						// add link for displaying hidden container
+						'click_here_link'             => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
+								EEH_HTML::link(
+									'',
+									esc_html__('click here to add a new state/province', 'event_espresso'),
+									'',
+									'display-' . $input->html_id(),
+									'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+							)
+						),
+						// add initial html for hidden container
+						'add_new_state_micro_form'    => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
+								EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
+									'display: none;') .
+								EEH_HTML::h6(
+									esc_html__(
+										'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::ul() .
+								EEH_HTML::li(
+									esc_html__(
+										'first select the Country that your State/Province belongs to',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(
+									esc_html__('enter the name of your State/Province', 'event_espresso')
+								) .
+								EEH_HTML::li(
+									esc_html__(
+										'enter a two to six letter abbreviation for the name of your State/Province',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+								EEH_HTML::ulx()
+							)
+						),
+						// NEW STATE COUNTRY
+						'new_state_country'           => new EE_Country_Select_Input(
+							$country_options,
+							array(
+								'html_name'       => $country_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_country', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-country',
+								'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
+								'required'        => false,
+							)
+						),
+						// NEW STATE NAME
+						'new_state_name'              => new EE_Text_Input(
+							array(
+								'html_name'       => $state_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_name', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-state',
+								'html_label_text' => esc_html__('New State/Province Name',
+									'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
+								'required'        => false,
+							)
+						),
+						'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
+						// NEW STATE NAME
+						'new_state_abbrv'             => new EE_Text_Input(
+							array(
+								'html_name'             => $abbrv_name,
+								'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
+									$input->html_id()),
+								'html_class'            => $input->html_class() . ' new-state-abbrv',
+								'html_label_text'       => esc_html__(
+															   'New State/Province Abbreviation',
+															   'event_espresso'
+														   ) . ' *',
+								'html_other_attributes' => 'size="24"',
+								'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
+								'required'              => false,
+							)
+						),
+						// "submit" button
+						'add_new_state_submit_button' => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
+								EEH_HTML::nbsp(3) .
+								EEH_HTML::link(
+									'',
+									esc_html__('ADD', 'event_espresso'),
+									'',
+									'submit-' . $new_state_submit_id,
+									'ee-form-add-new-state-submit button button-secondary',
+									'',
+									'data-target="' . $new_state_submit_id . '"'
+								)
+							)
+						),
+						// extra info
+						'add_new_state_extra'         => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
+								EEH_HTML::br(2)
+								.
+								EEH_HTML::div('', '', 'small-text')
+								.
+								EEH_HTML::strong(
+									'* ' .
+									esc_html__(
+										'Don\'t know your State/Province Abbreviation?',
+										'event_espresso'
+									)
+								)
+								.
+								EEH_HTML::br()
+								.
+								sprintf(
+									esc_html__(
+										'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
+										'event_espresso'
+									),
+									EEH_HTML::link(
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'',
+										'',
+										'ee-form-add-new-state-wiki-lnk',
+										'',
+										'target="_blank"'
+									)
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+								.
+								EEH_HTML::link(
+									'',
+									esc_html__('cancel new State/Province', 'event_espresso'),
+									'',
+									'hide-' . $input->html_id(),
+									'ee-form-cancel-new-state-lnk smaller-text',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+							)
+						),
+					),
+				)
+			);
+			$question_group_reg_form->add_subsections(
+				array('new_state_micro_form' => $new_state_micro_form),
+				'state',
+				false
+			);
+		}
+		return $question_group_reg_form;
+	}
+
+
+
+	/**
+	 * set_new_state_input_width
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_new_state()
+	{
+		$REQ = EE_Registry::instance()->load_core('Request_Handler');
+		if (absint($REQ->get('nsmf_add_new_state')) === 1) {
+			EE_Registry::instance()->load_model('State');
+			// grab country ISO code, new state name, and new state abbreviation
+			$state_country = $REQ->is_set('nsmf_new_state_country')
+				? sanitize_text_field($REQ->get('nsmf_new_state_country'))
+				: false;
+			$state_name    = $REQ->is_set('nsmf_new_state_name')
+				? sanitize_text_field($REQ->get('nsmf_new_state_name'))
+				: false;
+			$state_abbr    = $REQ->is_set('nsmf_new_state_abbrv')
+				? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
+				: false;
+			if ($state_country && $state_name && $state_abbr) {
+				$new_state = EED_Add_New_State::save_new_state_to_db(array(
+					'CNT_ISO'    => strtoupper($state_country),
+					'STA_abbrev' => strtoupper($state_abbr),
+					'STA_name'   => ucwords($state_name),
+					'STA_active' => false,
+				));
+				if ($new_state instanceof EE_State) {
+					// clean house
+					EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
+					// get any existing new states
+					$new_states                   = EE_Registry::instance()->SSN->get_session_data(
+						'nsmf_new_states'
+					);
+					$new_states[$new_state->ID()] = $new_state;
+					EE_Registry::instance()->SSN->set_session_data(
+						array('nsmf_new_states' => $new_states)
+					);
+					if (EE_Registry::instance()->REQ->ajax) {
+						echo wp_json_encode(array(
+							'success'      => true,
+							'id'           => $new_state->ID(),
+							'name'         => $new_state->name(),
+							'abbrev'       => $new_state->abbrev(),
+							'country_iso'  => $new_state->country_iso(),
+							'country_name' => $new_state->country()->name(),
+						));
+						exit();
+					}
+					return $new_state->ID();
+				}
+			} else {
+				$error = esc_html__(
+					'A new State/Province could not be added because invalid or missing data was received.',
+					'event_espresso'
+				);
+				if (EE_Registry::instance()->REQ->ajax) {
+					echo wp_json_encode(array('error' => $error));
+					exit();
+				}
+				EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * recursively drills down through request params to remove any that were added by this module
+	 *
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function filter_checkout_request_params($request_params)
+	{
+		foreach ($request_params as $form_section) {
+			if (is_array($form_section)) {
+				EED_Add_New_State::unset_new_state_request_params($form_section);
+				EED_Add_New_State::filter_checkout_request_params($form_section);
+			}
+		}
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function unset_new_state_request_params($request_params)
+	{
+		unset(
+			$request_params['new_state_micro_form'],
+			$request_params['new_state_micro_add_new_state'],
+			$request_params['new_state_micro_new_state_country'],
+			$request_params['new_state_micro_new_state_name'],
+			$request_params['new_state_micro_new_state_abbrv']
+		);
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function save_new_state_to_db($props_n_values = array())
+	{
+		$existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
+		if (! empty($existing_state)) {
+			return array_pop($existing_state);
+		}
+		$new_state = EE_State::new_instance($props_n_values);
+		if ($new_state instanceof EE_State) {
+			// if not non-ajax admin
+			$new_state_key    = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
+			$new_state_notice = sprintf(
+				esc_html__(
+					'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
+					'event_espresso'
+				),
+				'<b>' . $new_state->name() . '</b>',
+				'<b>' . $new_state->abbrev() . '</b>',
+				'<b>' . $new_state->country()->name() . '</b>',
+				'<a href="' . add_query_arg(array(
+					'page'    => 'espresso_general_settings',
+					'action'  => 'country_settings',
+					'country' => $new_state->country_iso(),
+				), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
+					'event_espresso') . '</a>',
+				'<br />'
+			);
+			EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
+			$new_state->save();
+			EEM_State::instance()->reset_cached_states();
+			return $new_state;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $CNT_ISO
+	 * @param string $STA_ID
+	 * @param array  $cols_n_values
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
+	{
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
+			: false;
+		if (! $STA_abbrev && ! empty($STA_ID)) {
+			$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+			if ($state instanceof EE_State) {
+				$STA_abbrev = $state->abbrev();
+			}
+		}
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
+	}
+
+
+
+	/**
+	 * @param EE_State[]                            $state_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_state_into_options(
+		$state_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type() === EEM_Question::QST_type_state
+		) {
+			$STA_ID = $answer->value();
+			if (! empty($STA_ID)) {
+				$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+				if ($state instanceof EE_State) {
+					$country = $state->country();
+					if ($country instanceof EE_Country) {
+						if (! isset($state_options[$country->name()])) {
+							$state_options[$country->name()] = array();
+						}
+						if (! isset($state_options[$country->name()][$STA_ID])) {
+							$state_options[$country->name()][$STA_ID] = $state->name();
+						}
+					}
+				}
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @param EE_Country[]                          $country_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_country_into_options(
+		$country_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type()
+			   === EEM_Question::QST_type_country
+		) {
+			$CNT_ISO = $answer->value();
+			if (! empty($CNT_ISO)) {
+				$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+				if ($country instanceof EE_Country) {
+					if (! isset($country_options[$CNT_ISO])) {
+						$country_options[$CNT_ISO] = $country->name();
+					}
+				}
+			}
+		}
+		return $country_options;
+	}
+
+
+
+	/**
+	 * @param EE_State[] $state_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function state_options($state_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_new_states()
+	{
+		$new_states = array();
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			$new_states = EE_Registry::instance()->SSN->get_session_data(
+				'nsmf_new_states'
+			);
+		}
+		return is_array($new_states) ? $new_states : array();
+	}
+
+
+
+	/**
+	 * @param EE_Country[] $country_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function country_options($country_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$country_options[$new_state->country()->ID()] = $new_state->country()->name();
+			}
+		}
+		return $country_options;
+	}
 
 
 

Spacing +45 added lines, -45 removed lines

@@ -96,11 +96,11 @@ 
      */
     public static function set_definitions()
     {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
         define('ANS_TEMPLATES_PATH', str_replace(
                                          '\\',
                                          DS,
-                                         plugin_dir_path(__FILE__)) . 'templates' . DS
+                                         plugin_dir_path(__FILE__)).'templates'.DS
         );
     }
 
@@ -121,19 +121,19 @@ 
      */
     public static function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['ans_no_country']        = esc_html__(
+        EE_Registry::$i18n_js_strings['ans_no_country'] = esc_html__(
             'In order to proceed, you need to select the Country that your State/Province belongs to.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['ans_no_name']           = esc_html__(
+        EE_Registry::$i18n_js_strings['ans_no_name'] = esc_html__(
             'In order to proceed, you need to enter the name of your State/Province.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['ans_no_abbreviation']   = esc_html__(
+        EE_Registry::$i18n_js_strings['ans_no_abbreviation'] = esc_html__(
             'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['ans_save_success']      = esc_html__(
+        EE_Registry::$i18n_js_strings['ans_save_success'] = esc_html__(
             'The new state was successfully saved to the database.',
             'event_espresso'
         );
@@ -151,7 +151,7 @@ 
     public static function wp_enqueue_scripts()
     {
         if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
+            wp_register_script('add_new_state', ANS_ASSETS_URL.'add_new_state.js',
                 array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
             wp_enqueue_script('add_new_state');
         }
@@ -194,7 +194,7 @@ 
             $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
             $country_options     = array();
             $countries           = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
+            if ( ! empty($countries)) {
                 foreach ($countries as $country) {
                     if ($country instanceof EE_Country) {
                         $country_options[$country->ID()] = $country->name();
@@ -231,10 +231,10 @@ 
                                     '',
                                     esc_html__('click here to add a new state/province', 'event_espresso'),
                                     '',
-                                    'display-' . $input->html_id(),
+                                    'display-'.$input->html_id(),
                                     'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                             )
                         ),
@@ -242,31 +242,31 @@ 
                         'add_new_state_micro_form'    => new EE_Form_Section_HTML(
                             apply_filters(
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
-                                    'display: none;') .
+                                EEH_HTML::div('', $input->html_id().'-dv', 'ee-form-add-new-state-dv',
+                                    'display: none;').
                                 EEH_HTML::h6(
                                     esc_html__(
                                         'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::ul() .
+                                ).
+                                EEH_HTML::ul().
                                 EEH_HTML::li(
                                     esc_html__(
                                         'first select the Country that your State/Province belongs to',
                                         'event_espresso'
                                     )
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
+                                ).
                                 EEH_HTML::li(
                                     esc_html__(
                                         'enter a two to six letter abbreviation for the name of your State/Province',
                                         'event_espresso'
                                     )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+                                ).
+                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')).
                                 EEH_HTML::ulx()
                             )
                         ),
@@ -279,7 +279,7 @@ 
                                     'state',
                                     'nsmf_new_state_country', $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
+                                'html_class'      => $input->html_class().' new-state-country',
                                 'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
                                 'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
                                 'required'        => false,
@@ -293,7 +293,7 @@ 
                                     'state',
                                     'nsmf_new_state_name', $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
+                                'html_class'      => $input->html_class().' new-state-state',
                                 'html_label_text' => esc_html__('New State/Province Name',
                                     'event_espresso'),
                                 'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
@@ -307,11 +307,11 @@ 
                                 'html_name'             => $abbrv_name,
                                 'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
                                     $input->html_id()),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
+                                'html_class'            => $input->html_class().' new-state-abbrv',
                                 'html_label_text'       => esc_html__(
                                                                'New State/Province Abbreviation',
                                                                'event_espresso'
-                                                           ) . ' *',
+                                                           ).' *',
                                 'html_other_attributes' => 'size="24"',
                                 'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
                                 'required'              => false,
@@ -321,15 +321,15 @@ 
                         'add_new_state_submit_button' => new EE_Form_Section_HTML(
                             apply_filters(
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
+                                EEH_HTML::nbsp(3).
                                 EEH_HTML::link(
                                     '',
                                     esc_html__('ADD', 'event_espresso'),
                                     '',
-                                    'submit-' . $new_state_submit_id,
+                                    'submit-'.$new_state_submit_id,
                                     'ee-form-add-new-state-submit button button-secondary',
                                     '',
-                                    'data-target="' . $new_state_submit_id . '"'
+                                    'data-target="'.$new_state_submit_id.'"'
                                 )
                             )
                         ),
@@ -342,7 +342,7 @@ 
                                 EEH_HTML::div('', '', 'small-text')
                                 .
                                 EEH_HTML::strong(
-                                    '* ' .
+                                    '* '.
                                     esc_html__(
                                         'Don\'t know your State/Province Abbreviation?',
                                         'event_espresso'
@@ -375,10 +375,10 @@ 
                                     '',
                                     esc_html__('cancel new State/Province', 'event_espresso'),
                                     '',
-                                    'hide-' . $input->html_id(),
+                                    'hide-'.$input->html_id(),
                                     'ee-form-cancel-new-state-lnk smaller-text',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                                 .
                                 EEH_HTML::divx()
@@ -524,27 +524,27 @@ 
     public static function save_new_state_to_db($props_n_values = array())
     {
         $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
+        if ( ! empty($existing_state)) {
             return array_pop($existing_state);
         }
         $new_state = EE_State::new_instance($props_n_values);
         if ($new_state instanceof EE_State) {
             // if not non-ajax admin
-            $new_state_key    = 'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev();
+            $new_state_key    = 'new-state-added-'.$new_state->country_iso().'-'.$new_state->abbrev();
             $new_state_notice = sprintf(
                 esc_html__(
                     'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
                     'event_espresso'
                 ),
-                '<b>' . $new_state->name() . '</b>',
-                '<b>' . $new_state->abbrev() . '</b>',
-                '<b>' . $new_state->country()->name() . '</b>',
-                '<a href="' . add_query_arg(array(
+                '<b>'.$new_state->name().'</b>',
+                '<b>'.$new_state->abbrev().'</b>',
+                '<b>'.$new_state->country()->name().'</b>',
+                '<a href="'.add_query_arg(array(
                     'page'    => 'espresso_general_settings',
                     'action'  => 'country_settings',
                     'country' => $new_state->country_iso(),
-                ), admin_url('admin.php')) . '">' . esc_html__('Event Espresso - General Settings > Countries Tab',
-                    'event_espresso') . '</a>',
+                ), admin_url('admin.php')).'">'.esc_html__('Event Espresso - General Settings > Countries Tab',
+                    'event_espresso').'</a>',
                 '<br />'
             );
             EE_Error::add_persistent_admin_notice($new_state_key, $new_state_notice);
@@ -569,7 +569,7 @@ 
      */
     public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
     {
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
                 __FILE__,
@@ -579,13 +579,13 @@ 
         }
         $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
             : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
+        if ( ! $STA_abbrev && ! empty($STA_ID)) {
             $state = EEM_State::instance()->get_one_by_ID($STA_ID);
             if ($state instanceof EE_State) {
                 $STA_abbrev = $state->abbrev();
             }
         }
-        if (! $STA_abbrev) {
+        if ( ! $STA_abbrev) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
                 __FILE__,
@@ -593,7 +593,7 @@ 
                 __LINE__
             );
         }
-        EE_Error::dismiss_persistent_admin_notice($CNT_ISO . '-' . $STA_abbrev, true, true);
+        EE_Error::dismiss_persistent_admin_notice($CNT_ISO.'-'.$STA_abbrev, true, true);
     }
 
 
@@ -621,15 +621,15 @@ 
             && $question->type() === EEM_Question::QST_type_state
         ) {
             $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
+            if ( ! empty($STA_ID)) {
                 $state = EEM_State::instance()->get_one_by_ID($STA_ID);
                 if ($state instanceof EE_State) {
                     $country = $state->country();
                     if ($country instanceof EE_Country) {
-                        if (! isset($state_options[$country->name()])) {
+                        if ( ! isset($state_options[$country->name()])) {
                             $state_options[$country->name()] = array();
                         }
-                        if (! isset($state_options[$country->name()][$STA_ID])) {
+                        if ( ! isset($state_options[$country->name()][$STA_ID])) {
                             $state_options[$country->name()][$STA_ID] = $state->name();
                         }
                     }
@@ -665,10 +665,10 @@ 
                === EEM_Question::QST_type_country
         ) {
             $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
+            if ( ! empty($CNT_ISO)) {
                 $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
                 if ($country instanceof EE_Country) {
-                    if (! isset($country_options[$CNT_ISO])) {
+                    if ( ! isset($country_options[$CNT_ISO])) {
                         $country_options[$CNT_ISO] = $country->name();
                     }
                 }

core/libraries/rest_api/calculations/Event.php

Indentation +401 added lines, -401 removed lines

@@ -19,7 +19,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,404 +27,404 @@ 
 class Event extends Calculations_Base
 {
 
-    /**
-     * Calculates the total spaces on the event (not subtracting sales, but taking
-     * sales into account; so this is the optimum sales that CAN still be achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     */
-    public static function optimumSalesAtStart($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces();
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                    // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-
-    /**
-     * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
-     * sales that COULD have been achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     */
-    public static function optimumSalesNow($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                    // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-
-    /**
-     * Like optimum_sales_now, but minus total sales so far.
-     * See EE_Event::spaces_remaining_for_sale( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     */
-    public static function spacesRemaining($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->spaces_remaining_for_sale();
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                    // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts the number of approved registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     */
-    public static function spotsTaken($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        return EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => EEM_Registration::status_id_approved,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked into one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int|null if permission denied
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked out of one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
-    }
-
-
-
-    /**
-     * Gets the thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imageThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'thumbnail');
-    }
-
-
-
-    /**
-     * Gets the medium image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imageMedium($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium');
-    }
-
-
-
-    /**
-     * Gets the medium-large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imageMediumLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium_large');
-    }
-
-
-
-    /**
-     * Gets the large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imageLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'large');
-    }
-
-
-
-    /**
-     * Gets the post-thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imagePostThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'post-thumbnail');
-    }
-
-
-
-    /**
-     * Gets the full size image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public static function imageFull($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'full');
-    }
-
-
-
-    /**
-     * Gets image specs and formats them for the display in the API,
-     * according to the image size requested
-     *
-     * @param array    $wpdb_row
-     * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
-     * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
-     * @throws EE_Error
-     */
-    protected static function calculateImageData($wpdb_row, $image_size)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $EVT_ID = $wpdb_row['Event_CPT.ID'];
-        $attachment_id = get_post_thumbnail_id($EVT_ID);
-        $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
-            return null;
-        }
-        $generated = true;
-        if (isset($data[3])) {
-            $generated = $data[3];
-        }
-        return array(
-            'url'       => $data[0],
-            'width'     => $data[1],
-            'height'    => $data[2],
-            'generated' => $generated,
-        );
-    }
-
-
-
-    /**
-     * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
-     * @param array $wpdb_row
-     * @return bool
-     */
-    protected static function wpdbRowHasEventId($wpdb_row)
-    {
-        return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
-    }
+	/**
+	 * Calculates the total spaces on the event (not subtracting sales, but taking
+	 * sales into account; so this is the optimum sales that CAN still be achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public static function optimumSalesAtStart($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces();
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+					// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
+	 * sales that COULD have been achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public static function optimumSalesNow($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+					// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Like optimum_sales_now, but minus total sales so far.
+	 * See EE_Event::spaces_remaining_for_sale( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public static function spacesRemaining($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->spaces_remaining_for_sale();
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+					// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts the number of approved registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public static function spotsTaken($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		return EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => EEM_Registration::status_id_approved,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked into one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int|null if permission denied
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked out of one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
+	}
+
+
+
+	/**
+	 * Gets the thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imageThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the medium image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imageMedium($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium');
+	}
+
+
+
+	/**
+	 * Gets the medium-large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imageMediumLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium_large');
+	}
+
+
+
+	/**
+	 * Gets the large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imageLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'large');
+	}
+
+
+
+	/**
+	 * Gets the post-thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imagePostThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'post-thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the full size image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function imageFull($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'full');
+	}
+
+
+
+	/**
+	 * Gets image specs and formats them for the display in the API,
+	 * according to the image size requested
+	 *
+	 * @param array    $wpdb_row
+	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
+	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
+	 * @throws EE_Error
+	 */
+	protected static function calculateImageData($wpdb_row, $image_size)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$EVT_ID = $wpdb_row['Event_CPT.ID'];
+		$attachment_id = get_post_thumbnail_id($EVT_ID);
+		$data = wp_get_attachment_image_src($attachment_id, $image_size);
+		if (! $data) {
+			return null;
+		}
+		$generated = true;
+		if (isset($data[3])) {
+			$generated = $data[3];
+		}
+		return array(
+			'url'       => $data[0],
+			'width'     => $data[1],
+			'height'    => $data[2],
+			'generated' => $generated,
+		);
+	}
+
+
+
+	/**
+	 * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
+	 * @param array $wpdb_row
+	 * @return bool
+	 */
+	protected static function wpdbRowHasEventId($wpdb_row)
+	{
+		return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -18,7 +18,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -146,7 +146,7 @@ 
      */
     public static function spotsTaken($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -186,7 +186,7 @@ 
      */
     public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -227,7 +227,7 @@ 
      */
     public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -259,7 +259,7 @@ 
      */
     public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -385,7 +385,7 @@ 
      */
     protected static function calculateImageData($wpdb_row, $image_size)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -401,7 +401,7 @@ 
         $EVT_ID = $wpdb_row['Event_CPT.ID'];
         $attachment_id = get_post_thumbnail_id($EVT_ID);
         $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
+        if ( ! $data) {
             return null;
         }
         $generated = true;

modules/single_page_checkout/inc/EE_Checkout.class.php

Indentation +28 added lines, -28 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_Checkout
- *
- * Description
- *
- * @package 			Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since 				4.5.0
- *
- */
+  *
+  * Class EE_Checkout
+  *
+  * Description
+  *
+  * @package 			Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since 				4.5.0
+  *
+  */
 class EE_Checkout {
 
 	/**
@@ -250,9 +250,9 @@ 
 		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', TRUE );
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
 		$this->reg_cache_where_params = array(
-		    0 => array( 'REG_deleted' => false ),
-		    'order_by' => array( 'REG_count' => 'ASC' )
-        );
+			0 => array( 'REG_deleted' => false ),
+			'order_by' => array( 'REG_count' => 'ASC' )
+		);
 	}
 
 
@@ -807,10 +807,10 @@ 
 	 */
 	public function visit_allows_processing_of_this_registration( EE_Registration $registration ) {
 		return ! $this->revisit
-		       || $this->primary_revisit
-		       || (
-			       $this->revisit && $this->reg_url_link === $registration->reg_url_link()
-		       )
+			   || $this->primary_revisit
+			   || (
+				   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
+			   )
 			? true
 			: false;
 	}
@@ -1202,16 +1202,16 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-    public function __sleep()
-    {
-	    if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
-		    $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
-	    }        // remove the reg form and the checkout
-	    if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
-		    $this->transaction = $this->transaction->ID();
-	    }        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
-    }
+	public function __sleep()
+	{
+		if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
+			$this->primary_attendee_obj = $this->primary_attendee_obj->ID();
+		}        // remove the reg form and the checkout
+		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+			$this->transaction = $this->transaction->ID();
+		}        // remove the reg form and the checkout
+		return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
+	}
 
 
 	/**

Spacing +207 added lines, -207 removed lines

@@ -247,11 +247,11 @@ 
 		$this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
 		$this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
 		$this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
-		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', TRUE );
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', TRUE);
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
 		$this->reg_cache_where_params = array(
-		    0 => array( 'REG_deleted' => false ),
-		    'order_by' => array( 'REG_count' => 'ASC' )
+		    0 => array('REG_deleted' => false),
+		    'order_by' => array('REG_count' => 'ASC')
         );
 	}
 
@@ -263,8 +263,8 @@ 
 	 * @return boolean
 	 */
 	public function any_reg_status_updated() {
-		foreach ( $this->reg_status_updated as $reg_status ) {
-			if ( $reg_status ) {
+		foreach ($this->reg_status_updated as $reg_status) {
+			if ($reg_status) {
 				return true;
 			}
 		}
@@ -277,8 +277,8 @@ 
 	 * @param $REG_ID
 	 * @return boolean
 	 */
-	public function reg_status_updated( $REG_ID ) {
-		return isset( $this->reg_status_updated[ $REG_ID ] ) ? $this->reg_status_updated[ $REG_ID ] : false;
+	public function reg_status_updated($REG_ID) {
+		return isset($this->reg_status_updated[$REG_ID]) ? $this->reg_status_updated[$REG_ID] : false;
 	}
 
 
@@ -287,8 +287,8 @@ 
 	 * @param $REG_ID
 	 * @param $reg_status
 	 */
-	public function set_reg_status_updated( $REG_ID, $reg_status ) {
-		$this->reg_status_updated[ $REG_ID ] = filter_var( $reg_status, FILTER_VALIDATE_BOOLEAN );
+	public function set_reg_status_updated($REG_ID, $reg_status) {
+		$this->reg_status_updated[$REG_ID] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * can ONLY be set by the  Finalize_Registration reg step
 	 */
 	public function set_exit_spco() {
-		if ( $this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration ) {
+		if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
 			$this->exit_spco = true;
 		}
 	}
@@ -326,12 +326,12 @@ 
 	 */
 	public function reset_for_current_request() {
 		$this->process_form_submission = FALSE;
-		$this->continue_reg = apply_filters( 'FHEE__EE_Checkout___construct___continue_reg', true );
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
 		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->front_ajax;
 		$this->continue_reg = true;
 		$this->redirect = false;
 		// don't reset the cached redirect form if we're about to be asked to display it !!!
-		if ( EE_Registry::instance()->REQ->get( 'action', 'display_spco_reg_step' ) !== 'redirect_form' ) {
+		if (EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step') !== 'redirect_form') {
 			$this->redirect_form = '';
 		}
 		$this->redirect_url = '';
@@ -348,8 +348,8 @@ 
 	 * @param EE_SPCO_Reg_Step $reg_step_obj
 	 * @return    void
 	 */
-	public function add_reg_step( EE_SPCO_Reg_Step $reg_step_obj ) {
-		$this->reg_steps[ $reg_step_obj->slug()  ] = $reg_step_obj;
+	public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj) {
+		$this->reg_steps[$reg_step_obj->slug()] = $reg_step_obj;
 	}
 
 
@@ -365,22 +365,22 @@ 
 	 * @return    void
 	 * @throws \EE_Error
 	 */
-	public function skip_reg_step( $reg_step_slug = '' ) {
-		$step_to_skip = $this->find_reg_step( $reg_step_slug );
-		if ( $step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step() ) {
-			$step_to_skip->set_is_current_step( false );
+	public function skip_reg_step($reg_step_slug = '') {
+		$step_to_skip = $this->find_reg_step($reg_step_slug);
+		if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
+			$step_to_skip->set_is_current_step(false);
 			$step_to_skip->set_completed();
 			// advance to the next step
-			$this->set_current_step( $this->next_step->slug() );
+			$this->set_current_step($this->next_step->slug());
 			// also reset the step param in the request in case any other code references that directly
-			EE_Registry::instance()->REQ->set( 'step', $this->current_step->slug() );
+			EE_Registry::instance()->REQ->set('step', $this->current_step->slug());
 			// since we are skipping a step and setting the current step to be what was previously the next step,
 			// we need to check that the next step is now correct, and not still set to the current step.
-			if ( $this->current_step->slug() === $this->next_step->slug() ) {
+			if ($this->current_step->slug() === $this->next_step->slug()) {
 				// correctly setup the next step
 				$this->set_next_step();
 			}
-			$this->set_reg_step_initiated( $this->current_step );
+			$this->set_reg_step_initiated($this->current_step);
 		}
 	}
 
@@ -394,14 +394,14 @@ 
 	 * @param bool   $reset whether to reset reg steps after removal
 	 * @throws EE_Error
 	 */
-	public function remove_reg_step( $reg_step_slug = '', $reset = true ) {
-		unset( $this->reg_steps[ $reg_step_slug  ] );
-		if ( $this->transaction instanceof EE_Transaction ) {
+	public function remove_reg_step($reg_step_slug = '', $reset = true) {
+		unset($this->reg_steps[$reg_step_slug]);
+		if ($this->transaction instanceof EE_Transaction) {
 			// now remove reg step from TXN and save
-			$this->transaction->remove_reg_step( $reg_step_slug );
+			$this->transaction->remove_reg_step($reg_step_slug);
 			$this->transaction->save();
 		}
-		if ( $reset ) {
+		if ($reset) {
 			$this->reset_reg_steps();
 		}
 	}
@@ -416,9 +416,9 @@ 
 	 * @param int    $order
 	 * @return    void
 	 */
-	public function set_reg_step_order( $reg_step_slug = '', $order = 100 ) {
-		if ( isset( $this->reg_steps[ $reg_step_slug  ] )) {
-			$this->reg_steps[ $reg_step_slug ]->set_order( $order );
+	public function set_reg_step_order($reg_step_slug = '', $order = 100) {
+		if (isset($this->reg_steps[$reg_step_slug])) {
+			$this->reg_steps[$reg_step_slug]->set_order($order);
 		}
 	}
 
@@ -431,25 +431,25 @@ 
 	 * @param string $current_step
 	 * @return    void
 	 */
-	public function set_current_step( $current_step ) {
+	public function set_current_step($current_step) {
 		// grab what step we're on
-		$this->current_step = isset( $this->reg_steps[ $current_step ] ) ? $this->reg_steps[ $current_step ] : reset( $this->reg_steps );
+		$this->current_step = isset($this->reg_steps[$current_step]) ? $this->reg_steps[$current_step] : reset($this->reg_steps);
 		// verify instance
-		if ( $this->current_step instanceof EE_SPCO_Reg_Step ) {
+		if ($this->current_step instanceof EE_SPCO_Reg_Step) {
 			// we don't want to repeat completed steps if this is the first time through SPCO
-			if ( $this->continue_reg && ! $this->revisit && $this->current_step->completed() ) {
+			if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
 				// so advance to the next step
 				$this->set_next_step();
-				if ( $this->next_step instanceof EE_SPCO_Reg_Step ) {
+				if ($this->next_step instanceof EE_SPCO_Reg_Step) {
 					// and attempt to set it as the current step
-					$this->set_current_step( $this->next_step->slug() );
+					$this->set_current_step($this->next_step->slug());
 				}
 				return;
 			}
-			$this->current_step->set_is_current_step( TRUE );
+			$this->current_step->set_is_current_step(TRUE);
 		} else {
 			EE_Error::add_error(
-				__( 'The current step could not be set.', 'event_espresso' ),
+				__('The current step could not be set.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -466,20 +466,20 @@ 
 	 */
 	public function set_next_step() {
 		// set pointer to start of array
-		reset( $this->reg_steps );
+		reset($this->reg_steps);
 		// if there is more than one step
-		if ( count( $this->reg_steps ) > 1 ) {
+		if (count($this->reg_steps) > 1) {
 			// advance to the current step and set pointer
-			while ( key( $this->reg_steps ) !== $this->current_step->slug() && key( $this->reg_steps ) !== '' ) {
-				next( $this->reg_steps );
+			while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
+				next($this->reg_steps);
 			}
 		}
 		// advance one more spot ( if it exists )
-		$this->next_step = next( $this->reg_steps );
+		$this->next_step = next($this->reg_steps);
 		// verify instance
-		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step  : NULL;
+		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : NULL;
 		// then back to current step to reset
-		prev( $this->reg_steps );
+		prev($this->reg_steps);
 	}
 
 
@@ -493,8 +493,8 @@ 
 	 *  @return 	EE_SPCO_Reg_Step | null
 	 */
 	public function get_next_reg_step() {
-		$next = next( $this->reg_steps );
-		prev( $this->reg_steps );
+		$next = next($this->reg_steps);
+		prev($this->reg_steps);
 		return $next instanceof EE_SPCO_Reg_Step ? $next : null;
 	}
 
@@ -509,8 +509,8 @@ 
 	 *  @return 	EE_SPCO_Reg_Step | null
 	 */
 	public function get_prev_reg_step() {
-		$prev = prev( $this->reg_steps );
-		next( $this->reg_steps );
+		$prev = prev($this->reg_steps);
+		next($this->reg_steps);
 		return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
 	}
 
@@ -523,8 +523,8 @@ 
 	 * @return void
 	 */
 	public function sort_reg_steps() {
-		$reg_step_sorting_callback = apply_filters( 'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback', 'reg_step_sorting_callback' );
-		uasort( $this->reg_steps, array( $this, $reg_step_sorting_callback ));
+		$reg_step_sorting_callback = apply_filters('FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback', 'reg_step_sorting_callback');
+		uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
 	}
 
 
@@ -537,19 +537,19 @@ 
 	 * @param string $reg_step_slug
 	 * @return EE_SPCO_Reg_Step|null
 	 */
-	public function find_reg_step( $reg_step_slug = '' ) {
-		if ( ! empty( $reg_step_slug ) ) {
+	public function find_reg_step($reg_step_slug = '') {
+		if ( ! empty($reg_step_slug)) {
 			// copy reg step array
 			$reg_steps = $this->reg_steps;
 			// set pointer to start of array
-			reset( $reg_steps );
+			reset($reg_steps);
 			// if there is more than one step
-			if ( count( $reg_steps ) > 1 ) {
+			if (count($reg_steps) > 1) {
 				// advance to the current step and set pointer
-				while ( key( $reg_steps ) !== $reg_step_slug && key( $reg_steps ) !== '' ) {
-					next( $reg_steps );
+				while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
+					next($reg_steps);
 				}
-				return current( $reg_steps );
+				return current($reg_steps);
 			}
 		}
 		return null;
@@ -565,17 +565,17 @@ 
 	 * @param EE_SPCO_Reg_Step $reg_step_B
 	 * @return int
 	 */
-	public function reg_step_sorting_callback( EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B ) {
+	public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B) {
 		// send finalize_registration step to the end of the array
-		if ( $reg_step_A->slug() === 'finalize_registration' ) {
+		if ($reg_step_A->slug() === 'finalize_registration') {
 			return 1;
-		} else if ( $reg_step_B->slug() === 'finalize_registration' ) {
+		} else if ($reg_step_B->slug() === 'finalize_registration') {
 			return -1;
 		}
-		if ( $reg_step_A->order() === $reg_step_B->order() ) {
+		if ($reg_step_A->order() === $reg_step_B->order()) {
 			return 0;
 		}
-		return ( $reg_step_A->order() > $reg_step_B->order() ) ? 1 : -1;
+		return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
 	}
 
 
@@ -587,7 +587,7 @@ 
 	 * @param    EE_SPCO_Reg_Step $reg_step
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_initiated( EE_SPCO_Reg_Step $reg_step ) {
+	public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step) {
 		// call set_reg_step_initiated ???
 		if (
 			// first time visiting SPCO ?
@@ -600,11 +600,11 @@ 
 			)
 		) {
 			// set the start time for this reg step
-			if ( ! $this->transaction->set_reg_step_initiated( $reg_step->slug() ) ) {
-				if ( WP_DEBUG ) {
+			if ( ! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+				if (WP_DEBUG) {
 					EE_Error::add_error(
 						sprintf(
-							__( 'The "%1$s" registration step was not initialized properly.', 'event_espresso' ),
+							__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
 							$reg_step->name()
 						),
 						__FILE__, __FUNCTION__, __LINE__
@@ -623,10 +623,10 @@ 
 	 * 	@return 	void
 	 */
 	public function set_reg_step_JSON_info() {
-		EE_Registry::$i18n_js_strings[ 'reg_steps' ] = array();
+		EE_Registry::$i18n_js_strings['reg_steps'] = array();
 		// pass basic reg step data to JS
-		foreach ( $this->reg_steps as $reg_step ) {
-			EE_Registry::$i18n_js_strings[ 'reg_steps' ][] = $reg_step->slug();
+		foreach ($this->reg_steps as $reg_step) {
+			EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
 		}
 		// reset reg step html
 //		$this->json_response->set_reg_step_html( '' );
@@ -642,7 +642,7 @@ 
 	 */
 	public function reset_reg_steps() {
 		$this->sort_reg_steps();
-		$this->set_current_step( EE_Registry::instance()->REQ->get( 'step' ));
+		$this->set_current_step(EE_Registry::instance()->REQ->get('step'));
 		$this->set_next_step();
 		// the text that appears on the reg step form submit button
 		$this->current_step->set_submit_button_text();
@@ -659,9 +659,9 @@ 
 	 */
 	public function get_registration_time_limit() {
 
-		$registration_time_limit = (float)( EE_Registry::instance()	->SSN->expiration() - time() );
+		$registration_time_limit = (float) (EE_Registry::instance()	->SSN->expiration() - time());
 		$time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
-		$registration_time_limit = date( $time_limit_format, $registration_time_limit );
+		$registration_time_limit = date($time_limit_format, $registration_time_limit);
 		return apply_filters(
 			'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
 			$registration_time_limit
@@ -681,7 +681,7 @@ 
 		//		overpaid TXN
 		//		free TXN ( total = 0.00 )
 		// then payment required is TRUE
-		return ! ( $this->admin_request || $this->transaction->is_completed() || $this->transaction->is_overpaid() || $this->transaction->is_free() ) ? TRUE : FALSE;
+		return ! ($this->admin_request || $this->transaction->is_completed() || $this->transaction->is_overpaid() || $this->transaction->is_free()) ? TRUE : FALSE;
 	}
 
 
@@ -693,12 +693,12 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Cart
 	 */
-	public function get_cart_for_transaction( $transaction ) {
-		$session = EE_Registry::instance()->load_core( 'Session' );
-		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn( $transaction, $session ) : null;
+	public function get_cart_for_transaction($transaction) {
+		$session = EE_Registry::instance()->load_core('Session');
+		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
 		// verify cart
-		if ( ! $cart instanceof EE_Cart ) {
-			$cart = EE_Registry::instance()->load_core( 'Cart' );
+		if ( ! $cart instanceof EE_Cart) {
+			$cart = EE_Registry::instance()->load_core('Cart');
 		}
 
 		return $cart;
@@ -714,8 +714,8 @@ 
 	 */
 	public function initialize_txn_reg_steps_array() {
 		$txn_reg_steps_array = array();
-		foreach ( $this->reg_steps as $reg_step ) {
-			$txn_reg_steps_array[ $reg_step->slug() ] = FALSE;
+		foreach ($this->reg_steps as $reg_step) {
+			$txn_reg_steps_array[$reg_step->slug()] = FALSE;
 		}
 		return $txn_reg_steps_array;
 	}
@@ -731,14 +731,14 @@ 
 	 */
 	public function update_txn_reg_steps_array() {
 		$updated = false;
-		foreach ( $this->reg_steps as $reg_step ) {
-			if ( $reg_step->completed() ) {
-				$updated = $this->transaction->set_reg_step_completed( $reg_step->slug() )
+		foreach ($this->reg_steps as $reg_step) {
+			if ($reg_step->completed()) {
+				$updated = $this->transaction->set_reg_step_completed($reg_step->slug())
 					? true
 					: $updated;
 			}
 		}
-		if ( $updated ) {
+		if ($updated) {
 			$this->transaction->save();
 		}
 		return $updated;
@@ -754,14 +754,14 @@ 
 	 * @throws \EE_Error
 	 */
 	public function stash_transaction_and_checkout() {
-		if ( ! $this->revisit ) {
+		if ( ! $this->revisit) {
 			$this->update_txn_reg_steps_array();
 		}
 		$this->track_transaction_and_registration_status_updates();
 		// save all data to the db, but suppress errors
 		//$this->save_all_data( FALSE );
 		// cache the checkout in the session
-		EE_Registry::instance()->SSN->set_checkout( $this );
+		EE_Registry::instance()->SSN->set_checkout($this);
 	}
 
 
@@ -776,15 +776,15 @@ 
 	 */
 	public function track_transaction_and_registration_status_updates() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction ) {
+		if ($this->transaction instanceof EE_Transaction) {
 			// has there been a TXN status change during this checkout?
 			$this->txn_status_updated = $this->transaction->txn_status_updated();
 			/** @type EE_Registration_Processor $registration_processor */
-			$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 			// grab the saved registrations from the transaction
-			foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as $registration ) {
-				if ( $registration_processor->reg_status_updated( $registration->ID() ) ) {
-					$this->set_reg_status_updated( $registration->ID(), true );
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				if ($registration_processor->reg_status_updated($registration->ID())) {
+					$this->set_reg_status_updated($registration->ID(), true);
 				}
 			}
 		}
@@ -805,7 +805,7 @@ 
 	 * @return    bool
 	 * @throws \EE_Error
 	 */
-	public function visit_allows_processing_of_this_registration( EE_Registration $registration ) {
+	public function visit_allows_processing_of_this_registration(EE_Registration $registration) {
 		return ! $this->revisit
 		       || $this->primary_revisit
 		       || (
@@ -838,18 +838,18 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function save_all_data( $show_errors = TRUE ) {
+	public function save_all_data($show_errors = TRUE) {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction ) {
+		if ($this->transaction instanceof EE_Transaction) {
 			// save to ensure that TXN has ID
 			$this->transaction->save();
 			// grab the saved registrations from the transaction
-			foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as  $registration ) {
-				$this->_save_registration( $registration, $show_errors );
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as  $registration) {
+				$this->_save_registration($registration, $show_errors);
 			}
 		} else {
-			if ( $show_errors ) {
-				EE_Error::add_error( __( 'A valid Transaction was not found when attempting to save your registration information.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			if ($show_errors) {
+				EE_Error::add_error(__('A valid Transaction was not found when attempting to save your registration information.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			}
 			return FALSE;
 		}
@@ -866,32 +866,32 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration( $registration, $show_errors = TRUE  ) {
+	private function _save_registration($registration, $show_errors = TRUE) {
 		// verify object
-		if ( $registration instanceof EE_Registration ) {
+		if ($registration instanceof EE_Registration) {
 			// should this registration be processed during this visit ?
-			if ( $this->visit_allows_processing_of_this_registration( $registration ) ) {
+			if ($this->visit_allows_processing_of_this_registration($registration)) {
 				//set TXN ID
-				if ( ! $registration->transaction_ID() ) {
-					$registration->set_transaction_id( $this->transaction->ID() );
+				if ( ! $registration->transaction_ID()) {
+					$registration->set_transaction_id($this->transaction->ID());
 				}
 				// verify and save the attendee
-				$this->_save_registration_attendee( $registration, $show_errors );
+				$this->_save_registration_attendee($registration, $show_errors);
 				// save answers to reg form questions
-				$this->_save_registration_answers( $registration, $show_errors );
+				$this->_save_registration_answers($registration, $show_errors);
 				// save changes
 				$registration->save();
 				// update txn cache
-				if ( ! $this->transaction->update_cache_after_object_save( 'Registration', $registration )) {
-					if ( $show_errors ) {
-						EE_Error::add_error( __( 'The newly saved Registration object could not be cached on the Transaction.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+				if ( ! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+					if ($show_errors) {
+						EE_Error::add_error(__('The newly saved Registration object could not be cached on the Transaction.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 					}
 				}
 			}
 		} else {
-			if ( $show_errors ) {
+			if ($show_errors) {
 				EE_Error::add_error(
-					__( 'An invalid Registration object was discovered when attempting to save your registration information.', 'event_espresso' ),
+					__('An invalid Registration object was discovered when attempting to save your registration information.', 'event_espresso'),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -908,25 +908,25 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration_attendee( $registration, $show_errors = TRUE ) {
-		if ( $registration->attendee() instanceof EE_Attendee ) {
+	private function _save_registration_attendee($registration, $show_errors = TRUE) {
+		if ($registration->attendee() instanceof EE_Attendee) {
 			// save so that ATT has ID
 			$registration->attendee()->save();
-			if ( ! $registration->update_cache_after_object_save( 'Attendee', $registration->attendee() ) ) {
-				if ( $show_errors ) {
+			if ( ! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+				if ($show_errors) {
 					EE_Error::add_error(
-						__( 'The newly saved Attendee object could not be cached on the registration.', 'event_espresso' ),
+						__('The newly saved Attendee object could not be cached on the registration.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 					);
 				}
 			}
 		} else {
-			if ( $show_errors ) {
+			if ($show_errors) {
 				EE_Error::add_error(
 					sprintf(
 						'%1$s||%1$s $attendee = %2$s',
-						__( 'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.', 'event_espresso' ),
-						var_export( $registration->attendee(), true )
+						__('Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.', 'event_espresso'),
+						var_export($registration->attendee(), true)
 					),
 					__FILE__, __FUNCTION__, __LINE__
 				);
@@ -944,25 +944,25 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _save_registration_answers( $registration, $show_errors = TRUE ) {
+	private function _save_registration_answers($registration, $show_errors = TRUE) {
 		// now save the answers
-		foreach ( $registration->answers() as $cache_key => $answer ) {
+		foreach ($registration->answers() as $cache_key => $answer) {
 			// verify object
-			if ( $answer instanceof EE_Answer ) {
-				$answer->set_registration( $registration->ID() );
+			if ($answer instanceof EE_Answer) {
+				$answer->set_registration($registration->ID());
 				$answer->save();
-				if ( ! $registration->update_cache_after_object_save( 'Answer', $answer, $cache_key )) {
-					if ( $show_errors ) {
+				if ( ! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+					if ($show_errors) {
 						EE_Error::add_error(
-							__( 'The newly saved Answer object could not be cached on the registration.', 'event_espresso' ),
+							__('The newly saved Answer object could not be cached on the registration.', 'event_espresso'),
 							__FILE__, __FUNCTION__, __LINE__
 						);
 					}
 				}
 			} else {
-				if ( $show_errors ) {
+				if ($show_errors) {
 					EE_Error::add_error(
-						__( 'An invalid Answer object was discovered when attempting to save your registration information.', 'event_espresso' ),
+						__('An invalid Answer object was discovered when attempting to save your registration information.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 					);
 				}
@@ -981,7 +981,7 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function refresh_all_entities( $from_db = false ) {
+	public function refresh_all_entities($from_db = false) {
 		$from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
 			? true
 			: $from_db;
@@ -1005,11 +1005,11 @@ 
 	 */
 	protected function refresh_from_db() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 			// pull fresh TXN data from the db
-			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db( $this->transaction->ID() );
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
 			// update EE_Checkout's cached primary_attendee object
-			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db( $this->transaction );
+			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
 			// update EE_Checkout's cached payment object
 			$payment = $this->transaction->last_payment();
 			$this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
@@ -1017,9 +1017,9 @@ 
 			$payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
 			$this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method : $this->payment_method;
 			//now refresh the cart, based on the TXN
-			$this->cart = $this->get_cart_for_transaction( $this->transaction );
+			$this->cart = $this->get_cart_for_transaction($this->transaction);
 		} else {
-			EE_Error::add_error( __( 'A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			EE_Error::add_error(__('A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		return TRUE;
@@ -1034,21 +1034,21 @@ 
 	 * @return  EE_Attendee | null
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_primary_attendee_obj_from_db( EE_Transaction $transaction ) {
+	protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction) {
 
 		$primary_attendee_obj = null;
 		// grab the saved registrations from the transaction
-		foreach ( $transaction->registrations( $this->reg_cache_where_params, true ) as $registration ) {
+		foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
 			// verify object
-			if ( $registration instanceof EE_Registration ) {
+			if ($registration instanceof EE_Registration) {
 				$attendee = $registration->attendee();
 				// verify object && maybe cache primary_attendee_obj ?
-				if ( $attendee instanceof EE_Attendee&& $registration->is_primary_registrant() ) {
+				if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
 					$primary_attendee_obj = $attendee;
 				}
 			} else {
 				EE_Error::add_error(
-						__( 'An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+						__('An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 						__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -1069,43 +1069,43 @@ 
 	 */
 	protected function refresh_entity_map() {
 		// verify the transaction
-		if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 			// never cache payment info
-			$this->transaction->clear_cache( 'Payment' );
+			$this->transaction->clear_cache('Payment');
 			// is the Payment Options Reg Step completed ?
-			if ( $this->transaction->reg_step_completed( 'payment_options' ) ) {
+			if ($this->transaction->reg_step_completed('payment_options')) {
 				// then check for payments and update TXN accordingly
 				/** @type EE_Transaction_Payments $transaction_payments */
-				$transaction_payments = EE_Registry::instance()->load_class( 'Transaction_Payments' );
-				$transaction_payments->calculate_total_payments_and_update_status( $this->transaction );
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				$transaction_payments->calculate_total_payments_and_update_status($this->transaction);
 			}
 			// grab the saved registrations from the transaction
 			foreach (
-				$this->transaction->registrations( $this->reg_cache_where_params ) as $reg_cache_ID => $registration
+				$this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration
 			) {
-				$this->_refresh_registration( $reg_cache_ID, $registration );
+				$this->_refresh_registration($reg_cache_ID, $registration);
 			}
 			// make sure our cached TXN is added to the model entity mapper
-			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with( $this->transaction->ID(), $this->transaction );
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with($this->transaction->ID(), $this->transaction);
 
 		} else {
-			EE_Error::add_error( __( 'A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__);
+			EE_Error::add_error(__('A valid Transaction was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		// verify and update the cart because inaccurate totals are not so much fun
-		if ( $this->cart instanceof EE_Cart ) {
+		if ($this->cart instanceof EE_Cart) {
 			$grand_total = $this->cart->get_grand_total();
-			if ( $grand_total instanceof EE_Line_Item && $grand_total->ID() ) {
+			if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
 				$grand_total->recalculate_total_including_taxes();
 				$grand_total = $grand_total->get_model()->refresh_entity_map_with(
 					$this->cart->get_grand_total()->ID(),
 					$this->cart->get_grand_total()
 				);
 			}
-			if ( $grand_total instanceof EE_Line_Item ) {
-				$this->cart = EE_Cart::instance( $grand_total );
+			if ($grand_total instanceof EE_Line_Item) {
+				$this->cart = EE_Cart::instance($grand_total);
 			} else {
-				EE_Error::add_error( __( 'A valid Cart was not found when attempting to update the model entity mapper.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(__('A valid Cart was not found when attempting to update the model entity mapper.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 				return false;
 			}
 		}
@@ -1122,19 +1122,19 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration( $reg_cache_ID, $registration ) {
+	protected function _refresh_registration($reg_cache_ID, $registration) {
 
 		// verify object
-		if ( $registration instanceof EE_Registration ) {
+		if ($registration instanceof EE_Registration) {
 			// update the entity mapper attendee
-			$this->_refresh_registration_attendee( $registration );
+			$this->_refresh_registration_attendee($registration);
 			// update the entity mapper answers for reg form questions
-			$this->_refresh_registration_answers( $registration );
+			$this->_refresh_registration_answers($registration);
 			// make sure the cached registration is added to the model entity mapper
-			$registration->get_model()->refresh_entity_map_with( $reg_cache_ID, $registration );
+			$registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
 		} else {
 			EE_Error::add_error(
-				__( 'An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+				__('An invalid Registration object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 		}
@@ -1149,15 +1149,15 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration_attendee( $registration ) {
+	protected function _refresh_registration_attendee($registration) {
 
 		$attendee = $registration->attendee();
 		// verify object
-		if ( $attendee instanceof EE_Attendee && $attendee->ID() ) {
+		if ($attendee instanceof EE_Attendee && $attendee->ID()) {
 			// make sure the cached attendee is added to the model entity mapper
-			$registration->attendee()->get_model()->refresh_entity_map_with( $attendee->ID(), $attendee );
+			$registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
 			// maybe cache primary_attendee_obj ?
-			if ( $registration->is_primary_registrant() ) {
+			if ($registration->is_primary_registrant()) {
 				$this->primary_attendee_obj = $attendee;
 			}
 		}
@@ -1172,19 +1172,19 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _refresh_registration_answers( $registration ) {
+	protected function _refresh_registration_answers($registration) {
 
 		// now update the answers
-		foreach ( $registration->answers() as $cache_key => $answer ) {
+		foreach ($registration->answers() as $cache_key => $answer) {
 			// verify object
-			if ( $answer instanceof EE_Answer ) {
-				if ( $answer->ID() ) {
+			if ($answer instanceof EE_Answer) {
+				if ($answer->ID()) {
 					// make sure the cached answer is added to the model entity mapper
-					$answer->get_model()->refresh_entity_map_with( $answer->ID(), $answer );
+					$answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
 				}
 			} else {
 				EE_Error::add_error(
-					__( 'An invalid Answer object was discovered when attempting to update the model entity mapper.', 'event_espresso' ),
+					__('An invalid Answer object was discovered when attempting to update the model entity mapper.', 'event_espresso'),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 			}
@@ -1204,13 +1204,13 @@ 
 	 */
     public function __sleep()
     {
-	    if ( $this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID() ) {
+	    if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
 		    $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
 	    }        // remove the reg form and the checkout
-	    if ( $this->transaction instanceof EE_Transaction && $this->transaction->ID() ) {
+	    if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
 		    $this->transaction = $this->transaction->ID();
 	    }        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'billing_form', 'registration_form' ) );
+        return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
     }
 
 
@@ -1220,15 +1220,15 @@ 
 	 * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
 	 */
 	public function __wakeup() {
-		if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint( $this->primary_attendee_obj ) !== 0 ) {
+		if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
 			// $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
-			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID( $this->primary_attendee_obj );
+			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
 		}
-		if ( ! $this->transaction instanceof EE_Transaction && absint( $this->transaction ) !== 0 ) {
+		if ( ! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
 			// $this->transaction is actually just an ID, so use it to get the object from the db
-			$this->transaction = EEM_Transaction::instance()->get_one_by_ID( $this->transaction );
+			$this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
 		}
-		foreach ( $this->reg_steps as $reg_step ) {
+		foreach ($this->reg_steps as $reg_step) {
 			$reg_step->checkout = $this;
 		}
 	}
@@ -1245,12 +1245,12 @@ 
 	 * @param bool   $display_request
 	 * @throws \EE_Error
 	 */
-	public function log( $class = '', $func = '', $line = '', $info = array(), $display_request = false ) {
+	public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false) {
 		$disabled = true;
-		if ( WP_DEBUG && ! $disabled ) {
-			$debug_data = get_option( 'EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array() );
+		if (WP_DEBUG && ! $disabled) {
+			$debug_data = get_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), array());
 			$default_data = array(
-				$class 		=> $func . '() : ' . $line,
+				$class 		=> $func.'() : '.$line,
 				'request->step' 		=> $this->step,
 				'request->action' 	=> $this->action,
 				'current_step->slug' => $this->current_step instanceof EE_SPCO_Reg_Step ?
@@ -1262,24 +1262,24 @@ 
 				'reg_url_link' => $this->reg_url_link,
 				'REQ' => $display_request ? $_REQUEST : '',
 			);
-			if ( $this->transaction instanceof EE_Transaction ) {
-				$default_data[ 'TXN_status' ] 		= $this->transaction->status_ID();
-				$default_data[ 'TXN_reg_steps' ] 	= $this->transaction->reg_steps();
-				foreach ( $this->transaction->registrations( $this->reg_cache_where_params ) as $REG_ID => $registration ) {
-					$default_data[ 'registrations' ][ $REG_ID ] = $registration->status_ID();
+			if ($this->transaction instanceof EE_Transaction) {
+				$default_data['TXN_status'] = $this->transaction->status_ID();
+				$default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
+				foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
+					$default_data['registrations'][$REG_ID] = $registration->status_ID();
 				}
-				if ( $this->transaction->ID() ) {
-					$TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+				if ($this->transaction->ID()) {
+					$TXN_ID = 'EE_Transaction: '.$this->transaction->ID();
 					// don't serialize objects
-					$info = $this->_strip_objects( $info );
-					if ( ! isset( $debug_data[ $TXN_ID ] ) ) {
-						$debug_data[ $TXN_ID ] = array();
+					$info = $this->_strip_objects($info);
+					if ( ! isset($debug_data[$TXN_ID])) {
+						$debug_data[$TXN_ID] = array();
 					}
-					$debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+					$debug_data[$TXN_ID][microtime()] = array_merge(
 						$default_data,
 						$info
 					);
-					update_option( 'EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data );
+					update_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), $debug_data);
 				}
 			}
 		}
@@ -1292,23 +1292,23 @@ 
 	 * @param array $info
 	 * @return array
 	 */
-	public function _strip_objects( $info = array() ) {
-		foreach ( (array)$info as $key => $value ) {
-			if ( is_array( $value )) {
-				$info[ $key ] = $this->_strip_objects( $value );
-			} else if ( is_object( $value ) ) {
-				$object_class = get_class( $value );
-				$info[ $object_class ] = array();
-				$info[ $object_class ][ 'ID' ] = method_exists( $value, 'ID' ) ? $value->ID() : 0;
-				if ( method_exists( $value, 'status' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status();
-				} else if ( method_exists( $value, 'status_ID' ) ) {
-					$info[ $object_class ][ 'status' ] = $value->status_ID();
+	public function _strip_objects($info = array()) {
+		foreach ((array) $info as $key => $value) {
+			if (is_array($value)) {
+				$info[$key] = $this->_strip_objects($value);
+			} else if (is_object($value)) {
+				$object_class = get_class($value);
+				$info[$object_class] = array();
+				$info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+				if (method_exists($value, 'status')) {
+					$info[$object_class]['status'] = $value->status();
+				} else if (method_exists($value, 'status_ID')) {
+					$info[$object_class]['status'] = $value->status_ID();
 				}
-				unset( $info[ $key ] );
+				unset($info[$key]);
 			}
 		}
-		return (array)$info;
+		return (array) $info;
 	}
 
 

core/domain/services/registration/UpdateRegistrationService.php

Indentation +20 added lines, -20 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\domain\services\DomainService;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,25 +20,25 @@ 
 class UpdateRegistrationService extends DomainService
 {
 
-    /**
-     * @param \EE_Registration $registration
-     * @return bool
-     */
-    public function updateRegistrationAndTransaction(\EE_Registration $registration)
-    {
-        $transaction = $registration->transaction();
-        // reset transaction status back to incomplete
-        $transaction->set_status(\EEM_Transaction::incomplete_status_code);
-        // update transaction and all line item totals and subtotals
-        $transaction->total_line_item()->recalculate_total_including_taxes();
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid();
-        /** @type \EE_Registration_Processor $registration_processor */
-        $registration_processor = \EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->update_registration_final_prices($transaction);
-        $registration_processor->update_registration_status_and_trigger_notifications($registration);
-        return true;
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @return bool
+	 */
+	public function updateRegistrationAndTransaction(\EE_Registration $registration)
+	{
+		$transaction = $registration->transaction();
+		// reset transaction status back to incomplete
+		$transaction->set_status(\EEM_Transaction::incomplete_status_code);
+		// update transaction and all line item totals and subtotals
+		$transaction->total_line_item()->recalculate_total_including_taxes();
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid();
+		/** @type \EE_Registration_Processor $registration_processor */
+		$registration_processor = \EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->update_registration_final_prices($transaction);
+		$registration_processor->update_registration_status_and_trigger_notifications($registration);
+		return true;
+	}
 
 }
 // End of file UpdateRegistrationService.php

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1012 added lines, -1012 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,1073 +19,1073 @@ 
 {
 
 
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
 
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     * (first argument passed to EE_Register_Addon::register()), keys are
-     * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     * Generally this should be used sparingly, as we don't want to muddle up
-     * EE core with knowledge of ALL the addons out there.
-     * If you want NO versions of an addon to run with a certain version of core,
-     * it's usually best to define the addon's "min_core_version" as part of its call
-     * to EE_Register_Addon::register(), rather than using this array with a super high value for its
-     * minimum plugin version.
-     * @access    protected
-     */
-    protected static $_incompatible_addons = array(
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    );
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 * (first argument passed to EE_Register_Addon::register()), keys are
+	 * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 * Generally this should be used sparingly, as we don't want to muddle up
+	 * EE core with knowledge of ALL the addons out there.
+	 * If you want NO versions of an addon to run with a certain version of core,
+	 * it's usually best to define the addon's "min_core_version" as part of its call
+	 * to EE_Register_Addon::register(), rather than using this array with a super high value for its
+	 * minimum plugin version.
+	 * @access    protected
+	 */
+	protected static $_incompatible_addons = array(
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	);
 
 
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version($min_core_version)
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        //check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        //soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version($min_core_version)
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		//check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		//soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
 
 
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return boolean
-     */
-    public static function _meets_min_core_version_requirement(
-        $min_core_version,
-        $actual_core_version = EVENT_ESPRESSO_VERSION
-    ) {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return boolean
+	 */
+	public static function _meets_min_core_version_requirement(
+		$min_core_version,
+		$actual_core_version = EVENT_ESPRESSO_VERSION
+	) {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
 
 
-    /**
-     *    Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @since    4.3.0
-     * @param string                  $addon_name                           the EE_Addon's name. Required.
-     * @param  array                  $setup_args                           {                                    An
-     *                                                                      array of arguments provided for registering
-     *                                                                      the message type.
-     * @type  string                  $class_name                           the addon's main file name.
-     *                                                                      If left blank, generated from the addon
-     *                                                                      name, changes something like "calendar" to
-     *                                                                      "EE_Calendar"
-     * @type string                   $min_core_version                     the minimum version of EE Core that the
-     *       addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                              the "software" version for the addon. eg
-     *       "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                       the full server path to the main file
-     *       loaded
-     *                                                                      directly by WP
-     * @type string                   $admin_path                           full server path to the folder where the
-     *       addon\'s admin files reside
-     * @type string                   $admin_callback                       a method to be called when the EE Admin is
-     *       first invoked, can be used for hooking into any admin page
-     * @type string                   $config_section                       the section name for this addon's
-     *       configuration settings section (defaults to "addons")
-     * @type string                   $config_class                         the class name for this addon's
-     *       configuration settings object
-     * @type string                   $config_name                          the class name for this addon's
-     *       configuration settings object
-     * @type string                   $autoloader_paths                     an array of class names and the full server
-     *       paths to those files. Required.
-     * @type string                   $autoloader_folders                   an array of  "full server paths" for any
-     *       folders containing classes that might be invoked by the addon
-     * @type string                   $dms_paths                            an array of full server paths to folders
-     *       that contain data migration scripts. Required.
-     * @type string                   $module_paths                         an array of full server paths to any
-     *       EED_Modules used by the addon
-     * @type string                   $shortcode_paths                      an array of full server paths to folders
-     *       that contain EES_Shortcodes
-     * @type string                   $widget_paths                         an array of full server paths to folders
-     *       that contain WP_Widgets
-     * @type string                   $pue_options
-     * @type array                    $capabilities                         an array indexed by role name
-     *                                                                      (i.e administrator,author ) and the values
-     *                                                                      are an array of caps to add to the role.
-     *                                                                      'administrator' => array(
-     *                                                                      'read_addon', 'edit_addon', etc.
-     *                                                                      ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                      an array of EE_Meta_Capability_Map object
-     *       for any addons that need to register any special meta mapped capabilities.  Should be indexed where the
-     *       key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class.
-     * @type array                    $model_paths                          array of folders containing DB models
-     * @see      EE_Register_Model
-     * @type array                    $class_paths                          array of folders containing DB classes
-     * @see      EE_Register_Model
-     * @type array                    $model_extension_paths                array of folders containing DB model
-     *       extensions
-     * @see      EE_Register_Model_Extension
-     * @type array                    $class_extension_paths                array of folders containing DB class
-     *       extensions
-     * @see      EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                      An array of message types with the key as
-     *                                                                      the message type name and the values as
-     *                                                                      below:
-     * @type string                   $mtfilename                           The filename of the message type being
-     *       registered. This will be the main EE_{Messagetype_Name}_message_type class.
-     *                                                                      (eg.
-     *                                                                      EE_Declined_Registration_message_type.class.php)
-     *                                                                      Required.
-     * @type array                    $autoloadpaths                        An array of paths to add to the messages
-     *                                                                      autoloader for the new message type.
-     *                                                                      Required.
-     * @type array                    $messengers_to_activate_with          An array of messengers that this message
-     *                                                                      type should activate with. Each value in
-     *                                                                      the
-     *                                                                      array
-     *                                                                      should match the name property of a
-     *                                                                      EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with          An array of messengers that this message
-     *                                                                      type should validate with. Each value in
-     *                                                                      the
-     *                                                                      array
-     *                                                                      should match the name property of an
-     *                                                                      EE_messenger.
-     *                                                                      Optional.
-     *                                                                      }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths                 each element is the folder containing the
-     *                                                                      EE_PMT_Base child class
-     *                                                                      (eg,
-     *                                                                      '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                      which contains the files
-     *                                                                      EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                            {
-     *                                                                      An array with two items for registering the
-     *                                                                      addon's namespace. (If, for some reason,
-     *                                                                      you
-     *                                                                      require additional namespaces, use
-     *                                                                      EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                      directly)
-     * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                                 the namespace prefix
-     * @type string                   $DIR                                  a base directory for class files in the
-     *       namespace.
-     *                                                                      }
-     *                                                                      }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        //setup $_settings array from incoming values.
-        $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return;
-        }
-        // register namespaces
-        \EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        \EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        \EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        \EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        \EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        \EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        \EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        \EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        \EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        \EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        \EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        \EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        \EE_Register_Addon::_register_payment_methods($addon_name);
-        // load and instantiate main addon class
-        $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
+	/**
+	 *    Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @since    4.3.0
+	 * @param string                  $addon_name                           the EE_Addon's name. Required.
+	 * @param  array                  $setup_args                           {                                    An
+	 *                                                                      array of arguments provided for registering
+	 *                                                                      the message type.
+	 * @type  string                  $class_name                           the addon's main file name.
+	 *                                                                      If left blank, generated from the addon
+	 *                                                                      name, changes something like "calendar" to
+	 *                                                                      "EE_Calendar"
+	 * @type string                   $min_core_version                     the minimum version of EE Core that the
+	 *       addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                              the "software" version for the addon. eg
+	 *       "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                       the full server path to the main file
+	 *       loaded
+	 *                                                                      directly by WP
+	 * @type string                   $admin_path                           full server path to the folder where the
+	 *       addon\'s admin files reside
+	 * @type string                   $admin_callback                       a method to be called when the EE Admin is
+	 *       first invoked, can be used for hooking into any admin page
+	 * @type string                   $config_section                       the section name for this addon's
+	 *       configuration settings section (defaults to "addons")
+	 * @type string                   $config_class                         the class name for this addon's
+	 *       configuration settings object
+	 * @type string                   $config_name                          the class name for this addon's
+	 *       configuration settings object
+	 * @type string                   $autoloader_paths                     an array of class names and the full server
+	 *       paths to those files. Required.
+	 * @type string                   $autoloader_folders                   an array of  "full server paths" for any
+	 *       folders containing classes that might be invoked by the addon
+	 * @type string                   $dms_paths                            an array of full server paths to folders
+	 *       that contain data migration scripts. Required.
+	 * @type string                   $module_paths                         an array of full server paths to any
+	 *       EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                      an array of full server paths to folders
+	 *       that contain EES_Shortcodes
+	 * @type string                   $widget_paths                         an array of full server paths to folders
+	 *       that contain WP_Widgets
+	 * @type string                   $pue_options
+	 * @type array                    $capabilities                         an array indexed by role name
+	 *                                                                      (i.e administrator,author ) and the values
+	 *                                                                      are an array of caps to add to the role.
+	 *                                                                      'administrator' => array(
+	 *                                                                      'read_addon', 'edit_addon', etc.
+	 *                                                                      ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                      an array of EE_Meta_Capability_Map object
+	 *       for any addons that need to register any special meta mapped capabilities.  Should be indexed where the
+	 *       key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class.
+	 * @type array                    $model_paths                          array of folders containing DB models
+	 * @see      EE_Register_Model
+	 * @type array                    $class_paths                          array of folders containing DB classes
+	 * @see      EE_Register_Model
+	 * @type array                    $model_extension_paths                array of folders containing DB model
+	 *       extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths                array of folders containing DB class
+	 *       extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                      An array of message types with the key as
+	 *                                                                      the message type name and the values as
+	 *                                                                      below:
+	 * @type string                   $mtfilename                           The filename of the message type being
+	 *       registered. This will be the main EE_{Messagetype_Name}_message_type class.
+	 *                                                                      (eg.
+	 *                                                                      EE_Declined_Registration_message_type.class.php)
+	 *                                                                      Required.
+	 * @type array                    $autoloadpaths                        An array of paths to add to the messages
+	 *                                                                      autoloader for the new message type.
+	 *                                                                      Required.
+	 * @type array                    $messengers_to_activate_with          An array of messengers that this message
+	 *                                                                      type should activate with. Each value in
+	 *                                                                      the
+	 *                                                                      array
+	 *                                                                      should match the name property of a
+	 *                                                                      EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with          An array of messengers that this message
+	 *                                                                      type should validate with. Each value in
+	 *                                                                      the
+	 *                                                                      array
+	 *                                                                      should match the name property of an
+	 *                                                                      EE_messenger.
+	 *                                                                      Optional.
+	 *                                                                      }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths                 each element is the folder containing the
+	 *                                                                      EE_PMT_Base child class
+	 *                                                                      (eg,
+	 *                                                                      '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                      which contains the files
+	 *                                                                      EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                            {
+	 *                                                                      An array with two items for registering the
+	 *                                                                      addon's namespace. (If, for some reason,
+	 *                                                                      you
+	 *                                                                      require additional namespaces, use
+	 *                                                                      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                      directly)
+	 * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                                 the namespace prefix
+	 * @type string                   $DIR                                  a base directory for class files in the
+	 *       namespace.
+	 *                                                                      }
+	 *                                                                      }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		\EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		//setup $_settings array from incoming values.
+		$addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		\EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return;
+		}
+		// register namespaces
+		\EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		\EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		\EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		\EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		\EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		\EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		\EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		\EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		\EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		\EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		\EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		\EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		\EE_Register_Addon::_register_payment_methods($addon_name);
+		// load and instantiate main addon class
+		$addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
 
-        //delay calling after_registration hook on each addon until after all add-ons have been registered.
-        add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
-    }
+		//delay calling after_registration hook on each addon until after all add-ons have been registered.
+		add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            //capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			//capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
+	}
 
 
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        //setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
-            //the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace'],
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array)$setup_args['namespace']
-                : array(),
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		//setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string)$setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string)$setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string)$setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string)$setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string)$setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string)$setup_args['main_file_path']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string)$setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string)$setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string)$setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string)$setup_args['config_class'] : '',
+			//the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string)$setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array)$setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array)$setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array)$setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array)$setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array)$setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array)$setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array)$setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array)$setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array)$setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array)$setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array)$setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array)$setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array)$setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array)$setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array)$setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array)$setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array)$setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array)$setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace'],
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array)$setup_args['namespace']
+				: array(),
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
-    private static function _addon_is_compatible($addon_name, array $addon_settings)
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        //check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (
-        ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
+	private static function _addon_is_compatible($addon_name, array $addon_settings)
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		//check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (
+		! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[$addon_name]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
-    }
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[$addon_name]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string)$setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string)$setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string)$setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string)$setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
+	}
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-        isset(
-            $addon_settings['namespace'],
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+		isset(
+			$addon_settings['namespace'],
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
-    private static function _addon_activation($addon_name, array $addon_settings)
-    {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            //to find if THIS is the addon that was activated, just check if we have already registered it or not
-            //(as the newly-activated addon wasn't around the first time addons were registered).
-            //Note: the presence of pue_options in the addon registration options will initialize the $_settings
-            //property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[$addon_name])
-                || (isset(self::$_settings[$addon_name])
-                    && ! isset(self::$_settings[$addon_name]['class_name'])
-                )
-            ) {
-                self::$_settings[$addon_name] = $addon_settings;
-                $addon                        = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-        // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[$addon_name])) {
-            self::$_settings[$addon_name] += $addon_settings;
-        } else {
-            self::$_settings[$addon_name] = $addon_settings;
-        }
-        return false;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
+	private static function _addon_activation($addon_name, array $addon_settings)
+	{
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			//to find if THIS is the addon that was activated, just check if we have already registered it or not
+			//(as the newly-activated addon wasn't around the first time addons were registered).
+			//Note: the presence of pue_options in the addon registration options will initialize the $_settings
+			//property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
+			if (! isset(self::$_settings[$addon_name])
+				|| (isset(self::$_settings[$addon_name])
+					&& ! isset(self::$_settings[$addon_name]['class_name'])
+				)
+			) {
+				self::$_settings[$addon_name] = $addon_settings;
+				$addon                        = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+		// make sure addon settings are set correctly without overwriting anything existing
+		if (isset(self::$_settings[$addon_name])) {
+			self::$_settings[$addon_name] += $addon_settings;
+		} else {
+			self::$_settings[$addon_name] = $addon_settings;
+		}
+		return false;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+			foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
 
 
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_models_and_extensions($addon_name)
-    {
-        // register new models
-        if (
-            ! empty(self::$_settings[$addon_name]['model_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
-                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
-                )
-            );
-        }
-    }
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_models_and_extensions($addon_name)
+	{
+		// register new models
+		if (
+			! empty(self::$_settings[$addon_name]['model_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[$addon_name]['model_paths'],
+					'class_paths' => self::$_settings[$addon_name]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[$addon_name]['model_extension_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_data_migration_scripts($addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_data_migration_scripts($addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_config($addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[$addon_name]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[$addon_name]['config_class'],
-                array(
-                    'config_section' => self::$_settings[$addon_name]['config_section'],
-                    'config_name'    => self::$_settings[$addon_name]['config_name'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_config($addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[$addon_name]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[$addon_name]['config_class'],
+				array(
+					'config_section' => self::$_settings[$addon_name]['config_section'],
+					'config_name'    => self::$_settings[$addon_name]['config_name'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_admin_pages($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[$addon_name]['admin_path'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_admin_pages($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[$addon_name]['admin_path'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_modules($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_modules($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[$addon_name]['module_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_shortcodes($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
-            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array(
-                    'shortcode_paths' => isset(self::$_settings[$addon_name]['shortcode_paths'])
-                        ? self::$_settings[$addon_name]['shortcode_paths']
-                        : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[$addon_name]['shortcode_fqcns'])
-                        ? self::$_settings[$addon_name]['shortcode_fqcns']
-                        : array()
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_shortcodes($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
+			|| ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array(
+					'shortcode_paths' => isset(self::$_settings[$addon_name]['shortcode_paths'])
+						? self::$_settings[$addon_name]['shortcode_paths']
+						: array(),
+					'shortcode_fqcns' => isset(self::$_settings[$addon_name]['shortcode_fqcns'])
+						? self::$_settings[$addon_name]['shortcode_fqcns']
+						: array()
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_widgets($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_widgets($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_capabilities($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'       => self::$_settings[$addon_name]['capabilities'],
-                    'capability_maps'    => self::$_settings[$addon_name]['capability_maps'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_capabilities($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'       => self::$_settings[$addon_name]['capabilities'],
+					'capability_maps'    => self::$_settings[$addon_name]['capability_maps'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_message_types($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_message_types($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_custom_post_types($addon_name)
-    {
-        if (
-            ! empty(self::$_settings[$addon_name]['custom_post_types'])
-            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
-                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_custom_post_types($addon_name)
+	{
+		if (
+			! empty(self::$_settings[$addon_name]['custom_post_types'])
+			|| ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+					'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+					'default_terms' => self::$_settings[$addon_name]['default_terms'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_payment_methods($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_payment_methods($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $addon = EE_Registry::instance()->load_addon(
-            dirname(self::$_settings[$addon_name]['main_file_path']),
-            self::$_settings[$addon_name]['class_name']
-        );
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
-        $addon->set_version(self::$_settings[$addon_name]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
-        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
-        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
-        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
-        //unfortunately this can't be hooked in upon construction, because we don't have
-        //the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[$addon_name]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[$addon_name]['admin_callback'])
-            );
-        }
-        return $addon;
-    }
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$addon = EE_Registry::instance()->load_addon(
+			dirname(self::$_settings[$addon_name]['main_file_path']),
+			self::$_settings[$addon_name]['class_name']
+		);
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+		$addon->set_version(self::$_settings[$addon_name]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+		$addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+		$addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+		$addon->set_config_name(self::$_settings[$addon_name]['config_name']);
+		//unfortunately this can't be hooked in upon construction, because we don't have
+		//the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[$addon_name]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[$addon_name]['admin_callback'])
+			);
+		}
+		return $addon;
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return    void
-     */
-    public static function load_pue_update()
-    {
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
-        // cycle thru settings
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // initiate the class and start the plugin update engine!
-                new PluginUpdateEngineChecker(
-                // host file URL
-                    'https://eventespresso.com',
-                    // plugin slug(s)
-                    array(
-                        'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
-                    ),
-                    // options
-                    array(
-                        'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
-                        'lang_domain'       => 'event_espresso',
-                        'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                        'option_key'        => 'site_license_key',
-                        'options_page_slug' => 'event_espresso',
-                        'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                        // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                        'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return    void
+	 */
+	public static function load_pue_update()
+	{
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		// cycle thru settings
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// initiate the class and start the plugin update engine!
+				new PluginUpdateEngineChecker(
+				// host file URL
+					'https://eventespresso.com',
+					// plugin slug(s)
+					array(
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+					),
+					// options
+					array(
+						'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
+						'lang_domain'       => 'event_espresso',
+						'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+						'option_key'        => 'site_license_key',
+						'options_page_slug' => 'event_espresso',
+						'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+						// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+						'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @since 4.4.0
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @since    4.3.0
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws EE_Error
-     * @return void
-     */
-    public static function deregister($addon_name = null)
-    {
-        if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) {
-            do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-            $class_name = self::$_settings[$addon_name]['class_name'];
-            if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
-                // setup DMS
-                EE_Register_Data_Migration_Scripts::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['admin_path'])) {
-                // register admin page
-                EE_Register_Admin_Page::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['module_paths'])) {
-                // add to list of modules to be registered
-                EE_Register_Module::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
-                || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
-            ) {
-                // add to list of shortcodes to be registered
-                EE_Register_Shortcode::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['config_class'])) {
-                // if config_class present let's register config.
-                EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
-            }
-            if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
-                // add to list of widgets to be registered
-                EE_Register_Widget::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['model_paths'])
-                ||
-                ! empty(self::$_settings[$addon_name]['class_paths'])
-            ) {
-                // add to list of shortcodes to be registered
-                EE_Register_Model::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
-                ||
-                ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-            ) {
-                // add to list of shortcodes to be registered
-                EE_Register_Model_Extensions::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['message_types'])) {
-                foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::deregister($message_type);
-                }
-            }
-            //deregister capabilities for addon
-            if (
-                ! empty(self::$_settings[$addon_name]['capabilities'])
-                || ! empty(self::$_settings[$addon_name]['capability_maps'])
-            ) {
-                EE_Register_Capabilities::deregister($addon_name);
-            }
-            //deregister custom_post_types for addon
-            if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
-                EE_Register_CPT::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-                EE_Register_Payment_Method::deregister($addon_name);
-            }
-            remove_action(
-                'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
-                array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
-            );
-            remove_action(
-                'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
-            );
-            //remove `after_registration` call
-            remove_action(
-                'AHEE__EE_System__load_espresso_addons__complete',
-                array(EE_Registry::instance()->addons->{$class_name}, 'after_registration'),
-                999
-            );
-            unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function deregister($addon_name = null)
+	{
+		if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) {
+			do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+			$class_name = self::$_settings[$addon_name]['class_name'];
+			if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+				// setup DMS
+				EE_Register_Data_Migration_Scripts::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+				// register admin page
+				EE_Register_Admin_Page::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+				// add to list of modules to be registered
+				EE_Register_Module::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['shortcode_paths'])
+				|| ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
+			) {
+				// add to list of shortcodes to be registered
+				EE_Register_Shortcode::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['config_class'])) {
+				// if config_class present let's register config.
+				EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
+			}
+			if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+				// add to list of widgets to be registered
+				EE_Register_Widget::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['model_paths'])
+				||
+				! empty(self::$_settings[$addon_name]['class_paths'])
+			) {
+				// add to list of shortcodes to be registered
+				EE_Register_Model::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
+				||
+				! empty(self::$_settings[$addon_name]['class_extension_paths'])
+			) {
+				// add to list of shortcodes to be registered
+				EE_Register_Model_Extensions::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['message_types'])) {
+				foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::deregister($message_type);
+				}
+			}
+			//deregister capabilities for addon
+			if (
+				! empty(self::$_settings[$addon_name]['capabilities'])
+				|| ! empty(self::$_settings[$addon_name]['capability_maps'])
+			) {
+				EE_Register_Capabilities::deregister($addon_name);
+			}
+			//deregister custom_post_types for addon
+			if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+				EE_Register_CPT::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+				EE_Register_Payment_Method::deregister($addon_name);
+			}
+			remove_action(
+				'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
+				array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
+			);
+			remove_action(
+				'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+				array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
+			);
+			//remove `after_registration` call
+			remove_action(
+				'AHEE__EE_System__load_espresso_addons__complete',
+				array(EE_Registry::instance()->addons->{$class_name}, 'after_registration'),
+				999
+			);
+			unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
 
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
 
 
 }

core/EE_Addon.core.php

Indentation +760 added lines, -760 removed lines

@@ -14,732 +14,732 @@ 
 {
 
 
-    /**
-     * prefix to be added onto an addon's plugin slug to make a wp option name
-     * which will be used to store the plugin's activation history
-     */
-    const ee_addon_version_history_option_prefix = 'ee_version_history_';
-
-    /**
-     * @var $_version
-     * @type string
-     */
-    protected $_version = '';
-
-    /**
-     * @var $_min_core_version
-     * @type string
-     */
-    protected $_min_core_version = '';
-
-    /**
-     * derived from plugin 'main_file_path using plugin_basename()
-     *
-     * @type string $_plugin_basename
-     */
-    protected $_plugin_basename = '';
-
-    /**
-     * A non-internationalized name to identify this addon for use in URLs, etc
-     *
-     * @type string $_plugin_slug
-     */
-    protected $_plugin_slug = '';
-
-    /**
-     * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
-     *
-     * @type string _addon_name
-     */
-    protected $_addon_name = '';
-
-    /**
-     * one of the EE_System::req_type_* constants
-     *
-     * @type int $_req_type
-     */
-    protected $_req_type;
-
-    /**
-     * page slug to be used when generating the "Settings" link on the WP plugin page
-     *
-     * @type string $_plugin_action_slug
-     */
-    protected $_plugin_action_slug = '';
-
-    /**
-     * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-     * that can be used for adding upgrading/marketing info
-     *
-     * @type array $_plugins_page_row
-     */
-    protected $_plugins_page_row = array();
-
-
-
-    /**
-     *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
-     *
-     * @type string
-     */
-    protected $_main_plugin_file;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init'));
-    }
-
-
-    /**
-     * @param mixed $version
-     */
-    public function set_version($version = null)
-    {
-        $this->_version = $version;
-    }
-
-
-    /**
-     * get__version
-     *
-     * @return string
-     */
-    public function version()
-    {
-        return $this->_version;
-    }
-
-
-    /**
-     * @param mixed $min_core_version
-     */
-    public function set_min_core_version($min_core_version = null)
-    {
-        $this->_min_core_version = $min_core_version;
-    }
-
-
-    /**
-     * get__min_core_version
-     *
-     * @return string
-     */
-    public function min_core_version()
-    {
-        return $this->_min_core_version;
-    }
-
-
-    /**
-     * Sets addon_name
-     *
-     * @param string $addon_name
-     * @return boolean
-     */
-    public function set_name($addon_name)
-    {
-        return $this->_addon_name = $addon_name;
-    }
-
-
-    /**
-     * Gets addon_name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_addon_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_basename()
-    {
-
-        return $this->_plugin_basename;
-    }
-
-
-    /**
-     * @param string $plugin_basename
-     */
-    public function set_plugin_basename($plugin_basename)
-    {
-
-        $this->_plugin_basename = $plugin_basename;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_slug()
-    {
-
-        return $this->_plugin_slug;
-    }
-
-
-    /**
-     * @param string $plugin_slug
-     */
-    public function set_plugin_slug($plugin_slug)
-    {
-
-        $this->_plugin_slug = $plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_action_slug()
-    {
-
-        return $this->_plugin_action_slug;
-    }
-
-
-    /**
-     * @param string $plugin_action_slug
-     */
-    public function set_plugin_action_slug($plugin_action_slug)
-    {
-
-        $this->_plugin_action_slug = $plugin_action_slug;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_plugins_page_row()
-    {
-
-        return $this->_plugins_page_row;
-    }
-
-
-    /**
-     * @param array $plugins_page_row
-     */
-    public function set_plugins_page_row($plugins_page_row = array())
-    {
-        // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (! is_array($plugins_page_row)
-            && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
-        ) {
-            $plugins_page_row = array();
-        }
-        $this->_plugins_page_row = (array) $plugins_page_row;
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been activated for the first time.
-     * If the site isn't in maintenance mode, should setup the addon's database
-     *
-     * @return void
-     */
-    public function new_install()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__new_install");
-        do_action('AHEE__EE_Addon__new_install', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been reactivated. When this happens,
-     * it's good to just check that your data is still intact
-     *
-     * @return void
-     */
-    public function reactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__reactivation");
-        do_action('AHEE__EE_Addon__reactivation', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * Called when the registered deactivation hook for this addon fires.
-     * @throws EE_Error
-     */
-    public function deactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__deactivation");
-        do_action('AHEE__EE_Addon__deactivation', $this);
-        //check if the site no longer needs to be in maintenance mode
-        EE_Register_Addon::deregister($this->name());
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations.
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws \EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($verify_schema = true)
-    {
-        if ($verify_schema === '') {
-            //wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
-            //(ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
-            //calls them with an argument of an empty string (ie ""), which evaluates to false
-            //so we need to treat the empty string as if nothing had been passed, and should instead use the default
-            $verify_schema = true;
-        }
-        if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initialize_db();
-            }
-            $this->initialize_default_data();
-            //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-                array(
-                    'slug'    => $this->name(),
-                    'version' => $this->version(),
-                )
-            );
-            /* make sure core's data is a-ok
+	/**
+	 * prefix to be added onto an addon's plugin slug to make a wp option name
+	 * which will be used to store the plugin's activation history
+	 */
+	const ee_addon_version_history_option_prefix = 'ee_version_history_';
+
+	/**
+	 * @var $_version
+	 * @type string
+	 */
+	protected $_version = '';
+
+	/**
+	 * @var $_min_core_version
+	 * @type string
+	 */
+	protected $_min_core_version = '';
+
+	/**
+	 * derived from plugin 'main_file_path using plugin_basename()
+	 *
+	 * @type string $_plugin_basename
+	 */
+	protected $_plugin_basename = '';
+
+	/**
+	 * A non-internationalized name to identify this addon for use in URLs, etc
+	 *
+	 * @type string $_plugin_slug
+	 */
+	protected $_plugin_slug = '';
+
+	/**
+	 * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
+	 *
+	 * @type string _addon_name
+	 */
+	protected $_addon_name = '';
+
+	/**
+	 * one of the EE_System::req_type_* constants
+	 *
+	 * @type int $_req_type
+	 */
+	protected $_req_type;
+
+	/**
+	 * page slug to be used when generating the "Settings" link on the WP plugin page
+	 *
+	 * @type string $_plugin_action_slug
+	 */
+	protected $_plugin_action_slug = '';
+
+	/**
+	 * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+	 * that can be used for adding upgrading/marketing info
+	 *
+	 * @type array $_plugins_page_row
+	 */
+	protected $_plugins_page_row = array();
+
+
+
+	/**
+	 *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
+	 *
+	 * @type string
+	 */
+	protected $_main_plugin_file;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init'));
+	}
+
+
+	/**
+	 * @param mixed $version
+	 */
+	public function set_version($version = null)
+	{
+		$this->_version = $version;
+	}
+
+
+	/**
+	 * get__version
+	 *
+	 * @return string
+	 */
+	public function version()
+	{
+		return $this->_version;
+	}
+
+
+	/**
+	 * @param mixed $min_core_version
+	 */
+	public function set_min_core_version($min_core_version = null)
+	{
+		$this->_min_core_version = $min_core_version;
+	}
+
+
+	/**
+	 * get__min_core_version
+	 *
+	 * @return string
+	 */
+	public function min_core_version()
+	{
+		return $this->_min_core_version;
+	}
+
+
+	/**
+	 * Sets addon_name
+	 *
+	 * @param string $addon_name
+	 * @return boolean
+	 */
+	public function set_name($addon_name)
+	{
+		return $this->_addon_name = $addon_name;
+	}
+
+
+	/**
+	 * Gets addon_name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_addon_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_basename()
+	{
+
+		return $this->_plugin_basename;
+	}
+
+
+	/**
+	 * @param string $plugin_basename
+	 */
+	public function set_plugin_basename($plugin_basename)
+	{
+
+		$this->_plugin_basename = $plugin_basename;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_slug()
+	{
+
+		return $this->_plugin_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_slug
+	 */
+	public function set_plugin_slug($plugin_slug)
+	{
+
+		$this->_plugin_slug = $plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_action_slug()
+	{
+
+		return $this->_plugin_action_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_action_slug
+	 */
+	public function set_plugin_action_slug($plugin_action_slug)
+	{
+
+		$this->_plugin_action_slug = $plugin_action_slug;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_plugins_page_row()
+	{
+
+		return $this->_plugins_page_row;
+	}
+
+
+	/**
+	 * @param array $plugins_page_row
+	 */
+	public function set_plugins_page_row($plugins_page_row = array())
+	{
+		// sigh.... check for example content that I stupidly merged to master and remove it if found
+		if (! is_array($plugins_page_row)
+			&& strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
+		) {
+			$plugins_page_row = array();
+		}
+		$this->_plugins_page_row = (array) $plugins_page_row;
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been activated for the first time.
+	 * If the site isn't in maintenance mode, should setup the addon's database
+	 *
+	 * @return void
+	 */
+	public function new_install()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__new_install");
+		do_action('AHEE__EE_Addon__new_install', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been reactivated. When this happens,
+	 * it's good to just check that your data is still intact
+	 *
+	 * @return void
+	 */
+	public function reactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__reactivation");
+		do_action('AHEE__EE_Addon__reactivation', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * Called when the registered deactivation hook for this addon fires.
+	 * @throws EE_Error
+	 */
+	public function deactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__deactivation");
+		do_action('AHEE__EE_Addon__deactivation', $this);
+		//check if the site no longer needs to be in maintenance mode
+		EE_Register_Addon::deregister($this->name());
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations.
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($verify_schema = true)
+	{
+		if ($verify_schema === '') {
+			//wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
+			//(ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
+			//calls them with an argument of an empty string (ie ""), which evaluates to false
+			//so we need to treat the empty string as if nothing had been passed, and should instead use the default
+			$verify_schema = true;
+		}
+		if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initialize_db();
+			}
+			$this->initialize_default_data();
+			//@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+				array(
+					'slug'    => $this->name(),
+					'version' => $this->version(),
+				)
+			);
+			/* make sure core's data is a-ok
              * (at the time of writing, we especially want to verify all the caps are present
              * because payment method type capabilities are added dynamically, and it's
              * possible this addon added a payment method. But it's also possible
              * other data needs to be verified)
              */
-            EEH_Activation::initialize_db_content();
-            update_option('ee_flush_rewrite_rules', true);
-            //in case there are lots of addons being activated at once, let's force garbage collection
-            //to help avoid memory limit errors
-            //EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            //ask the data migration manager to init this addon's data
-            //when migrations are finished because we can't do it now
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     */
-    public function initialize_db()
-    {
-        //find the migration script that sets the database to be compatible with the code
-        $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        //if not DMS was found that should be ok. This addon just doesn't require any database changes
-        EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-            array(
-                'slug'    => $this->name(),
-                'version' => $this->version(),
-            )
-        );
-    }
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initialize_default_data()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        //override to insert default data. It is safe to use the models here
-        //because the site should not be in maintenance mode
-    }
-
-
-    /**
-     * EE Core detected that this addon has been upgraded. We should check if there
-     * are any new migration scripts, and if so put the site into maintenance mode until
-     * they're ran
-     *
-     * @return void
-     */
-    public function upgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__upgrade");
-        do_action('AHEE__EE_Addon__upgrade', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        //also it's possible there is new default data that needs to be added
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
-     */
-    public function downgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__downgrade");
-        do_action('AHEE__EE_Addon__downgrade', $this);
-        //it's possible there's old default data that needs to be double-checked
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * set_db_update_option_name
-     * Until we do something better, we'll just check for migration scripts upon
-     * plugin activation only. In the future, we'll want to do it on plugin updates too
-     *
-     * @return bool
-     */
-    public function set_db_update_option_name()
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        //let's just handle this on the next request, ok? right now we're just not really ready
-        return $this->set_activation_indicator_option();
-    }
-
-
-    /**
-     * Returns the name of the activation indicator option
-     * (an option which is set temporarily to indicate that this addon was just activated)
-     *
-     * @deprecated since version 4.3.0.alpha.016
-     * @return string
-     */
-    public function get_db_update_option_name()
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        return $this->get_activation_indicator_option_name();
-    }
-
-
-    /**
-     * When the addon is activated, this should be called to set a wordpress option that
-     * indicates it was activated. This is especially useful for detecting reactivations.
-     *
-     * @return bool
-     */
-    public function set_activation_indicator_option()
-    {
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return update_option($this->get_activation_indicator_option_name(), true);
-    }
-
-
-    /**
-     * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
-     *
-     * @return string
-     */
-    public function get_activation_indicator_option_name()
-    {
-        return 'ee_activation_' . $this->name();
-    }
-
-
-    /**
-     * Used by EE_System to set the request type of this addon. Should not be used by addon developers
-     *
-     * @param int $req_type
-     */
-    public function set_req_type($req_type)
-    {
-        $this->_req_type = $req_type;
-    }
-
-
-    /**
-     * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
-     * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
-     * EE_System when it is checking for new install or upgrades of addons
-     */
-    public function detect_req_type()
-    {
-        if (! $this->_req_type) {
-            $this->detect_activation_or_upgrade();
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
-     * Should only be called once per request
-     *
-     * @return void
-     */
-    public function detect_activation_or_upgrade()
-    {
-        $activation_history_for_addon = $this->get_activation_history();
+			EEH_Activation::initialize_db_content();
+			update_option('ee_flush_rewrite_rules', true);
+			//in case there are lots of addons being activated at once, let's force garbage collection
+			//to help avoid memory limit errors
+			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			//ask the data migration manager to init this addon's data
+			//when migrations are finished because we can't do it now
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 */
+	public function initialize_db()
+	{
+		//find the migration script that sets the database to be compatible with the code
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		//if not DMS was found that should be ok. This addon just doesn't require any database changes
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+			array(
+				'slug'    => $this->name(),
+				'version' => $this->version(),
+			)
+		);
+	}
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initialize_default_data()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		//override to insert default data. It is safe to use the models here
+		//because the site should not be in maintenance mode
+	}
+
+
+	/**
+	 * EE Core detected that this addon has been upgraded. We should check if there
+	 * are any new migration scripts, and if so put the site into maintenance mode until
+	 * they're ran
+	 *
+	 * @return void
+	 */
+	public function upgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__upgrade");
+		do_action('AHEE__EE_Addon__upgrade', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		//also it's possible there is new default data that needs to be added
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
+	 */
+	public function downgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__downgrade");
+		do_action('AHEE__EE_Addon__downgrade', $this);
+		//it's possible there's old default data that needs to be double-checked
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * set_db_update_option_name
+	 * Until we do something better, we'll just check for migration scripts upon
+	 * plugin activation only. In the future, we'll want to do it on plugin updates too
+	 *
+	 * @return bool
+	 */
+	public function set_db_update_option_name()
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		//let's just handle this on the next request, ok? right now we're just not really ready
+		return $this->set_activation_indicator_option();
+	}
+
+
+	/**
+	 * Returns the name of the activation indicator option
+	 * (an option which is set temporarily to indicate that this addon was just activated)
+	 *
+	 * @deprecated since version 4.3.0.alpha.016
+	 * @return string
+	 */
+	public function get_db_update_option_name()
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		return $this->get_activation_indicator_option_name();
+	}
+
+
+	/**
+	 * When the addon is activated, this should be called to set a wordpress option that
+	 * indicates it was activated. This is especially useful for detecting reactivations.
+	 *
+	 * @return bool
+	 */
+	public function set_activation_indicator_option()
+	{
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return update_option($this->get_activation_indicator_option_name(), true);
+	}
+
+
+	/**
+	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
+	 *
+	 * @return string
+	 */
+	public function get_activation_indicator_option_name()
+	{
+		return 'ee_activation_' . $this->name();
+	}
+
+
+	/**
+	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
+	 *
+	 * @param int $req_type
+	 */
+	public function set_req_type($req_type)
+	{
+		$this->_req_type = $req_type;
+	}
+
+
+	/**
+	 * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
+	 * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
+	 * EE_System when it is checking for new install or upgrades of addons
+	 */
+	public function detect_req_type()
+	{
+		if (! $this->_req_type) {
+			$this->detect_activation_or_upgrade();
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
+	 * Should only be called once per request
+	 *
+	 * @return void
+	 */
+	public function detect_activation_or_upgrade()
+	{
+		$activation_history_for_addon = $this->get_activation_history();
 //		d($activation_history_for_addon);
-        $request_type = EE_System::detect_req_type_given_activation_history(
-            $activation_history_for_addon,
-            $this->get_activation_indicator_option_name(),
-            $this->version()
-        );
-        $this->set_req_type($request_type);
-        $classname = get_class($this);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
-                $this->new_install();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
-                $this->reactivation();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
-                $this->upgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
-                $this->downgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_normal:
-            default:
+		$request_type = EE_System::detect_req_type_given_activation_history(
+			$activation_history_for_addon,
+			$this->get_activation_indicator_option_name(),
+			$this->version()
+		);
+		$this->set_req_type($request_type);
+		$classname = get_class($this);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
+				$this->new_install();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
+				$this->reactivation();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
+				$this->upgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
+				$this->downgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_normal:
+			default:
 //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-
-        do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
-    }
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add
-     * @return boolean success
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->get_activation_history();
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = $this->version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // resave
+				break;
+		}
+
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
+	}
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add
+	 * @return boolean success
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->get_activation_history();
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = $this->version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// resave
 //		echo "updating list of installed versions:".$this->get_activation_history_option_name();d($version_history);
-        return update_option($this->get_activation_history_option_name(), $version_history);
-    }
-
-    /**
-     * Gets the name of the wp option that stores the activation history
-     * of this addon
-     *
-     * @return string
-     */
-    public function get_activation_history_option_name()
-    {
-        return self::ee_addon_version_history_option_prefix . $this->name();
-    }
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array
-     */
-    public function get_activation_history()
-    {
-        return get_option($this->get_activation_history_option_name(), null);
-    }
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'addons';
-    }
-
-    /**
-     * Sets the filepath to the main plugin file
-     *
-     * @param string $filepath
-     */
-    public function set_main_plugin_file($filepath)
-    {
-        $this->_main_plugin_file = $filepath;
-    }
-
-    /**
-     * gets the filepath to teh main file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file()
-    {
-        return $this->_main_plugin_file;
-    }
-
-    /**
-     * Gets the filename (no path) of the main file (the main file loaded
-     * by WP)
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_basename()
-    {
-        return plugin_basename($this->get_main_plugin_file());
-    }
-
-    /**
-     * Gets the folder name which contains the main plugin file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_dirname()
-    {
-        return dirname($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * sets hooks used in the admin
-     *
-     * @return void
-     */
-    public function admin_init()
-    {
-        // is admin and not in M-Mode ?
-        if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
-        }
-    }
-
-
-    /**
-     * plugin_actions
-     * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
-     *
-     * @param $links
-     * @param $file
-     * @return array
-     */
-    public function plugin_action_links($links, $file)
-    {
-        if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
-            // before other links
-            array_unshift(
-                $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
-                . esc_html__('Settings', 'event_espresso')
-                . '</a>'
-            );
-        }
-        return $links;
-    }
-
-
-    /**
-     * after_plugin_row
-     * Add additional content to the plugins page plugin row
-     * Inserts another row
-     *
-     * @param $plugin_file
-     * @param $plugin_data
-     * @param $status
-     * @return void
-     */
-    public function after_plugin_row($plugin_file, $plugin_data, $status)
-    {
-        $after_plugin_row = '';
-        $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
-            $class            = $status ? 'active' : 'inactive';
-            $link_text        = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
-            $link_url         = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
-            $description      = isset($plugins_page_row['description'])
-                ? $plugins_page_row['description']
-                : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
-                $after_plugin_row .= '<th class="check-column" scope="row"></th>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
-                $after_plugin_row .= '<style>
+		return update_option($this->get_activation_history_option_name(), $version_history);
+	}
+
+	/**
+	 * Gets the name of the wp option that stores the activation history
+	 * of this addon
+	 *
+	 * @return string
+	 */
+	public function get_activation_history_option_name()
+	{
+		return self::ee_addon_version_history_option_prefix . $this->name();
+	}
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array
+	 */
+	public function get_activation_history()
+	{
+		return get_option($this->get_activation_history_option_name(), null);
+	}
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
+	}
+
+	/**
+	 * Sets the filepath to the main plugin file
+	 *
+	 * @param string $filepath
+	 */
+	public function set_main_plugin_file($filepath)
+	{
+		$this->_main_plugin_file = $filepath;
+	}
+
+	/**
+	 * gets the filepath to teh main file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file()
+	{
+		return $this->_main_plugin_file;
+	}
+
+	/**
+	 * Gets the filename (no path) of the main file (the main file loaded
+	 * by WP)
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_basename()
+	{
+		return plugin_basename($this->get_main_plugin_file());
+	}
+
+	/**
+	 * Gets the folder name which contains the main plugin file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_dirname()
+	{
+		return dirname($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * sets hooks used in the admin
+	 *
+	 * @return void
+	 */
+	public function admin_init()
+	{
+		// is admin and not in M-Mode ?
+		if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
+			add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
+		}
+	}
+
+
+	/**
+	 * plugin_actions
+	 * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
+	 *
+	 * @param $links
+	 * @param $file
+	 * @return array
+	 */
+	public function plugin_action_links($links, $file)
+	{
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
+			// before other links
+			array_unshift(
+				$links,
+				'<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+				. esc_html__('Settings', 'event_espresso')
+				. '</a>'
+			);
+		}
+		return $links;
+	}
+
+
+	/**
+	 * after_plugin_row
+	 * Add additional content to the plugins page plugin row
+	 * Inserts another row
+	 *
+	 * @param $plugin_file
+	 * @param $plugin_data
+	 * @param $status
+	 * @return void
+	 */
+	public function after_plugin_row($plugin_file, $plugin_data, $status)
+	{
+		$after_plugin_row = '';
+		$plugins_page_row = $this->get_plugins_page_row();
+		if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+			$class            = $status ? 'active' : 'inactive';
+			$link_text        = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url         = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description      = isset($plugins_page_row['description'])
+				? $plugins_page_row['description']
+				: '';
+			if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
+				$after_plugin_row .= '<style>
 .ee-button,
 .ee-button:active,
 .ee-button:visited {
@@ -776,49 +776,49 @@ 
 }
 .ee-button:active { top:0; }
 </style>';
-                $after_plugin_row .= '
+				$after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
 	<a class="ee-button" href="' . $link_url . '">'
-                . $link_text
-                . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
-                . '</a>
+				. $link_text
+				. ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
+				. '</a>
 </p>';
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
-                $after_plugin_row .= $description;
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '</tr>';
-            } else {
-                $after_plugin_row .= $description;
-            }
-        }
-
-        echo $after_plugin_row;
-    }
-
-
-    /**
-     * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
-     * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
-     * for back compat reasons.
-     *
-     * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
-     *
-     * It is recommended, if client code is `de-registering` an add-on, then do it on the
-     * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
-     * callback does not get run/set in that request.
-     *
-     * Also, keep in mind that if a registered add-on happens to be deactivated via
-     * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
-     * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
-     * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
-     * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
-     * to call `parent::deactivation`.
-     *
-     * @since 4.9.26
-     */
-    public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
-    }
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
+				$after_plugin_row .= $description;
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '</tr>';
+			} else {
+				$after_plugin_row .= $description;
+			}
+		}
+
+		echo $after_plugin_row;
+	}
+
+
+	/**
+	 * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
+	 * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
+	 * for back compat reasons.
+	 *
+	 * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
+	 *
+	 * It is recommended, if client code is `de-registering` an add-on, then do it on the
+	 * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
+	 * callback does not get run/set in that request.
+	 *
+	 * Also, keep in mind that if a registered add-on happens to be deactivated via
+	 * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
+	 * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
+	 * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
+	 * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
+	 * to call `parent::deactivation`.
+	 *
+	 * @since 4.9.26
+	 */
+	public function after_registration()
+	{
+		// cricket chirp... cricket chirp...
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -233,7 +233,7 @@ 
     public function set_plugins_page_row($plugins_page_row = array())
     {
         // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (! is_array($plugins_page_row)
+        if ( ! is_array($plugins_page_row)
             && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
         ) {
             $plugins_page_row = array();
@@ -502,7 +502,7 @@ 
      */
     public function get_activation_indicator_option_name()
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -524,7 +524,7 @@ 
      */
     public function detect_req_type()
     {
-        if (! $this->_req_type) {
+        if ( ! $this->_req_type) {
             $this->detect_activation_or_upgrade();
         }
         return $this->_req_type;
@@ -591,7 +591,7 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->get_activation_history();
         }
         if ($current_version_to_add === null) {
@@ -611,7 +611,7 @@ 
      */
     public function get_activation_history_option_name()
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -686,7 +686,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
             add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3);
         }
     }
 
@@ -705,7 +705,7 @@ 
             // before other links
             array_unshift(
                 $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+                '<a href="admin.php?page='.$this->plugin_action_slug().'">'
                 . esc_html__('Settings', 'event_espresso')
                 . '</a>'
             );
@@ -728,15 +728,15 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class            = $status ? 'active' : 'inactive';
             $link_text        = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
             $link_url         = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
             $description      = isset($plugins_page_row['description'])
                 ? $plugins_page_row['description']
                 : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<style>
@@ -778,7 +778,7 @@ 
 </style>';
                 $after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
-	<a class="ee-button" href="' . $link_url . '">'
+	<a class="ee-button" href="' . $link_url.'">'
                 . $link_text
                 . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                 . '</a>