eventespresso / event-espresso-core

core/libraries/shortcodes/EE_Venue_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -164,7 +164,7 @@ 
 
 
         //If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
+        if ( ! $this->_event instanceof EE_Event) {
             return '';
         }
 
@@ -190,11 +190,11 @@ 
                 break;
 
             case 'image':
-                return '<img src="' . $venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
+                return '<img src="'.$venue->feature_image_url(array(200, 200,))
+                       . '" alt="'.sprintf(
                            esc_attr__('%s Feature Image', 'event_espresso'),
                            $venue->get('VNU_name')
-                       ) . '" />';
+                       ).'" />';
                 break;
 
             case 'phone':

Indentation +253 added lines, -253 removed lines

@@ -16,257 +16,257 @@
 {
 
 
-    /**
-     * Will hold the EE_Event if available
-     *
-     * @var EE_Event
-     */
-    protected $_event;
-
-
-    /**
-     * 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_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'),
-            '[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
-     */
-    protected function _parser($shortcode)
-    {
-
-        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;
-
-        }
-    }
-
-
-    /**
-     * This retrieves the specified venue information
-     *
-     * @param string $field  What Venue field to retrieve
-     * @return string What was retrieved!
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _venue($field)
-    {
-        //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 (empty($this->_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 = empty($this->_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.
-            $event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
-            $this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
-        }
-
-
-        //If there is no event objecdt by now then get out.
-        if (! $this->_event instanceof EE_Event) {
-            return '';
-        }
-
-        /** @var EE_Venue $venue */
-        $venue = $this->_event->get_first_related('Venue');
-
-        if (empty($venue)) {
-            return '';
-        } //no venue so get out.
-
-        switch ($field) {
-            case 'title':
-                return $venue->get('VNU_name');
-                break;
-
-            case 'description':
-                return $venue->get('VNU_desc');
-                break;
-
-            case 'url':
-                $url = $venue->get('VNU_url');
-                return empty($url) ? $venue->get_permalink() : $url;
-                break;
-
-            case 'image':
-                return '<img src="' . $venue->feature_image_url(array(200, 200,))
-                       . '" alt="' . sprintf(
-                           esc_attr__('%s Feature Image', 'event_espresso'),
-                           $venue->get('VNU_name')
-                       ) . '" />';
-                break;
-
-            case 'phone':
-                return $venue->get('VNU_phone');
-                break;
-
-            case 'address':
-                return $venue->get('VNU_address');
-                break;
-
-            case 'address2':
-                return $venue->get('VNU_address2');
-                break;
-
-            case 'city':
-                return $venue->get('VNU_city');
-                break;
-
-            case 'state':
-                $state = $venue->state_obj();
-                return is_object($state) ? $state->get('STA_name') : '';
-                break;
-
-            case 'country':
-                $country = $venue->country_obj();
-                return is_object($country) ? $country->get('CNT_name') : '';
-                break;
-
-            case 'zip':
-                return $venue->get('VNU_zip');
-                break;
-
-            case 'formatted_address':
-                return EEH_Address::format($venue);
-                break;
-
-            case 'gmap_link':
-            case 'gmap_url':
-            case 'gmap_link_img':
-                $atts = $this->get_map_attributes($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;
+
+
+	/**
+	 * 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_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'),
+			'[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
+	 */
+	protected function _parser($shortcode)
+	{
+
+		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;
+
+		}
+	}
+
+
+	/**
+	 * This retrieves the specified venue information
+	 *
+	 * @param string $field  What Venue field to retrieve
+	 * @return string What was retrieved!
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _venue($field)
+	{
+		//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 (empty($this->_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 = empty($this->_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.
+			$event        = $aee instanceof EE_Messages_Addressee ? reset($aee->events) : array();
+			$this->_event = empty($this->_event) && ! empty($events) ? $event : $this->_event;
+		}
+
+
+		//If there is no event objecdt by now then get out.
+		if (! $this->_event instanceof EE_Event) {
+			return '';
+		}
+
+		/** @var EE_Venue $venue */
+		$venue = $this->_event->get_first_related('Venue');
+
+		if (empty($venue)) {
+			return '';
+		} //no venue so get out.
+
+		switch ($field) {
+			case 'title':
+				return $venue->get('VNU_name');
+				break;
+
+			case 'description':
+				return $venue->get('VNU_desc');
+				break;
+
+			case 'url':
+				$url = $venue->get('VNU_url');
+				return empty($url) ? $venue->get_permalink() : $url;
+				break;
+
+			case 'image':
+				return '<img src="' . $venue->feature_image_url(array(200, 200,))
+					   . '" alt="' . sprintf(
+						   esc_attr__('%s Feature Image', 'event_espresso'),
+						   $venue->get('VNU_name')
+					   ) . '" />';
+				break;
+
+			case 'phone':
+				return $venue->get('VNU_phone');
+				break;
+
+			case 'address':
+				return $venue->get('VNU_address');
+				break;
+
+			case 'address2':
+				return $venue->get('VNU_address2');
+				break;
+
+			case 'city':
+				return $venue->get('VNU_city');
+				break;
+
+			case 'state':
+				$state = $venue->state_obj();
+				return is_object($state) ? $state->get('STA_name') : '';
+				break;
+
+			case 'country':
+				$country = $venue->country_obj();
+				return is_object($country) ? $country->get('CNT_name') : '';
+				break;
+
+			case 'zip':
+				return $venue->get('VNU_zip');
+				break;
+
+			case 'formatted_address':
+				return EEH_Address::format($venue);
+				break;
+
+			case 'gmap_link':
+			case 'gmap_url':
+			case 'gmap_link_img':
+				$atts = $this->get_map_attributes($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/helpers/EEH_Maps.helper.php

Indentation +170 added lines, -170 removed lines

@@ -14,176 +14,176 @@
 class EEH_Maps
 {
 
-    // array of map settings
-    public static $gmap_vars = array();
-
-
-    /**
-     * google_map - creates a Google Map Link
-     *
-     * @param  array $ee_gmaps_opts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map($ee_gmaps_opts)
-    {
-
-        $ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
-        $ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
-        $ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
-        $ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
-        $ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
-            ? $ee_gmaps_opts['ee_map_nav_size']
-            : 'default';
-        $ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
-            ? $ee_gmaps_opts['ee_map_type_control']
-            : 'default';
-        $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
-
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
-            switch ($ee_gmaps_opts['ee_map_align']) {
-                case "left":
-                    $map_align = 'ee-gmap-align-left left';
-                    break;
-                case "right":
-                    $map_align = 'ee-gmap-align-right right';
-                    break;
-                case "center":
-                    $map_align = 'ee-gmap-align-center center';
-                    break;
-                case "none":
-                default:
-                    $map_align = 'ee-gmap-align-none';
-            }
-        } else {
-            $map_align = 'ee-gmap-align-none';
-        }
-
-
-        // Determine whether user has set a hardoded url to use and
-        // if so display a Google static iframe map else run V3 api
-        if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
-                . ' frameborder="0" scrolling="no">';
-            $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
-            $html .= '</div>';
-            return $html;
-
-        } else {
-            EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
-                'map_ID'              => $ee_gmaps_opts['map_ID'],
-                'ee_map_zoom'         => $ee_map_zoom,
-                'ee_map_nav_display'  => $ee_map_nav_display,
-                'ee_map_nav_size'     => $ee_map_nav_size,
-                'ee_map_type_control' => $ee_map_type_control,
-                'location'            => $ee_gmaps_opts['location'],
-            );
-
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
-                    . '</div>';
-
-            wp_enqueue_script('gmap_api');
-            wp_enqueue_script('ee_gmap');
-            add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
-
-            return $html;
-        } // end auto map or static url map check
-    }
-
-
-    /**
-     * enqueue_script
-     *
-     * @return void
-     */
-    public static function footer_enqueue_script()
-    {
-        wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
-    }
-
-
-    /**
-     * registers scripts for maps
-     */
-    public static function espresso_google_map_js()
-    {
-        $api_url = sprintf(
-            "https://maps.googleapis.com/maps/api/js?key=%s",
-            apply_filters(
-                'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                EE_Registry::instance()->CFG->map_settings->google_map_api_key
-            )
-        );
-        wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
-    }
-
-    /**
-     * creates a Google Map Link
-     *
-     * @param  array $atts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map_link($atts)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        extract($atts);
-        /** @var string $address */
-        /** @var string $city */
-        /** @var string $state */
-        /** @var string $zip */
-        /** @var string $country */
-        $address         = "{$address}";
-        $city            = "{$city}";
-        $state           = "{$state}";
-        $zip             = "{$zip}";
-        $country         = "{$country}";
-        $text            = isset($text) ? "{$text}" : "";
-        $type            = isset($type) ? "{$type}" : "";
-        $map_w           = isset($map_w) ? "{$map_w}" : 400;
-        $map_h           = isset($map_h) ? "{$map_h}" : 400;
-        $id              = isset($id) ? $id : 'not_set';
-        $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
-
-        $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
-
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
-
-        switch ($type) {
-            case 'text':
-            default:
-                $text = $text == '' ? __('Map and Directions', 'event_espresso') : $text;
-                break;
-
-            case 'url_only':
-            case 'url':
-                $text = $google_map;
-                break;
-
-            case 'map':
-                $scheme = is_ssl() ? 'https://' : 'http://';
-
-                $api_key = apply_filters(
-                    'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
-                    EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                );
-
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
-        }
-
-        return $type === 'url_only'
-            ? $text
-            : '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
-    }
+	// array of map settings
+	public static $gmap_vars = array();
+
+
+	/**
+	 * google_map - creates a Google Map Link
+	 *
+	 * @param  array $ee_gmaps_opts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map($ee_gmaps_opts)
+	{
+
+		$ee_map_width        = ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
+		$ee_map_height       = ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
+		$ee_map_zoom         = ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
+		$ee_map_nav_display  = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+		$ee_map_nav_size     = ! empty($ee_gmaps_opts['ee_map_nav_size'])
+			? $ee_gmaps_opts['ee_map_nav_size']
+			: 'default';
+		$ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
+			? $ee_gmaps_opts['ee_map_type_control']
+			: 'default';
+		$static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
+
+		if (! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
+				case "left":
+					$map_align = 'ee-gmap-align-left left';
+					break;
+				case "right":
+					$map_align = 'ee-gmap-align-right right';
+					break;
+				case "center":
+					$map_align = 'ee-gmap-align-center center';
+					break;
+				case "none":
+				default:
+					$map_align = 'ee-gmap-align-none';
+			}
+		} else {
+			$map_align = 'ee-gmap-align-none';
+		}
+
+
+		// Determine whether user has set a hardoded url to use and
+		// if so display a Google static iframe map else run V3 api
+		if ($static_url) {
+			$html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
+			$html .= '<iframe src="' . $static_url . '&output=embed"'
+				. ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+				. ' frameborder="0" scrolling="no">';
+			$html .= '</iframe>';
+			$html .= '<a href="' . $static_url . '">View Large map</a>';
+			$html .= '</div>';
+			return $html;
+
+		} else {
+			EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
+				'map_ID'              => $ee_gmaps_opts['map_ID'],
+				'ee_map_zoom'         => $ee_map_zoom,
+				'ee_map_nav_display'  => $ee_map_nav_display,
+				'ee_map_nav_size'     => $ee_map_nav_size,
+				'ee_map_type_control' => $ee_map_type_control,
+				'location'            => $ee_gmaps_opts['location'],
+			);
+
+			$style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+			$html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
+					. '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
+					. ' style="' . $style . '"></div>'
+					. '</div>';
+
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
+
+			return $html;
+		} // end auto map or static url map check
+	}
+
+
+	/**
+	 * enqueue_script
+	 *
+	 * @return void
+	 */
+	public static function footer_enqueue_script()
+	{
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
+	}
+
+
+	/**
+	 * registers scripts for maps
+	 */
+	public static function espresso_google_map_js()
+	{
+		$api_url = sprintf(
+			"https://maps.googleapis.com/maps/api/js?key=%s",
+			apply_filters(
+				'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+				EE_Registry::instance()->CFG->map_settings->google_map_api_key
+			)
+		);
+		wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
+		wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+	}
+
+	/**
+	 * creates a Google Map Link
+	 *
+	 * @param  array $atts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map_link($atts)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		extract($atts);
+		/** @var string $address */
+		/** @var string $city */
+		/** @var string $state */
+		/** @var string $zip */
+		/** @var string $country */
+		$address         = "{$address}";
+		$city            = "{$city}";
+		$state           = "{$state}";
+		$zip             = "{$zip}";
+		$country         = "{$country}";
+		$text            = isset($text) ? "{$text}" : "";
+		$type            = isset($type) ? "{$type}" : "";
+		$map_w           = isset($map_w) ? "{$map_w}" : 400;
+		$map_h           = isset($map_h) ? "{$map_h}" : 400;
+		$id              = isset($id) ? $id : 'not_set';
+		$map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
+
+		$address_string = ($address != '' ? $address : '')
+						  . ($city != '' ? ',' . $city : '')
+						  . ($state != '' ? ',' . $state : '')
+						  . ($zip != '' ? ',' . $zip : '')
+						  . ($country != '' ? ',' . $country : '');
+
+		$google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+
+		switch ($type) {
+			case 'text':
+			default:
+				$text = $text == '' ? __('Map and Directions', 'event_espresso') : $text;
+				break;
+
+			case 'url_only':
+			case 'url':
+				$text = $google_map;
+				break;
+
+			case 'map':
+				$scheme = is_ssl() ? 'https://' : 'http://';
+
+				$api_key = apply_filters(
+					'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
+					EE_Registry::instance()->CFG->map_settings->google_map_api_key
+				);
+
+				return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+		}
+
+		return $type === 'url_only'
+			? $text
+			: '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
+	}
 }
 // End of file EEH_Maps.helper.php
 // Location: /helpers/EEH_Maps.helper.php
\ No newline at end of file

Spacing +17 added lines, -17 removed lines

@@ -39,7 +39,7 @@ 
             : 'default';
         $static_url          = ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : false;
 
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
+        if ( ! empty($ee_gmaps_opts['ee_map_align'])) {
             switch ($ee_gmaps_opts['ee_map_align']) {
                 case "left":
                     $map_align = 'ee-gmap-align-left left';
@@ -62,12 +62,12 @@ 
         // Determine whether user has set a hardoded url to use and
         // if so display a Google static iframe map else run V3 api
         if ($static_url) {
-            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-            $html .= '<iframe src="' . $static_url . '&output=embed"'
-                . ' style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"'
+            $html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper '.$map_align.'">';
+            $html .= '<iframe src="'.$static_url.'&output=embed"'
+                . ' style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;"'
                 . ' frameborder="0" scrolling="no">';
             $html .= '</iframe>';
-            $html .= '<a href="' . $static_url . '">View Large map</a>';
+            $html .= '<a href="'.$static_url.'">View Large map</a>';
             $html .= '</div>';
             return $html;
 
@@ -81,10 +81,10 @@ 
                 'location'            => $ee_gmaps_opts['location'],
             );
 
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html = '<div class="ee-gmap-wrapper ' . $map_align . '">'
-                    . '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] . '"'
-                    . ' style="' . $style . '"></div>'
+            $style = 'width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;';
+            $html = '<div class="ee-gmap-wrapper '.$map_align.'">'
+                    . '<div class="ee-gmap" id="map_canvas_'.$ee_gmaps_opts['map_ID'].'"'
+                    . ' style="'.$style.'"></div>'
                     . '</div>';
 
             wp_enqueue_script('gmap_api');
@@ -120,7 +120,7 @@ 
             )
         );
         wp_register_script('gmap_api', $api_url, array('jquery'), null, true);
-        wp_register_script('ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
+        wp_register_script('ee_gmap', plugin_dir_url(__FILE__).'assets/ee_gmap.js', array('gmap_api'), '1.0', true);
     }
 
     /**
@@ -151,12 +151,12 @@ 
         $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
 
         $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
+                          . ($city != '' ? ','.$city : '')
+                          . ($state != '' ? ','.$state : '')
+                          . ($zip != '' ? ','.$zip : '')
+                          . ($country != '' ? ','.$country : '');
 
-        $google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode($address_string));
+        $google_map = htmlentities2('http://maps.google.com/maps?q='.urlencode($address_string));
 
         switch ($type) {
             case 'text':
@@ -177,12 +177,12 @@ 
                     EE_Registry::instance()->CFG->map_settings->google_map_api_key
                 );
 
-                return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2($scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode($address_string) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode($address_string) . '&amp;sensor=false&amp;key=' . $api_key) . '" /></a>';
+                return '<a class="a_map_image_link" href="'.$google_map.'" target="_blank">'.'<img class="map_image_link" id="venue_map_'.$id.'" '.$map_image_class.' src="'.htmlentities2($scheme.'maps.googleapis.com/maps/api/staticmap?center='.urlencode($address_string).'&amp;zoom=14&amp;size='.$map_w.'x'.$map_h.'&amp;markers=color:green|label:|'.urlencode($address_string).'&amp;sensor=false&amp;key='.$api_key).'" /></a>';
         }
 
         return $type === 'url_only'
             ? $text
-            : '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
+            : '<a href="'.$google_map.'" target="_blank">'.$text.'</a>';
     }
 }
 // End of file EEH_Maps.helper.php

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +97 added lines, -99 removed lines

@@ -44,77 +44,76 @@ 
 	 */
 	protected $_image_url;
 
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY'
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY'
+		);
+		parent::__construct();
+	}
+
 
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
 	 *
 *@param array $settings_array
 	 */
 	public function set_settings( $settings_array ) {
 		parent::set_settings($settings_array);
 		// Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
 	}
 
 
 
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
 	public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
 		if ( ! $payment instanceof EEI_Payment ) {
 			$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
@@ -202,9 +201,9 @@ 
 				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 				// Item quantity.
 				$token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
-                // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
-                $item_num++;
+				// Digital item is sold.
+				$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
+				$item_num++;
 			}
 		} else {
 			// Just one Item.
@@ -277,7 +276,6 @@ 
 
 
 	/**
-
 	 *  @param array $update_info {
 	 *	  @type string $gateway_txn_id
 	 *	  @type string status an EEMI_Payment status
@@ -297,8 +295,8 @@ 
 				return $payment;
 			}
 			$primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
+			$payment_details = $payment->details();
+			// Check if we still have the token.
 			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN']) ) {
 				$payment->set_status( $this->_pay_model->failed_status() );
 				return $payment;
@@ -407,35 +405,35 @@ 
 	 */
 	public function _ppExpress_check_response( $request_response ) {
 		if ( is_wp_error( $request_response ) || empty($request_response['body']) ) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str( urldecode($request_response['body']), $response_args );
-        if ( ! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str( urldecode($request_response['body']), $response_args );
+		if ( ! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
 	}
 
 
 	/**
-     *  Log a "Cleared" request.
-     *
-     * @param array $request
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array $request
 	 * @param EEI_Payment  $payment
 	 * @param string  		$info
 	 * @return void
@@ -458,17 +456,17 @@ 
 		$n = 0;
 		while ( isset($data_array["L_ERRORCODE{$n}"]) ) {
 			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
-                ? $data_array["L_ERRORCODE{$n}"]
-                : '';
+				? $data_array["L_ERRORCODE{$n}"]
+				: '';
 			$l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
-                ? $data_array["L_SEVERITYCODE{$n}"]
-                : '';
+				? $data_array["L_SEVERITYCODE{$n}"]
+				: '';
 			$l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
-                ? $data_array["L_SHORTMESSAGE{$n}"]
-                : '';
+				? $data_array["L_SHORTMESSAGE{$n}"]
+				: '';
 			$l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
-                ? $data_array["L_LONGMESSAGE{$n}"]
-                : '';
+				? $data_array["L_LONGMESSAGE{$n}"]
+				: '';
 
 			if ( $n === 0 ) {
 				$errors = array(

Spacing +97 added lines, -97 removed lines

@@ -1,4 +1,4 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' )) { exit('NO direct script access allowed'); }
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('NO direct script access allowed'); }
 
 /**
  * ----------------------------------------------
@@ -96,7 +96,7 @@ 
 	 *
 *@param array $settings_array
 	 */
-	public function set_settings( $settings_array ) {
+	public function set_settings($settings_array) {
 		parent::set_settings($settings_array);
 		// Redirect URL.
         $this->_base_gateway_url = $this->_debug_mode
@@ -115,19 +115,19 @@ 
      * @return \EE_Payment|\EEI_Payment
      * @throws \EE_Error
      */
-	public function set_redirection_info( $payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL ) {
-		if ( ! $payment instanceof EEI_Payment ) {
-			$payment->set_gateway_response( __( 'Error. No associated payment was found.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+	public function set_redirection_info($payment, $billing_info = array(), $return_url = NULL, $notify_url = NULL, $cancel_url = NULL) {
+		if ( ! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(__('Error. No associated payment was found.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 			return $payment;
 		}
 		$transaction = $payment->transaction();
-		if ( ! $transaction instanceof EEI_Transaction ) {
-			$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+		if ( ! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(__('Could not process this payment because it has no associated transaction.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 			return $payment;
 		}
-		$order_description = substr( $this->_format_order_description($payment), 0, 127 );
+		$order_description = substr($this->_format_order_description($payment), 0, 127);
 		$primary_registration = $transaction->primary_registration();
 		$primary_attendee = $primary_registration instanceof EE_Registration ? $primary_registration->attendee() : false;
 		$locale = explode('-', get_bloginfo('language'));
@@ -141,37 +141,37 @@ 
 			'RETURNURL' => $return_url,
 			'CANCELURL' => $cancel_url,
 			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-			'SOLUTIONTYPE' => 'Sole',	// Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
-			'BUTTONSOURCE' => 'EventEspresso_SP',//EE will blow up if you change this
+			'SOLUTIONTYPE' => 'Sole', // Buyer does not need to create a PayPal account to check out. This is referred to as PayPal Account Optional.
+			'BUTTONSOURCE' => 'EventEspresso_SP', //EE will blow up if you change this
 			'LOCALECODE' => $locale[1]	// Locale of the pages displayed by PayPal during Express Checkout.
 		);
 
 		// Show itemized list.
-		if ( $this->_money->compare_floats( $payment->amount(), $transaction->total(), '==' ) ) {
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
 			$item_num = 0;
 			$itemized_sum = 0;
 			$total_line_items = $transaction->total_line_item();
 			// Go through each item in the list.
-			foreach ( $total_line_items->get_items() as $line_item ) {
-				if ( $line_item instanceof EE_Line_Item ) {
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
 					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
-					if ( EEH_Money::compare_floats( $line_item->total(), '0.00', '==' ) ) {
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
 						continue;
 					}
 
 					$unit_price = $line_item->unit_price();
 					$line_item_quantity = $line_item->quantity();
 					// This is a discount.
-					if ( $line_item->is_percent() ) {
+					if ($line_item->is_percent()) {
 						$unit_price = $line_item->total();
 						$line_item_quantity = 1;
 					}
 					// Item Name.
-					$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($this->_format_line_item_name( $line_item, $payment), 0, 127);
+					$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr($this->_format_line_item_name($line_item, $payment), 0, 127);
 					// Item description.
-					$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($this->_format_line_item_desc( $line_item, $payment), 0, 127);
+					$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr($this->_format_line_item_desc($line_item, $payment), 0, 127);
 					// Cost of individual item.
-					$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $unit_price );
+					$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($unit_price);
 					// Item Number.
 					$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 					// Item quantity.
@@ -188,16 +188,16 @@ 
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
 
-			$itemized_sum_diff_from_txn_total = round( $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2 );
+			$itemized_sum_diff_from_txn_total = round($transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), 2);
 			// If we were not able to recognize some item like promotion, surcharge or cancellation,
 			// add the difference as an extra line item.
-			if ( $this->_money->compare_floats( $itemized_sum_diff_from_txn_total, 0, '!=' ) ) {
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
 				// Item Name.
-				$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr( __( 'Other (promotion/surcharge/cancellation)', 'event_espresso' ), 0, 127 );
+				$token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr(__('Other (promotion/surcharge/cancellation)', 'event_espresso'), 0, 127);
 				// Item description.
 				$token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
 				// Cost of individual item.
-				$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency( $itemized_sum_diff_from_txn_total );
+				$token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($itemized_sum_diff_from_txn_total);
 				// Item Number.
 				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
 				// Item quantity.
@@ -209,11 +209,11 @@ 
 		} else {
 			// Just one Item.
 			// Item Name.
-			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr( $this->_format_partial_payment_line_item_name($payment), 0, 127 );
+			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr($this->_format_partial_payment_line_item_name($payment), 0, 127);
 			// Item description.
-			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr( $this->_format_partial_payment_line_item_desc($payment), 0, 127 );
+			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr($this->_format_partial_payment_line_item_desc($payment), 0, 127);
 			// Cost of individual item.
-			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency( $payment->amount() );
+			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
 			// Item Number.
 			$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
 			// Item quantity.
@@ -221,14 +221,14 @@ 
 			// Digital item is sold.
 			$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
 			// Item's sales S/H and tax amount.
-			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency( $payment->amount() );
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
 			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
 			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
 		}
 		// Automatically filling out shipping and contact information.
-		if ( $this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee ) {
-			$token_request_dtls['NOSHIPPING'] = '2';	//  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			$token_request_dtls['NOSHIPPING'] = '2'; //  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
@@ -237,14 +237,14 @@ 
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
 			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
 			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-		} elseif ( ! $this->_request_shipping_addr ) {
+		} elseif ( ! $this->_request_shipping_addr) {
 			// Do not request shipping details on the PP Checkout page.
 			$token_request_dtls['NOSHIPPING'] = '1';
 			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
 
 		}
 		// Used a business/personal logo on the PayPal page.
-		if ( ! empty($this->_image_url) ) {
+		if ( ! empty($this->_image_url)) {
 			$token_request_dtls['LOGOIMG'] = $this->_image_url;
 		}
 		$token_request_dtls = apply_filters(
@@ -253,23 +253,23 @@ 
 			$this
 		);
 		// Request PayPal token.
-		$token_request_response = $this->_ppExpress_request( $token_request_dtls, 'Payment Token', $payment );
-		$token_rstatus = $this->_ppExpress_check_response( $token_request_response );
-		$response_args = ( isset($token_rstatus['args']) && is_array($token_rstatus['args']) ) ? $token_rstatus['args'] : array();
-		if ( $token_rstatus['status'] ) {
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args'])) ? $token_rstatus['args'] : array();
+		if ($token_rstatus['status']) {
 			// We got the Token so we may continue with the payment and redirect the client.
-			$payment->set_details( $response_args );
+			$payment->set_details($response_args);
 
 			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-			$payment->set_redirect_url( $gateway_url . '/checkoutnow?useraction=commit&cmd=_express-checkout&token=' . $response_args['TOKEN'] );
+			$payment->set_redirect_url($gateway_url.'/checkoutnow?useraction=commit&cmd=_express-checkout&token='.$response_args['TOKEN']);
 		} else {
-			if ( isset($response_args['L_ERRORCODE']) ) {
-				$payment->set_gateway_response( $response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE'] );
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
 			} else {
-				$payment->set_gateway_response( __( 'Error occurred while trying to setup the Express Checkout.', 'event_espresso' ) );
+				$payment->set_gateway_response(__('Error occurred while trying to setup the Express Checkout.', 'event_espresso'));
 			}
-			$payment->set_details( $response_args );
-			$payment->set_status( $this->_pay_model->failed_status() );
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
 		}
 
 		return $payment;
@@ -285,22 +285,22 @@ 
 	 *  @param EEI_Transaction $transaction
 	 *  @return EEI_Payment
 	 */
-	public function handle_payment_update( $update_info, $transaction ) {
+	public function handle_payment_update($update_info, $transaction) {
 		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
 
-		if ( $payment instanceof EEI_Payment ) {
-			$this->log( array( 'Return from Authorization' => $update_info ), $payment );
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
 			$transaction = $payment->transaction();
-			if ( ! $transaction instanceof EEI_Transaction ) {
-				$payment->set_gateway_response( __( 'Could not process this payment because it has no associated transaction.', 'event_espresso' ) );
-				$payment->set_status( $this->_pay_model->failed_status() );
+			if ( ! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(__('Could not process this payment because it has no associated transaction.', 'event_espresso'));
+				$payment->set_status($this->_pay_model->failed_status());
 				return $payment;
 			}
 			$primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN']) ) {
-				$payment->set_status( $this->_pay_model->failed_status() );
+			if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
 				return $payment;
 			}
 
@@ -309,10 +309,10 @@ 
 				'TOKEN' => $payment_details['TOKEN']
 			);
 			// Request Customer Details.
-			$cdetails_request_response = $this->_ppExpress_request( $cdetails_request_dtls, 'Customer Details', $payment );
-			$cdetails_rstatus = $this->_ppExpress_check_response( $cdetails_request_response );
-			$cdata_response_args = ( isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']) ) ? $cdetails_rstatus['args'] : array();
-			if ( $cdetails_rstatus['status'] ) {
+			$cdetails_request_response = $this->_ppExpress_request($cdetails_request_dtls, 'Customer Details', $payment);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args'])) ? $cdetails_rstatus['args'] : array();
+			if ($cdetails_rstatus['status']) {
 				// We got the PayerID so now we can Complete the transaction.
 				$docheckout_request_dtls = array(
 					'METHOD' => 'DoExpressCheckoutPayment',
@@ -323,39 +323,39 @@ 
 					'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code()
 				);
 				// Payment Checkout/Capture.
-				$docheckout_request_response = $this->_ppExpress_request( $docheckout_request_dtls, 'Do Payment', $payment );
-				$docheckout_rstatus = $this->_ppExpress_check_response( $docheckout_request_response );
-				$docheckout_response_args = ( isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']) ) ? $docheckout_rstatus['args'] : array();
-				if ( $docheckout_rstatus['status'] ) {
+				$docheckout_request_response = $this->_ppExpress_request($docheckout_request_dtls, 'Do Payment', $payment);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args'])) ? $docheckout_rstatus['args'] : array();
+				if ($docheckout_rstatus['status']) {
 					// All is well, payment approved.
 					$primary_registration_code = $primary_registrant instanceof EE_Registration ? $primary_registrant->reg_code() : '';
-					$payment->set_extra_accntng( $primary_registration_code );
-					$payment->set_amount( isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT'] : 0 );
-					$payment->set_txn_id_chq_nmbr( isset( $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] ) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null );
-					$payment->set_details( $cdata_response_args );
-					$payment->set_gateway_response( isset( $docheckout_response_args['PAYMENTINFO_0_ACK'] ) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '' );
-					$payment->set_status( $this->_pay_model->approved_status() );
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT']) ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT'] : 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']) ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] : null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK']) ? $docheckout_response_args['PAYMENTINFO_0_ACK'] : '');
+					$payment->set_status($this->_pay_model->approved_status());
 				} else {
-					if ( isset($docheckout_response_args['L_ERRORCODE']) ) {
-						$payment->set_gateway_response( $docheckout_response_args['L_ERRORCODE'] . '; ' . $docheckout_response_args['L_SHORTMESSAGE'] );
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response($docheckout_response_args['L_ERRORCODE'].'; '.$docheckout_response_args['L_SHORTMESSAGE']);
 					} else {
-						$payment->set_gateway_response( __( 'Error occurred while trying to Capture the funds.', 'event_espresso' ) );
+						$payment->set_gateway_response(__('Error occurred while trying to Capture the funds.', 'event_espresso'));
 					}
-					$payment->set_details( $docheckout_response_args );
-					$payment->set_status( $this->_pay_model->declined_status() );
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
 				}
 			} else {
-				if ( isset($cdata_response_args['L_ERRORCODE']) ) {
-					$payment->set_gateway_response( $cdata_response_args['L_ERRORCODE'] . '; ' . $cdata_response_args['L_SHORTMESSAGE'] );
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response($cdata_response_args['L_ERRORCODE'].'; '.$cdata_response_args['L_SHORTMESSAGE']);
 				} else {
-					$payment->set_gateway_response( __( 'Error occurred while trying to get payment Details from PayPal.', 'event_espresso' ) );
+					$payment->set_gateway_response(__('Error occurred while trying to get payment Details from PayPal.', 'event_espresso'));
 				}
-				$payment->set_details( $cdata_response_args );
-				$payment->set_status( $this->_pay_model->failed_status() );
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
 			}
 		} else {
-			$payment->set_gateway_response( __( 'Error occurred while trying to process the payment.', 'event_espresso' ) );
-			$payment->set_status( $this->_pay_model->failed_status() );
+			$payment->set_gateway_response(__('Error occurred while trying to process the payment.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
 		}
 
 		return $payment;
@@ -370,16 +370,16 @@ 
 	 *  @param EEI_Payment  $payment
 	 *	@return mixed
 	 */
-	public function _ppExpress_request( $request_params, $request_text, $payment ) {
+	public function _ppExpress_request($request_params, $request_text, $payment) {
 		$request_dtls = array(
 			'VERSION' => '204.0',
-			'USER' => urlencode( $this->_api_username ),
-			'PWD' => urlencode( $this->_api_password ),
-			'SIGNATURE' => urlencode( $this->_api_signature )
+			'USER' => urlencode($this->_api_username),
+			'PWD' => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature)
 		);
-		$dtls = array_merge( $request_dtls, $request_params );
+		$dtls = array_merge($request_dtls, $request_params);
 
-		$this->_log_clean_request( $dtls, $payment, $request_text . ' Request' );
+		$this->_log_clean_request($dtls, $payment, $request_text.' Request');
 		// Request Customer Details.
 		$request_response = wp_remote_post(
 			$this->_base_gateway_url,
@@ -389,11 +389,11 @@ 
 				'httpversion' => '1.1',
 				'cookies' => array(),
 				'headers' => array(),
-				'body' => http_build_query( $dtls )
+				'body' => http_build_query($dtls)
 			)
 		);
 		// Log the response.
-		$this->log( array( $request_text . ' Response' => $request_response), $payment );
+		$this->log(array($request_text.' Response' => $request_response), $payment);
 
 		return $request_response;
 	}
@@ -405,13 +405,13 @@ 
 	 *	@param mixed        $request_response
 	 *	@return array
 	 */
-	public function _ppExpress_check_response( $request_response ) {
-		if ( is_wp_error( $request_response ) || empty($request_response['body']) ) {
+	public function _ppExpress_check_response($request_response) {
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
             // If we got here then there was an error in this request.
             return array('status' => false, 'args' => $request_response);
         }
         $response_args = array();
-        parse_str( urldecode($request_response['body']), $response_args );
+        parse_str(urldecode($request_response['body']), $response_args);
         if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
@@ -440,10 +440,10 @@ 
 	 * @param string  		$info
 	 * @return void
 	 */
-	private function _log_clean_request($request, $payment, $info ) {
+	private function _log_clean_request($request, $payment, $info) {
 		$cleaned_request_data = $request;
 		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-		$this->log( array($info => $cleaned_request_data), $payment );
+		$this->log(array($info => $cleaned_request_data), $payment);
 	}
 
 
@@ -453,10 +453,10 @@ 
 	 *  @param array	$data_array
 	 *  @return array
 	 */
-	private function _get_errors( $data_array ) {
+	private function _get_errors($data_array) {
 		$errors = array();
 		$n = 0;
-		while ( isset($data_array["L_ERRORCODE{$n}"]) ) {
+		while (isset($data_array["L_ERRORCODE{$n}"])) {
 			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
                 ? $data_array["L_ERRORCODE{$n}"]
                 : '';
@@ -470,7 +470,7 @@ 
                 ? $data_array["L_LONGMESSAGE{$n}"]
                 : '';
 
-			if ( $n === 0 ) {
+			if ($n === 0) {
 				$errors = array(
 					'L_ERRORCODE' => $l_error_code,
 					'L_SHORTMESSAGE' => $l_short_message,
@@ -478,10 +478,10 @@ 
 					'L_SEVERITYCODE' => $l_severity_code
 				);
 			} else {
-				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+				$errors['L_ERRORCODE'] .= ', '.$l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
 			}
 
 			$n++;

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Indentation +116 added lines, -116 removed lines

@@ -286,41 +286,41 @@ 
 			$this->checkout->revisit
 		);
 		foreach ( $registrations as $REG_ID => $registration ) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
 			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
 				$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
 				continue;
 			}
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if (
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if (
 				// returning registrant
 				$this->checkout->revisit
 				// anything other than Approved
 				&& $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out( true )
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out( true )
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
 			}
 			// are they allowed to pay now and is there monies owing?
 			if ( $registration->owes_monies_and_can_pay() ) {
@@ -428,11 +428,11 @@ 
 			new EE_Billable_Line_Item_Filter(
 				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
 					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
 				)
 			)
-        );
+		);
 		$line_item_filter_collection->add( new EE_Non_Zero_Line_Item_Filter() );
 		return $line_item_filter_collection;
 	}
@@ -481,46 +481,46 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
-        // registrations per event
+		// registrations per event
 		$event_reg_count = array();
 		// spaces left per event
 		$event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
 		$ejected_registrations = array();
 		foreach ( $registrations as $REG_ID => $registration ) {
-            if (
-                $registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                continue;
+			if (
+				$registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				continue;
 			}
 			$EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if ( ! isset($tickets_remaining[$ticket->ID()])) {
-                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
-            }
-            if ($tickets_remaining[$ticket->ID()] > 0) {
-                if ( ! isset($event_reg_count[$EVT_ID])) {
-                    $event_reg_count[$EVT_ID] = 0;
-                }
-                $event_reg_count[$EVT_ID]++;
-                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
-                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
+			$ticket = $registration->ticket();
+			if ( ! isset($tickets_remaining[$ticket->ID()])) {
+				$tickets_remaining[$ticket->ID()] = $ticket->remaining();
+			}
+			if ($tickets_remaining[$ticket->ID()] > 0) {
+				if ( ! isset($event_reg_count[$EVT_ID])) {
+					$event_reg_count[$EVT_ID] = 0;
+				}
+				$event_reg_count[$EVT_ID]++;
+				if ( ! isset($event_spaces_remaining[$EVT_ID])) {
+					$event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
 			if (
 				$revisit
 				&& (
-                    $tickets_remaining[$ticket->ID()] === 0
-				    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
-                )
+					$tickets_remaining[$ticket->ID()] === 0
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				)
 			) {
 				$ejected_registrations[ $REG_ID ] = $registration->event();
 				if ( $registration->status_ID() !== EEM_Registration::status_id_wait_list ) {
@@ -589,9 +589,9 @@ 
 				'layout_strategy'		=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
@@ -644,9 +644,9 @@ 
 				'layout_strategy' => new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
 							array(
@@ -694,9 +694,9 @@ 
 				'layout_strategy'		=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'events_requiring_pre_approval.template.php', // layout_template
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
@@ -734,9 +734,9 @@ 
 				'layout_strategy' 	=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'no_payment_required.template.php', // layout_template
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
 							array(
@@ -964,7 +964,7 @@ 
 					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
 				}
 				$payment_methods_billing_info[ $payment_method->slug()
-				                               . '-info' ] = $this->_payment_method_billing_info(
+											   . '-info' ] = $this->_payment_method_billing_info(
 					$payment_method
 				);
 			}
@@ -1152,7 +1152,7 @@ 
 		// fill form with attendee info if applicable
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-		    && $this->checkout->transaction_has_primary_registrant()
+			&& $this->checkout->transaction_has_primary_registrant()
 		) {
 			$payment_method_billing_form->populate_from_attendee(
 				$this->checkout->transaction->primary_registration()->attendee()
@@ -1161,7 +1161,7 @@ 
 		// and debug content
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Info_Form
-		    && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$payment_method_billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
 				$payment_method_billing_form
@@ -1336,7 +1336,7 @@ 
 		}
 		// and debug content
 		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form
-		     && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+			 && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$this->checkout->billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
 				$this->checkout->billing_form
@@ -1506,8 +1506,8 @@ 
 		}
 		// does this attendee already exist in the db ? we're searching using a combination of first name, last name, AND email address
 		if ( ! empty( $attendee_data['ATT_fname'] )
-		     && ! empty( $attendee_data['ATT_lname'] )
-		     && ! empty( $attendee_data['ATT_email'] )
+			 && ! empty( $attendee_data['ATT_lname'] )
+			 && ! empty( $attendee_data['ATT_email'] )
 		) {
 			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
 				array(
@@ -1754,7 +1754,7 @@ 
 			$payment_status = $payment->status();
 			if (
 				$payment_status === EEM_Payment::status_id_approved
-			    || $payment_status === EEM_Payment::status_id_pending
+				|| $payment_status === EEM_Payment::status_id_pending
 			) {
 				return true;
 			} else {
@@ -1980,8 +1980,8 @@ 
 			return false;
 		}
 		if ( ! $primary_registration->_add_relation_to( $this->checkout->primary_attendee_obj, 'Attendee' )
-		       instanceof
-		       EE_Attendee
+			   instanceof
+			   EE_Attendee
 		) {
 			EE_Error::add_error(
 				sprintf(
@@ -2454,14 +2454,14 @@ 
 
 
 
-    /**
-     * _validate_return
-     *
-     * @access private
-     * @return void
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     * @throws \EE_Error
-     */
+	/**
+	 * _validate_return
+	 *
+	 * @access private
+	 * @return void
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 * @throws \EE_Error
+	 */
 	private function _validate_offsite_return() {
 		$TXN_ID = (int)EE_Registry::instance()->REQ->get( 'spco_txn', 0 );
 		if ( $TXN_ID !== $this->checkout->transaction->ID() ) {
@@ -2487,20 +2487,20 @@ 
 				? $primary_registrant->session_ID()
 				: null;
 			// validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // WARNING !!!
-                    // this could be PayPal sending back duplicate requests (ya they do that)
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
-                    // so now we need to determine if this current TXN looks valid or not
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// WARNING !!!
+					// this could be PayPal sending back duplicate requests (ya they do that)
+					// or it **could** mean someone is simply registering AGAIN after having just done so
+					// so now we need to determine if this current TXN looks valid or not
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
 				$invalid_TXN = true;
 			}
 			if ( $invalid_TXN ) {
@@ -2702,19 +2702,19 @@ 
 
 
 
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
-     * EE_Checkout will handle the reimplementation of itself upon waking,
-     * but we won't bother with the reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
-    }
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
+	 * EE_Checkout will handle the reimplementation of itself upon waking,
+	 * but we won't bother with the reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
+	}
 
 
 

Spacing +359 added lines, -359 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,32 +38,32 @@ 
 	public static function set_hooks() {
 		add_filter(
 			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
 		);
 		add_action(
 			'wp_ajax_switch_spco_billing_form',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
 		);
 		add_action(
 			'wp_ajax_nopriv_switch_spco_billing_form',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
 		);
-		add_action( 'wp_ajax_save_payer_details', array( 'EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details' ) );
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
 		add_action(
 			'wp_ajax_nopriv_save_payer_details',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
 		);
 		add_action(
 			'wp_ajax_get_transaction_details_for_gateways',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
 		);
 		add_action(
 			'wp_ajax_nopriv_get_transaction_details_for_gateways',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
 		);
 		add_filter(
 			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method' ),
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
 			10,
 			1
 		);
@@ -77,7 +77,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function switch_spco_billing_form() {
-		EED_Single_Page_Checkout::process_ajax_request( 'switch_payment_method' );
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
 	}
 
 
@@ -88,7 +88,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function save_payer_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'save_payer_details_via_ajax' );
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function get_transaction_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'get_transaction_details_for_gateways' );
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
 	}
 
 
@@ -126,10 +126,10 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'payment_options';
-		$this->_name = __( 'Payment Options', 'event_espresso' );
-		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->_name = __('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'payment_options_main.template.php';
 		$this->checkout = $checkout;
 		$this->_reset_success_message();
 		$this->set_instructions(
@@ -154,7 +154,7 @@ 
 	/**
 	 * @param null $line_item_display
 	 */
-	public function set_line_item_display( $line_item_display ) {
+	public function set_line_item_display($line_item_display) {
 		$this->line_item_display = $line_item_display;
 	}
 
@@ -172,8 +172,8 @@ 
 	/**
 	 * @param boolean $handle_IPN_in_this_request
 	 */
-	public function set_handle_IPN_in_this_request( $handle_IPN_in_this_request ) {
-		$this->handle_IPN_in_this_request = filter_var( $handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN );
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request) {
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -208,14 +208,14 @@ 
 	public function enqueue_styles_and_scripts() {
 		$transaction = $this->checkout->transaction;
 		//if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-		if( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats( $transaction->remaining(), 0 ) ) {
+		if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
 			return;
 		}
-		foreach( EEM_Payment_Method::instance()->get_all_for_transaction( $transaction, EEM_Payment_Method::scope_cart ) as $payment_method ) {
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
 			$type_obj = $payment_method->type_obj();
-			if( $type_obj instanceof EE_PMT_Base ) {
-				$billing_form = $type_obj->generate_new_billing_form( $transaction );
-				if( $billing_form instanceof EE_Form_Section_Proper ) {
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
 					$billing_form->enqueue_js();
 				}
 			}
@@ -240,20 +240,20 @@ 
 			// 	$ 0.00 transactions (no payment required)
 			! $this->checkout->payment_required()
 			// but do NOT remove if current action being called belongs to this reg step
-			&& ! is_callable( array( $this, $this->checkout->action ) )
+			&& ! is_callable(array($this, $this->checkout->action))
 			&& ! $this->completed()
 		) {
 			// and if so, then we no longer need the Payment Options step
-			if ( $this->is_current_step() ) {
+			if ($this->is_current_step()) {
 				$this->checkout->generate_reg_form = false;
 			}
-			$this->checkout->remove_reg_step( $this->_slug );
+			$this->checkout->remove_reg_step($this->_slug);
 			// DEBUG LOG
 			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
 			return false;
 		}
 		// load EEM_Payment_Method
-		EE_Registry::instance()->load_model( 'Payment_Method' );
+		EE_Registry::instance()->load_model('Payment_Method');
 		// get all active payment methods
 		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
 			$this->checkout->transaction,
@@ -280,16 +280,16 @@ 
 		$insufficient_spaces_available = array();
 		$no_payment_required = true;
 		// loop thru registrations to gather info
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
 		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
 			$registrations,
 			$this->checkout->revisit
 		);
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
             /** @var $registration EE_Registration */
             // has this registration lost it's space ?
-			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
-				$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+			if (isset($ejected_registrations[$REG_ID])) {
+				$insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
 				continue;
 			}
             // event requires admin approval
@@ -310,11 +310,11 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_approved
                 && (
                     $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out( true )
+                    || $registration->event()->is_sold_out(true)
                 )
             ) {
                 // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                $sold_out_events[$registration->event()->ID()] = $registration->event();
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
                     $registration->event(),
@@ -323,8 +323,8 @@ 
                 continue;
 			}
 			// are they allowed to pay now and is there monies owing?
-			if ( $registration->owes_monies_and_can_pay() ) {
-				$registrations_requiring_payment[ $REG_ID ] = $registration;
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[$REG_ID] = $registration;
 				do_action(
 					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
 					$registration->event(),
@@ -335,29 +335,29 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
 				&& $registration->ticket()->is_free()
 			) {
-				$registrations_for_free_events[ $registration->event()->ID() ] = $registration;
+				$registrations_for_free_events[$registration->event()->ID()] = $registration;
 			}
 		}
 		$subsections = array();
 		// now decide which template to load
-		if ( ! empty( $sold_out_events ) ) {
-			$subsections['sold_out_events'] = $this->_sold_out_events( $sold_out_events );
+		if ( ! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
 		}
-		if ( ! empty( $insufficient_spaces_available ) ) {
+		if ( ! empty($insufficient_spaces_available)) {
 			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
 				$insufficient_spaces_available
 			);
 		}
-		if ( ! empty( $registrations_requiring_pre_approval ) ) {
+		if ( ! empty($registrations_requiring_pre_approval)) {
 			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
 				$registrations_requiring_pre_approval
 			);
 		}
-		if ( ! empty( $registrations_for_free_events ) ) {
-			$subsections['no_payment_required'] = $this->_no_payment_required( $registrations_for_free_events );
+		if ( ! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
 		}
-		if ( ! empty( $registrations_requiring_payment ) ) {
-			if ( $this->checkout->amount_owing > 0 ) {
+		if ( ! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
 				// autoload Line_Item_Display classes
 				EEH_Autoloader::register_line_item_filter_autoloaders();
 				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
@@ -370,15 +370,15 @@ 
 				/** @var EE_Line_Item $filtered_line_item_tree */
 				$filtered_line_item_tree = $line_item_filter_processor->process();
 				EEH_Autoloader::register_line_item_display_autoloaders();
-				$this->set_line_item_display( new EE_Line_Item_Display( 'spco' ) );
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
 				$subsections['payment_options'] = $this->_display_payment_options(
 					$this->line_item_display->display_line_item(
 						$filtered_line_item_tree,
-						array( 'registrations' => $registrations )
+						array('registrations' => $registrations)
 					)
 				);
 				$this->checkout->amount_owing = $filtered_line_item_tree->total();
-				$this->_apply_registration_payments_to_amount_owing( $registrations );
+				$this->_apply_registration_payments_to_amount_owing($registrations);
 			}
 			$no_payment_required = false;
 		} else {
@@ -387,7 +387,7 @@ 
 		$this->_save_selected_method_of_payment();
 
 		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-		$subsections['extra_hidden_inputs' ] = $this->_extra_hidden_inputs( $no_payment_required );
+		$subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
 
 		return new EE_Form_Section_Proper(
 			array(
@@ -414,14 +414,14 @@ 
 	 * @return \EE_Line_Item_Filter_Collection
 	 * @throws \EE_Error
 	 */
-	public static function add_spco_line_item_filters( EE_Line_Item_Filter_Collection $line_item_filter_collection ) {
-		if ( ! EE_Registry::instance()->SSN instanceof EE_Session ) {
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection) {
+		if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
 			return $line_item_filter_collection;
 		}
-		if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout ) {
+		if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
 			return $line_item_filter_collection;
 		}
-		if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction ) {
+		if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
 			return $line_item_filter_collection;
 		}
 		$line_item_filter_collection->add(
@@ -433,7 +433,7 @@ 
 				)
 			)
         );
-		$line_item_filter_collection->add( new EE_Non_Zero_Line_Item_Filter() );
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
 		return $line_item_filter_collection;
 	}
 
@@ -449,15 +449,15 @@ 
 	 * @return \EE_Registration[]
 	 * @throws \EE_Error
 	 */
-	public static function remove_ejected_registrations( array $registrations ) {
+	public static function remove_ejected_registrations(array $registrations) {
 		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
 			$registrations,
 			EE_Registry::instance()->SSN->checkout()->revisit
 		);
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
 			// has this registration lost it's space ?
-			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
-				unset( $registrations[ $REG_ID ] );
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
 				continue;
 			}
 		}
@@ -480,7 +480,7 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false) {
         // registrations per event
 		$event_reg_count = array();
 		// spaces left per event
@@ -489,7 +489,7 @@ 
         $tickets_remaining = array();
         // registrations that have lost their space
 		$ejected_registrations = array();
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
             if (
                 $registration->status_ID() === EEM_Registration::status_id_approved
                 || apply_filters(
@@ -519,13 +519,13 @@ 
 				$revisit
 				&& (
                     $tickets_remaining[$ticket->ID()] === 0
-				    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
                 )
 			) {
-				$ejected_registrations[ $REG_ID ] = $registration->event();
-				if ( $registration->status_ID() !== EEM_Registration::status_id_wait_list ) {
+				$ejected_registrations[$REG_ID] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
 					/** @type EE_Registration_Processor $registration_processor */
-					$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 					// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
 					$registration_processor->manually_update_registration_status(
 						$registration,
@@ -560,8 +560,8 @@ 
 	 * @return void
 	 */
 	protected function _hide_reg_step_submit_button_if_revisit() {
-		if ( $this->checkout->revisit ) {
-			add_filter( 'FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string' );
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
 		}
 	}
 
@@ -575,13 +575,13 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _sold_out_events( $sold_out_events_array = array() ) {
+	private function _sold_out_events($sold_out_events_array = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'events_sold_out';
 		$sold_out_events = '';
-		foreach ( $sold_out_events_array as $sold_out_event ) {
+		foreach ($sold_out_events_array as $sold_out_event) {
 			$sold_out_events .= EEH_HTML::li(
-				EEH_HTML::span( '  ' .$sold_out_event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text' )
+				EEH_HTML::span('  '.$sold_out_event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
 			);
 		}
 		return new EE_Form_Section_Proper(
@@ -599,7 +599,7 @@ 
 								'sold_out_events_msg' => apply_filters(
 									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
 									sprintf(
-										__( 'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s', 'event_espresso' ),
+										__('It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s', 'event_espresso'),
 										'<strong>',
 										'</strong>',
 										'<br />'
@@ -624,14 +624,14 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _insufficient_spaces_available( $insufficient_spaces_events_array = array() ) {
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'invoice';
 		$insufficient_space_events = '';
-		foreach ( $insufficient_spaces_events_array as $event ) {
-			if ( $event instanceof EE_Event ) {
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
 				$insufficient_space_events .= EEH_HTML::li(
-					EEH_HTML::span( ' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text' )
+					EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
 				);
 			}
 		}
@@ -675,17 +675,17 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _registrations_requiring_pre_approval( $registrations_requiring_pre_approval = array() ) {
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array()) {
 		$events_requiring_pre_approval = '';
-		foreach ( $registrations_requiring_pre_approval as $registration ) {
-			if ( $registration instanceof EE_Registration && $registration->event() instanceof EE_Event ) {
-				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
 					EEH_HTML::span(
 						'',
 						'',
 						'dashicons dashicons-marker ee-icon-size-16 orange-text'
 					)
-					. EEH_HTML::span( $registration->event()->name(), '', 'orange-text' )
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
 				);
 			}
 		}
@@ -700,7 +700,7 @@ 
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
-								'events_requiring_pre_approval'     => implode( '', $events_requiring_pre_approval ),
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
 								'events_requiring_pre_approval_msg' => apply_filters(
 									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
 									__(
@@ -725,7 +725,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _no_payment_required( $registrations_for_free_events = array() ) {
+	private function _no_payment_required($registrations_for_free_events = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'no_payment_required';
 		// generate no_payment_required form
@@ -745,7 +745,7 @@ 
 								'ticket_count'                  => array(),
 								'registrations_for_free_events' => $registrations_for_free_events,
 								'no_payment_required_msg'       => EEH_HTML::p(
-									__( 'This is a free event, so no billing will occur.', 'event_espresso' )
+									__('This is a free event, so no billing will occur.', 'event_espresso')
 								)
 							)
 						),
@@ -764,7 +764,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _display_payment_options( $transaction_details = '' ) {
+	private function _display_payment_options($transaction_details = '') {
 		// has method_of_payment been set by no-js user?
 		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
 		// build payment options form
@@ -776,14 +776,14 @@ 
 						'before_payment_options' => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
 							new EE_Form_Section_Proper(
-								array( 'layout_strategy' => new EE_Div_Per_Section_Layout() )
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
 							)
 						),
 						'payment_options'        => $this->_setup_payment_options(),
 						'after_payment_options'  => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
 							new EE_Form_Section_Proper(
-								array( 'layout_strategy' => new EE_Div_Per_Section_Layout() )
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
 							)
 						),
 					),
@@ -814,10 +814,10 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _extra_hidden_inputs( $no_payment_required = true ) {
+	private function _extra_hidden_inputs($no_payment_required = true) {
 		return new EE_Form_Section_Proper(
 			array(
-				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
 					'spco_no_payment_required' => new EE_Hidden_Input(
@@ -849,16 +849,16 @@ 
 	 * @access protected
 	 * @param array $registrations
 	 */
-	protected function _apply_registration_payments_to_amount_owing( array $registrations ) {
+	protected function _apply_registration_payments_to_amount_owing(array $registrations) {
 		$payments = array();
-		foreach ( $registrations as $registration ) {
-			if ( $registration instanceof EE_Registration && $registration->owes_monies_and_can_pay() ) {
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
 				$payments += $registration->registration_payments();
 			}
 		}
-		if ( ! empty( $payments ) ) {
-			foreach ( $payments as $payment ) {
-				if ( $payment instanceof EE_Registration_Payment ) {
+		if ( ! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
 					$this->checkout->amount_owing -= $payment->amount();
 				}
 			}
@@ -874,11 +874,11 @@ 
 	 * @param    bool $force_reset
 	 * @return    void
 	 */
-	private function _reset_selected_method_of_payment( $force_reset = false ) {
+	private function _reset_selected_method_of_payment($force_reset = false) {
 		$reset_payment_method = $force_reset
 			? true
-			: sanitize_text_field( EE_Registry::instance()->REQ->get( 'reset_payment_method', false ) );
-		if ( $reset_payment_method ) {
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		if ($reset_payment_method) {
 			$this->checkout->selected_method_of_payment = null;
 			$this->checkout->payment_method = null;
 			$this->checkout->billing_form = null;
@@ -897,12 +897,12 @@ 
 	 * @param string $selected_method_of_payment
 	 * @return  void
 	 */
-	private function _save_selected_method_of_payment( $selected_method_of_payment = '' ) {
-		$selected_method_of_payment = ! empty( $selected_method_of_payment )
+	private function _save_selected_method_of_payment($selected_method_of_payment = '') {
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
 			? $selected_method_of_payment
 			: $this->checkout->selected_method_of_payment;
 		EE_Registry::instance()->SSN->set_session_data(
-			array( 'selected_method_of_payment' => $selected_method_of_payment )
+			array('selected_method_of_payment' => $selected_method_of_payment)
 		);
 	}
 
@@ -918,19 +918,19 @@ 
 		// load payment method classes
 		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
 		// switch up header depending on number of available payment methods
-		$payment_method_header = count( $this->checkout->available_payment_methods ) > 1
+		$payment_method_header = count($this->checkout->available_payment_methods) > 1
 			? apply_filters(
 				'FHEE__registration_page_payment_options__method_of_payment_hdr',
-				__( 'Please Select Your Method of Payment', 'event_espresso' )
+				__('Please Select Your Method of Payment', 'event_espresso')
 			)
 			: apply_filters(
 				'FHEE__registration_page_payment_options__method_of_payment_hdr',
-				__( 'Method of Payment', 'event_espresso' )
+				__('Method of Payment', 'event_espresso')
 			);
 		$available_payment_methods = array(
 			// display the "Payment Method" header
 			'payment_method_header' => new EE_Form_Section_HTML(
-				EEH_HTML::h4( $payment_method_header, 'method-of-payment-hdr' )
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
 			)
 		);
 		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
@@ -939,32 +939,32 @@ 
 		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
 		$payment_methods_billing_info = array(
 			new EE_Form_Section_HTML(
-				EEH_HTML::div( '<br />', '', '', 'clear:both;' )
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
 			)
 		);
 		// loop through payment methods
-		foreach ( $this->checkout->available_payment_methods as $payment_method ) {
-			if ( $payment_method instanceof EE_Payment_Method ) {
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
 				$payment_method_button = EEH_HTML::img(
 					$payment_method->button_url(),
 					$payment_method->name(),
-					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-'.$payment_method->slug().'-btn-img',
 					'spco-payment-method-btn-img'
 				);
 				// check if any payment methods are set as default
 				// if payment method is already selected OR nothing is selected and this payment method should be open_by_default
 				if (
-					( $this->checkout->selected_method_of_payment === $payment_method->slug() )
-					|| ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default() )
+					($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
 				) {
 					$this->checkout->selected_method_of_payment = $payment_method->slug();
 					$this->_save_selected_method_of_payment();
-					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
 				} else {
-					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+					$available_payment_method_options[$payment_method->slug()] = $payment_method_button;
 				}
-				$payment_methods_billing_info[ $payment_method->slug()
-				                               . '-info' ] = $this->_payment_method_billing_info(
+				$payment_methods_billing_info[$payment_method->slug()
+				                               . '-info'] = $this->_payment_method_billing_info(
 					$payment_method
 				);
 			}
@@ -994,12 +994,12 @@ 
 	 * @return EE_Payment_Method[]
 	 */
 	protected function _get_available_payment_methods() {
-		if ( ! empty( $this->checkout->available_payment_methods ) ) {
+		if ( ! empty($this->checkout->available_payment_methods)) {
 			return $this->checkout->available_payment_methods;
 		}
 		$available_payment_methods = array();
 		// load EEM_Payment_Method
-		EE_Registry::instance()->load_model( 'Payment_Method' );
+		EE_Registry::instance()->load_model('Payment_Method');
 		/** @type EEM_Payment_Method $EEM_Payment_Method */
 		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
 		// get all active payment methods
@@ -1007,9 +1007,9 @@ 
 			$this->checkout->transaction,
 			EEM_Payment_Method::scope_cart
 		);
-		foreach ( $payment_methods as $payment_method ) {
-			if ( $payment_method instanceof EE_Payment_Method ) {
-				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[$payment_method->slug()] = $payment_method;
 			}
 		}
 		return $available_payment_methods;
@@ -1024,14 +1024,14 @@ 
 	 * @param    array $available_payment_method_options
 	 * @return    \EE_Form_Section_Proper
 	 */
-	private function _available_payment_method_inputs( $available_payment_method_options = array() ) {
+	private function _available_payment_method_inputs($available_payment_method_options = array()) {
 		// generate inputs
 		return new EE_Form_Section_Proper(
 			array(
 				'html_id'         => 'ee-available-payment-method-inputs',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
-					'' => new EE_Radio_Button_Input (
+					'' => new EE_Radio_Button_Input(
 						$available_payment_method_options,
 						array(
 							'html_name'          => 'selected_method_of_payment',
@@ -1056,28 +1056,28 @@ 
 	 * @return    \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _payment_method_billing_info( EE_Payment_Method $payment_method ) {
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method) {
 		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
 			? true
 			: false;
 		// generate the billing form for payment method
 		$billing_form = $currently_selected
-			? $this->_get_billing_form_for_payment_method( $payment_method )
+			? $this->_get_billing_form_for_payment_method($payment_method)
 			: new EE_Form_Section_HTML();
 		$this->checkout->billing_form = $currently_selected
 			? $billing_form
 			: $this->checkout->billing_form;
 		// it's all in the details
 		$info_html = EEH_HTML::h3(
-			__( 'Important information regarding your payment', 'event_espresso' ),
+			__('Important information regarding your payment', 'event_espresso'),
 			'',
 			'spco-payment-method-hdr'
 		);
 		// add some info regarding the step, either from what's saved in the admin,
 		// or a default string depending on whether the PM has a billing form or not
-		if ( $payment_method->description() ) {
+		if ($payment_method->description()) {
 			$payment_method_info = $payment_method->description();
-		} elseif ( $billing_form instanceof EE_Billing_Info_Form ) {
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
 			$payment_method_info = sprintf(
 				__(
 					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
@@ -1087,7 +1087,7 @@ 
 			);
 		} else {
 			$payment_method_info = sprintf(
-				__( 'Please click the "%1$s" button below in order to proceed.', 'event_espresso' ),
+				__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
 				$this->submit_button_text()
 			);
 		}
@@ -1101,13 +1101,13 @@ 
 		);
 		return new EE_Form_Section_Proper(
 			array(
-				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
 				'html_class'      => 'spco-payment-method-info-dv',
 				// only display the selected or default PM
 				'html_style'      => $currently_selected ? '' : 'display:none;',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
-					'info'         => new EE_Form_Section_HTML( $info_html ),
+					'info'         => new EE_Form_Section_HTML($info_html),
 					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML()
 				)
 			)
@@ -1125,15 +1125,15 @@ 
 	 */
 	public function get_billing_form_html_for_payment_method() {
 		// how have they chosen to pay?
-		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
 			return false;
 		}
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 			false
-		) ) {
+		)) {
 			EE_Error::add_success(
 				apply_filters(
 					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
@@ -1148,7 +1148,7 @@ 
 			);
 		}
 		// now generate billing form for selected method of payment
-		$payment_method_billing_form = $this->_get_billing_form_for_payment_method( $this->checkout->payment_method );
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
 		// fill form with attendee info if applicable
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
@@ -1170,10 +1170,10 @@ 
 		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
 			? $payment_method_billing_form->get_html()
 			: '';
-		$this->checkout->json_response->set_return_data( array( 'payment_method_info' => $billing_info ) );
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
 		// localize validation rules for main form
 		$this->checkout->current_step->reg_form->localize_validation_rules();
-		$this->checkout->json_response->add_validation_rules( EE_Form_Section_Proper::js_localization() );
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
 		return true;
 	}
 
@@ -1187,18 +1187,18 @@ 
 	 * @return \EE_Billing_Info_Form|\EE_Form_Section_HTML
 	 * @throws \EE_Error
 	 */
-	private function _get_billing_form_for_payment_method( EE_Payment_Method $payment_method ) {
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method) {
 		$billing_form = $payment_method->type_obj()->billing_form(
 			$this->checkout->transaction,
-			array( 'amount_owing' => $this->checkout->amount_owing )
+			array('amount_owing' => $this->checkout->amount_owing)
 		);
-		if ( $billing_form instanceof EE_Billing_Info_Form ) {
+		if ($billing_form instanceof EE_Billing_Info_Form) {
 			if (
 				apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 					false
 				)
-				&& EE_Registry::instance()->REQ->is_set( 'payment_method' )
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
 			) {
 				EE_Error::add_success(
 					apply_filters(
@@ -1240,15 +1240,15 @@ 
 		$request_param = 'selected_method_of_payment'
 	) {
 		// is selected_method_of_payment set in the request ?
-		$selected_method_of_payment = EE_Registry::instance()->REQ->get( $request_param, false );
-		if ( $selected_method_of_payment ) {
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
+		if ($selected_method_of_payment) {
 			// sanitize it
-			$selected_method_of_payment = is_array( $selected_method_of_payment )
-				? array_shift( $selected_method_of_payment )
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
 				: $selected_method_of_payment;
-			$selected_method_of_payment = sanitize_text_field( $selected_method_of_payment );
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
 			// store it in the session so that it's available for all subsequent requests including AJAX
-			$this->_save_selected_method_of_payment( $selected_method_of_payment );
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
 		} else {
 			// or is is set in the session ?
 			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
@@ -1256,7 +1256,7 @@ 
 			);
 		}
 		// do ya really really gotta have it?
-		if ( empty( $selected_method_of_payment ) && $required ) {
+		if (empty($selected_method_of_payment) && $required) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1265,7 +1265,7 @@ 
 					),
 					'<br/>',
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1292,13 +1292,13 @@ 
 	 * @throws \EE_Error
 	 */
 	public function switch_payment_method() {
-		if ( ! $this->_verify_payment_method_is_set() ) {
+		if ( ! $this->_verify_payment_method_is_set()) {
 			return false;
 		}
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 			false
-		) ) {
+		)) {
 			EE_Error::add_success(
 				apply_filters(
 					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
@@ -1313,7 +1313,7 @@ 
 			);
 		}
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
@@ -1335,7 +1335,7 @@ 
 			);
 		}
 		// and debug content
-		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
 		     && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$this->checkout->billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
@@ -1343,15 +1343,15 @@ 
 			);
 		}
 		// get html and validation rules for form
-		if ( $this->checkout->billing_form instanceof EE_Form_Section_Proper ) {
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
 			$this->checkout->json_response->set_return_data(
-				array( 'payment_method_info' => $this->checkout->billing_form->get_html() )
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
 			);
 			// localize validation rules for main form
-			$this->checkout->billing_form->localize_validation_rules( true );
-			$this->checkout->json_response->add_validation_rules( EE_Form_Section_Proper::js_localization() );
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
 		} else {
-			$this->checkout->json_response->set_return_data( array( 'payment_method_info' => '' ) );
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
 		}
 		//prevents advancement to next step
 		$this->checkout->continue_reg = false;
@@ -1368,18 +1368,18 @@ 
 	 */
 	protected function _verify_payment_method_is_set() {
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			// how have they chosen to pay?
-			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		} else {
 			// choose your own adventure based on method_of_payment
-			switch ( $this->checkout->selected_method_of_payment ) {
+			switch ($this->checkout->selected_method_of_payment) {
 				case 'events_sold_out' :
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-							__( 'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
-								'event_espresso' )
+							__('It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
+								'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1389,7 +1389,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-							__( 'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.', 'event_espresso' )
+							__('It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.', 'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1399,7 +1399,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-							__( 'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.', 'event_espresso' )
+							__('It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.', 'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1409,7 +1409,7 @@ 
 			}
 		}
 		// verify payment method
-		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
 			// get payment method for selected method of payment
 			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
 		}
@@ -1428,25 +1428,25 @@ 
 	 * @throws \EE_Error
 	 */
 	public function save_payer_details_via_ajax() {
-		if ( ! $this->_verify_payment_method_is_set() ) {
+		if ( ! $this->_verify_payment_method_is_set()) {
 			return;
 		}
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
 		}
 		// generate primary attendee from payer info if applicable
-		if ( ! $this->checkout->transaction_has_primary_registrant() ) {
+		if ( ! $this->checkout->transaction_has_primary_registrant()) {
 			$attendee = $this->_create_attendee_from_request_data();
-			if ( $attendee instanceof EE_Attendee ) {
-				foreach ( $this->checkout->transaction->registrations() as $registration ) {
-					if ( $registration->is_primary_registrant() ) {
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
 						$this->checkout->primary_attendee_obj = $attendee;
-						$registration->_add_relation_to( $attendee, 'Attendee' );
-						$registration->set_attendee_id( $attendee->ID() );
-						$registration->update_cache_after_object_save( 'Attendee', $attendee );
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
 					}
 				}
 			}
@@ -1464,50 +1464,50 @@ 
 	 */
 	protected function _create_attendee_from_request_data() {
 		// get State ID
-		$STA_ID = ! empty( $_REQUEST['state'] ) ? sanitize_text_field( $_REQUEST['state'] ) : '';
-		if ( ! empty( $STA_ID ) ) {
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if ( ! empty($STA_ID)) {
 			// can we get state object from name ?
-			EE_Registry::instance()->load_model( 'State' );
-			$state = EEM_State::instance()->get_col( array( array( 'STA_name' => $STA_ID ), 'limit' => 1 ), 'STA_ID' );
-			$STA_ID = is_array( $state ) && ! empty( $state ) ? reset( $state ) : $STA_ID;
+			EE_Registry::instance()->load_model('State');
+			$state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
 		}
 		// get Country ISO
-		$CNT_ISO = ! empty( $_REQUEST['country'] ) ? sanitize_text_field( $_REQUEST['country'] ) : '';
-		if ( ! empty( $CNT_ISO ) ) {
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if ( ! empty($CNT_ISO)) {
 			// can we get country object from name ?
-			EE_Registry::instance()->load_model( 'Country' );
+			EE_Registry::instance()->load_model('Country');
 			$country = EEM_Country::instance()->get_col(
-				array( array( 'CNT_name' => $CNT_ISO ), 'limit' => 1 ),
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
 				'CNT_ISO'
 			);
-			$CNT_ISO = is_array( $country ) && ! empty( $country ) ? reset( $country ) : $CNT_ISO;
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
 		}
 		// grab attendee data
 		$attendee_data = array(
-			'ATT_fname'    => ! empty( $_REQUEST['first_name'] ) ? sanitize_text_field( $_REQUEST['first_name'] ) : '',
-			'ATT_lname'    => ! empty( $_REQUEST['last_name'] ) ? sanitize_text_field( $_REQUEST['last_name'] ) : '',
-			'ATT_email'    => ! empty( $_REQUEST['email'] ) ? sanitize_email( $_REQUEST['email'] ) : '',
-			'ATT_address'  => ! empty( $_REQUEST['address'] ) ? sanitize_text_field( $_REQUEST['address'] ) : '',
-			'ATT_address2' => ! empty( $_REQUEST['address2'] ) ? sanitize_text_field( $_REQUEST['address2'] ) : '',
-			'ATT_city'     => ! empty( $_REQUEST['city'] ) ? sanitize_text_field( $_REQUEST['city'] ) : '',
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
 			'STA_ID'       => $STA_ID,
 			'CNT_ISO'      => $CNT_ISO,
-			'ATT_zip'      => ! empty( $_REQUEST['zip'] ) ? sanitize_text_field( $_REQUEST['zip'] ) : '',
-			'ATT_phone'    => ! empty( $_REQUEST['phone'] ) ? sanitize_text_field( $_REQUEST['phone'] ) : '',
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
 		);
 		// validate the email address since it is the most important piece of info
-		if ( empty( $attendee_data['ATT_email'] ) || $attendee_data['ATT_email'] !== $_REQUEST['email'] ) {
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
 			EE_Error::add_error(
-				__( 'An invalid email address was submitted.', 'event_espresso' ),
+				__('An invalid email address was submitted.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
 			);
 		}
 		// does this attendee already exist in the db ? we're searching using a combination of first name, last name, AND email address
-		if ( ! empty( $attendee_data['ATT_fname'] )
-		     && ! empty( $attendee_data['ATT_lname'] )
-		     && ! empty( $attendee_data['ATT_email'] )
+		if ( ! empty($attendee_data['ATT_fname'])
+		     && ! empty($attendee_data['ATT_lname'])
+		     && ! empty($attendee_data['ATT_email'])
 		) {
 			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
 				array(
@@ -1516,19 +1516,19 @@ 
 					'ATT_email' => $attendee_data['ATT_email']
 				)
 			);
-			if ( $existing_attendee instanceof EE_Attendee ) {
+			if ($existing_attendee instanceof EE_Attendee) {
 				return $existing_attendee;
 			}
 		}
 		// no existing attendee? kk let's create a new one
 		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those don't exist
-		$attendee_data['ATT_fname'] = ! empty( $attendee_data['ATT_fname'] )
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
 			? $attendee_data['ATT_fname']
 			: $attendee_data['ATT_email'];
-		$attendee_data['ATT_lname'] = ! empty( $attendee_data['ATT_lname'] )
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
 			? $attendee_data['ATT_lname']
 			: $attendee_data['ATT_email'];
-		return EE_Attendee::new_instance( $attendee_data );
+		return EE_Attendee::new_instance($attendee_data);
 	}
 
 
@@ -1546,26 +1546,26 @@ 
 		// how have they chosen to pay?
 		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
 			? 'no_payment_required'
-			: $this->_get_selected_method_of_payment( true );
+			: $this->_get_selected_method_of_payment(true);
 		// choose your own adventure based on method_of_payment
-		switch ( $this->checkout->selected_method_of_payment ) {
+		switch ($this->checkout->selected_method_of_payment) {
 
 			case 'events_sold_out' :
 				$this->checkout->redirect = true;
 				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
-				$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 				// mark this reg step as completed
 				$this->set_completed();
 				return false;
 				break;
 
 			case 'payments_closed' :
-				if ( apply_filters(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required at this time.', 'event_espresso' ),
+						__('no payment required at this time.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1577,12 +1577,12 @@ 
 				break;
 
 			case 'no_payment_required' :
-				if ( apply_filters(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required.', 'event_espresso' ),
+						__('no payment required.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1602,15 +1602,15 @@ 
 					EE_Registry::instance()->SSN->checkout()->revisit
 				);
 				// calculate difference between the two arrays
-				$registrations = array_diff( $registrations, $ejected_registrations );
-				if ( empty( $registrations ) ) {
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
 					$this->_redirect_because_event_sold_out();
 					return false;
 				}
 				$payment_successful = $this->_process_payment();
-				if ( $payment_successful ) {
+				if ($payment_successful) {
 					$this->checkout->continue_reg = true;
-					$this->_maybe_set_completed( $this->checkout->payment_method );
+					$this->_maybe_set_completed($this->checkout->payment_method);
 				} else {
 					$this->checkout->continue_reg = false;
 				}
@@ -1631,10 +1631,10 @@ 
 		$this->checkout->continue_reg = false;
 		// set redirect URL
 		$this->checkout->redirect_url = add_query_arg(
-			array( 'e_reg_url_link' => $this->checkout->reg_url_link ),
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
 			$this->checkout->current_step->reg_step_url()
 		);
-		$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 	}
 
 
@@ -1647,8 +1647,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _maybe_set_completed( EE_Payment_Method $payment_method ) {
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method) {
+		switch ($payment_method->type_obj()->payment_occurs()) {
 			case EE_PMT_Base::offsite :
 				break;
 			case EE_PMT_Base::onsite :
@@ -1671,7 +1671,7 @@ 
 	public function update_reg_step() {
 		$success = true;
 		// if payment required
-		if ( $this->checkout->transaction->total() > 0 ) {
+		if ($this->checkout->transaction->total() > 0) {
 			do_action(
 				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
 				$this->checkout->transaction
@@ -1679,13 +1679,13 @@ 
 			// attempt payment via payment method
 			$success = $this->process_reg_step();
 		}
-		if ( $success && ! $this->checkout->redirect ) {
+		if ($success && ! $this->checkout->redirect) {
 			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
 				$this->checkout->transaction->ID()
 			);
 			// set return URL
 			$this->checkout->redirect_url = add_query_arg(
-				array( 'e_reg_url_link' => $this->checkout->reg_url_link ),
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
 				$this->checkout->thank_you_page_url
 			);
 		}
@@ -1703,36 +1703,36 @@ 
 	 */
 	private function _process_payment() {
 		// basically confirm that the event hasn't sold out since they hit the page
-		if ( ! $this->_last_second_ticket_verifications() ) {
+		if ( ! $this->_last_second_ticket_verifications()) {
 			return false;
 		}
 		// ya gotta make a choice man
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$this->checkout->json_response->set_plz_select_method_of_payment(
-				__( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				__('Please select a method of payment before proceeding.', 'event_espresso')
 			);
 			return false;
 		}
 		// get EE_Payment_Method object
-		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment() ) {
+		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
 			return false;
 		}
 		// setup billing form
-		if ( $this->checkout->payment_method->is_on_site() ) {
+		if ($this->checkout->payment_method->is_on_site()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
 			// bad billing form ?
-			if ( ! $this->_billing_form_is_valid() ) {
+			if ( ! $this->_billing_form_is_valid()) {
 				return false;
 			}
 		}
 		// ensure primary registrant has been fully processed
-		if ( ! $this->_setup_primary_registrant_prior_to_payment() ) {
+		if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
 			return false;
 		}
 		// if session is close to expiring (under 10 minutes by default)
-		if ( ( time() - EE_Registry::instance()->SSN->expiration() ) < EE_Registry::instance()->SSN->extension() ) {
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
 			// add some time to session expiration so that payment can be completed
 			EE_Registry::instance()->SSN->extend_expiration();
 		}
@@ -1741,12 +1741,12 @@ 
 		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations for events with a default reg status of Approved
 		//$transaction_processor->toggle_registration_statuses_for_default_approved_events( $this->checkout->transaction, $this->checkout->reg_cache_where_params );
 		// attempt payment
-		$payment = $this->_attempt_payment( $this->checkout->payment_method );
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
 		// process results
-		$payment = $this->_validate_payment( $payment );
-		$payment = $this->_post_payment_processing( $payment );
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
 		// verify payment
-		if ( $payment instanceof EE_Payment ) {
+		if ($payment instanceof EE_Payment) {
 			// store that for later
 			$this->checkout->payment = $payment;
 			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
@@ -1760,7 +1760,7 @@ 
 			} else {
 				return false;
 			}
-		} else if ( $payment === true ) {
+		} else if ($payment === true) {
 			// please note that offline payment methods will NOT make a payment,
 			// but instead just mark themselves as the PMD_ID on the transaction, and return true
 			$this->checkout->payment = $payment;
@@ -1780,22 +1780,22 @@ 
 	 */
 	protected function _last_second_ticket_verifications() {
 		// don't bother re-validating if not a return visit
-		if ( ! $this->checkout->revisit ) {
+		if ( ! $this->checkout->revisit) {
 			return true;
 		}
 		$registrations = $this->checkout->transaction->registrations();
-		if ( empty( $registrations ) ) {
+		if (empty($registrations)) {
 			return false;
 		}
-		foreach ( $registrations as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
 				$event = $registration->event_obj();
-				if ( $event instanceof EE_Event && $event->is_sold_out( true ) ) {
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
 					EE_Error::add_error(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
 							sprintf(
-								__( 'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.', 'event_espresso' ),
+								__('It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.', 'event_espresso'),
 								$event->name()
 							)
 						),
@@ -1825,7 +1825,7 @@ 
 		);
 		$html = $payment_method_billing_info->get_html();
 		$html .= $this->checkout->redirect_form;
-		EE_Registry::instance()->REQ->add_output( $html );
+		EE_Registry::instance()->REQ->add_output($html);
 		return true;
 	}
 
@@ -1839,28 +1839,28 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _billing_form_is_valid() {
-		if ( ! $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
 			return true;
 		}
-		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form ) {
-			if ( $this->checkout->billing_form->was_submitted() ) {
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
 				$this->checkout->billing_form->receive_form_submission();
-				if ( $this->checkout->billing_form->is_valid() ) {
+				if ($this->checkout->billing_form->is_valid()) {
 					return true;
 				}
 				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
 				$error_strings = array();
-				foreach ( $validation_errors as $validation_error ) {
-					if ( $validation_error instanceof EE_Validation_Error ) {
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
 						$form_section = $validation_error->get_form_section();
-						if ( $form_section instanceof EE_Form_Input_Base ) {
+						if ($form_section instanceof EE_Form_Input_Base) {
 							$label = $form_section->html_label_text();
-						} elseif ( $form_section instanceof EE_Form_Section_Base ) {
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
 							$label = $form_section->name();
 						} else {
-							$label = __( 'Validation Error', 'event_espresso' );
+							$label = __('Validation Error', 'event_espresso');
 						}
-						$error_strings[] = sprintf( '%1$s: %2$s', $label, $validation_error->getMessage() );
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
 					}
 				}
 				EE_Error::add_error(
@@ -1870,7 +1870,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						implode( '<br/>', $error_strings )
+						implode('<br/>', $error_strings)
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -1889,7 +1889,7 @@ 
 			}
 		} else {
 			EE_Error::add_error(
-				__( 'The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso' ),
+				__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -1928,7 +1928,7 @@ 
 		// save the TXN ( which clears cached copy of primary_registration)
 		$this->checkout->transaction->save();
 		// grab TXN ID and save it to the primary_registration
-		$primary_registration->set_transaction_id( $this->checkout->transaction->ID() );
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
 		// save what we have so far
 		$primary_registration->save();
 		return true;
@@ -1946,7 +1946,7 @@ 
 	private function _capture_primary_registration_data_from_billing_form() {
 		// convert billing form data into an attendee
 		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-		if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee ) {
+		if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1954,7 +1954,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1963,7 +1963,7 @@ 
 			return false;
 		}
 		$primary_registration = $this->checkout->transaction->primary_registration();
-		if ( ! $primary_registration instanceof EE_Registration ) {
+		if ( ! $primary_registration instanceof EE_Registration) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1971,7 +1971,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1979,7 +1979,7 @@ 
 			);
 			return false;
 		}
-		if ( ! $primary_registration->_add_relation_to( $this->checkout->primary_attendee_obj, 'Attendee' )
+		if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
 		       instanceof
 		       EE_Attendee
 		) {
@@ -1990,7 +1990,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1999,9 +1999,9 @@ 
 			return false;
 		}
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-		$registration_processor->toggle_incomplete_registration_status_to_default( $primary_registration );
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
 		return true;
 	}
 
@@ -2016,22 +2016,22 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _get_payment_method_for_selected_method_of_payment() {
-		if ( $this->checkout->selected_method_of_payment === 'events_sold_out' ) {
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
 			$this->_redirect_because_event_sold_out();
 			return null;
 		}
 		// get EE_Payment_Method object
-		if ( isset( $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ] ) ) {
-			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
+		if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+			$payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
 		} else {
 			// load EEM_Payment_Method
-			EE_Registry::instance()->load_model( 'Payment_Method' );
+			EE_Registry::instance()->load_model('Payment_Method');
 			/** @type EEM_Payment_Method $EEM_Payment_Method */
 			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-			$payment_method = $EEM_Payment_Method->get_one_by_slug( $this->checkout->selected_method_of_payment );
+			$payment_method = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
 		}
 		// verify $payment_method
-		if ( ! $payment_method instanceof EE_Payment_Method ) {
+		if ( ! $payment_method instanceof EE_Payment_Method) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2040,7 +2040,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2049,7 +2049,7 @@ 
 			return null;
 		}
 		// and verify it has a valid Payment_Method Type object
-		if ( ! $payment_method->type_obj() instanceof EE_PMT_Base ) {
+		if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2058,7 +2058,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2079,29 +2079,29 @@ 
 	 * @return    mixed    EE_Payment | boolean
 	 * @throws \EE_Error
 	 */
-	private function _attempt_payment( EE_Payment_Method $payment_method ) {
+	private function _attempt_payment(EE_Payment_Method $payment_method) {
 		$payment = null;
 		$this->checkout->transaction->save();
-		$payment_processor = EE_Registry::instance()->load_core( 'Payment_Processor' );
-		if ( ! $payment_processor instanceof EE_Payment_Processor ) {
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if ( ! $payment_processor instanceof EE_Payment_Processor) {
 			return false;
 		}
 		try {
-			$payment_processor->set_revisit( $this->checkout->revisit );
+			$payment_processor->set_revisit($this->checkout->revisit);
 			// generate payment object
 			$payment = $payment_processor->process_payment(
 				$payment_method,
 				$this->checkout->transaction,
 				$this->checkout->amount_owing,
 				$this->checkout->billing_form,
-				$this->_get_return_url( $payment_method ),
+				$this->_get_return_url($payment_method),
 				'CART',
 				$this->checkout->admin_request,
 				true,
 				$this->reg_step_url()
 			);
-		} catch ( Exception $e ) {
-			$this->_handle_payment_processor_exception( $e );
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
 		}
 		return $payment;
 	}
@@ -2116,7 +2116,7 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _handle_payment_processor_exception( Exception $e ) {
+	protected function _handle_payment_processor_exception(Exception $e) {
 		EE_Error::add_error(
 			sprintf(
 				__(
@@ -2124,7 +2124,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' ),
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
 				$e->getMessage(),
 				$e->getFile(),
 				$e->getLine()
@@ -2145,9 +2145,9 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _get_return_url( EE_Payment_Method $payment_method ) {
+	protected function _get_return_url(EE_Payment_Method $payment_method) {
 		$return_url = '';
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+		switch ($payment_method->type_obj()->payment_occurs()) {
 			case EE_PMT_Base::offsite :
 				$return_url = add_query_arg(
 					array(
@@ -2176,12 +2176,12 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _validate_payment( $payment = null ) {
-		if ( $this->checkout->payment_method->is_off_line() ) {
+	private function _validate_payment($payment = null) {
+		if ($this->checkout->payment_method->is_off_line()) {
 			return true;
 		}
 		// verify payment object
-		if ( ! $payment instanceof EE_Payment ) {
+		if ( ! $payment instanceof EE_Payment) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2190,7 +2190,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2211,27 +2211,27 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _post_payment_processing( $payment = null ) {
+	private function _post_payment_processing($payment = null) {
 		// Off-Line payment?
-		if ( $payment === true ) {
+		if ($payment === true) {
 			//$this->_setup_redirect_for_next_step();
 			return true;
 		// On-Site payment?
-		} else if ( $this->checkout->payment_method->is_on_site() ) {
-			if ( ! $this->_process_payment_status( $payment, EE_PMT_Base::onsite ) ) {
+		} else if ($this->checkout->payment_method->is_on_site()) {
+			if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
 				//$this->_setup_redirect_for_next_step();
 				$this->checkout->continue_reg = false;
 			}
 		// Off-Site payment?
-		} else if ( $this->checkout->payment_method->is_off_site() ) {
+		} else if ($this->checkout->payment_method->is_off_site()) {
 			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-			if ( $payment instanceof EE_Payment && $payment->redirect_url() ) {
-				do_action( 'AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()' );
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
 				$this->checkout->redirect = true;
 				$this->checkout->redirect_form = $payment->redirect_form();
-				$this->checkout->redirect_url = $this->reg_step_url( 'redirect_form' );
+				$this->checkout->redirect_url = $this->reg_step_url('redirect_form');
 				// set JSON response
-				$this->checkout->json_response->set_redirect_form( $this->checkout->redirect_form );
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
 				// set cron job for finalizing the TXN
 				// in case the user does not return from the off-site gateway
 				EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
@@ -2239,7 +2239,7 @@ 
 					$this->checkout->transaction->ID()
 				);
 				// and lastly, let's bump the payment status to pending
-				$payment->set_status( EEM_Payment::status_id_pending );
+				$payment->set_status(EEM_Payment::status_id_pending);
 				$payment->save();
 			} else {
 				// not a payment
@@ -2251,7 +2251,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -2289,21 +2289,21 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _process_payment_status( $payment, $payment_occurs = EE_PMT_Base::offline ) {
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline) {
 		// off-line payment? carry on
-		if ( $payment_occurs === EE_PMT_Base::offline ) {
+		if ($payment_occurs === EE_PMT_Base::offline) {
 			return true;
 		}
 		// verify payment validity
-		if ( $payment instanceof EE_Payment ) {
-			do_action( 'AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()' );
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
 			$msg = $payment->gateway_response();
 			// check results
-			switch ( $payment->status() ) {
+			switch ($payment->status()) {
 				// good payment
 				case EEM_Payment::status_id_approved :
 					EE_Error::add_success(
-						__( 'Your payment was processed successfully.', 'event_espresso' ),
+						__('Your payment was processed successfully.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -2312,45 +2312,45 @@ 
 					break;
 				// slow payment
 				case EEM_Payment::status_id_pending :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = __(
 							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
 							'event_espresso'
 						);
 					}
-					EE_Error::add_success( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
 					return true;
 					break;
 				// don't wanna payment
 				case EEM_Payment::status_id_cancelled :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = _n(
 							'Payment cancelled. Please try again.',
 							'Payment cancelled. Please try again or select another method of payment.',
-							count( $this->checkout->available_payment_methods ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
 					return false;
 					break;
 				// not enough payment
 				case EEM_Payment::status_id_declined :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = _n(
 							'We\'re sorry but your payment was declined. Please try again.',
 							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-							count( $this->checkout->available_payment_methods ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
 					return false;
 					break;
 				// bad payment
 				case EEM_Payment::status_id_failed :
-					if ( ! empty( $msg ) ) {
-						EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					if ( ! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 						return false;
 					}
 					// default to error below
@@ -2359,7 +2359,7 @@ 
 		}
 		// off-site payment gateway responses are too unreliable, so let's just assume that
 		// the payment processing is just running slower than the registrant's request
-		if ( $payment_occurs === EE_PMT_Base::offsite ) {
+		if ($payment_occurs === EE_PMT_Base::offsite) {
 			return true;
 		}
 		EE_Error::add_error(
@@ -2369,7 +2369,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
 			),
 			__FILE__,
 			__FUNCTION__,
@@ -2402,13 +2402,13 @@ 
 	public function process_gateway_response() {
 		$payment = null;
 		// how have they chosen to pay?
-		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		// get EE_Payment_Method object
-		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment() ) {
+		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
 			$this->checkout->continue_reg = false;
 			return false;
 		}
-		if ( ! $this->checkout->payment_method->is_off_site() ) {
+		if ( ! $this->checkout->payment_method->is_off_site()) {
 			return false;
 		}
 		$this->_validate_offsite_return();
@@ -2422,23 +2422,23 @@ 
 		//	true
 		//);
 		// verify TXN
-		if ( $this->checkout->transaction instanceof EE_Transaction ) {
+		if ($this->checkout->transaction instanceof EE_Transaction) {
 			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-			if ( ! $gateway instanceof EE_Offsite_Gateway ) {
+			if ( ! $gateway instanceof EE_Offsite_Gateway) {
 				$this->checkout->continue_reg = false;
 				return false;
 			}
-			$payment = $this->_process_off_site_payment( $gateway );
-			$payment = $this->_process_cancelled_payments( $payment );
-			$payment = $this->_validate_payment( $payment );
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
 			// if payment was not declined by the payment gateway or cancelled by the registrant
-			if ( $this->_process_payment_status( $payment, EE_PMT_Base::offsite ) ) {
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
 				//$this->_setup_redirect_for_next_step();
 				// store that for later
 				$this->checkout->payment = $payment;
 				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
 				// because we will complete this step during the IPN processing then
-				if ( $gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request() ) {
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
 					$this->set_completed();
 				}
 				return true;
@@ -2463,21 +2463,21 @@ 
      * @throws \EE_Error
      */
 	private function _validate_offsite_return() {
-		$TXN_ID = (int)EE_Registry::instance()->REQ->get( 'spco_txn', 0 );
-		if ( $TXN_ID !== $this->checkout->transaction->ID() ) {
+		$TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
 			// Houston... we might have a problem
 			$invalid_TXN = false;
 			// first gather some info
-			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID( $TXN_ID );
+			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
 			$primary_registrant = $valid_TXN instanceof EE_Transaction
 				? $valid_TXN->primary_registration()
 				: null;
 			// let's start by retrieving the cart for this TXN
-			$cart = $this->checkout->get_cart_for_transaction( $this->checkout->transaction );
-			if ( $cart instanceof EE_Cart ) {
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
 				// verify that the current cart has tickets
 				$tickets = $cart->get_tickets();
-				if ( empty( $tickets ) ) {
+				if (empty($tickets)) {
 					$invalid_TXN = true;
 				}
 			} else {
@@ -2503,21 +2503,21 @@ 
             ) {
 				$invalid_TXN = true;
 			}
-			if ( $invalid_TXN ) {
+			if ($invalid_TXN) {
 				// is the valid TXN completed ?
-				if ( $valid_TXN instanceof EE_Transaction ) {
+				if ($valid_TXN instanceof EE_Transaction) {
 					// has this step even been started ?
-					$reg_step_completed = $valid_TXN->reg_step_completed( $this->slug() );
-					if ( $reg_step_completed !== false && $reg_step_completed !== true ) {
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
 						// so it **looks** like this is a double request from PayPal
 						// so let's try to pick up where we left off
 						$this->checkout->transaction = $valid_TXN;
-						$this->checkout->refresh_all_entities( true );
+						$this->checkout->refresh_all_entities(true);
 						return;
 					}
 				}
 				// you appear to be lost?
-				$this->_redirect_wayward_request( $primary_registrant );
+				$this->_redirect_wayward_request($primary_registrant);
 			}
 		}
 	}
@@ -2532,14 +2532,14 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _redirect_wayward_request( EE_Registration $primary_registrant ) {
-		if ( ! $primary_registrant instanceof EE_Registration ) {
+	private function _redirect_wayward_request(EE_Registration $primary_registrant) {
+		if ( ! $primary_registrant instanceof EE_Registration) {
 			// try redirecting based on the current TXN
 			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
 				? $this->checkout->transaction->primary_registration()
 				: null;
 		}
-		if ( ! $primary_registrant instanceof EE_Registration ) {
+		if ( ! $primary_registrant instanceof EE_Registration) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -2547,7 +2547,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2578,17 +2578,17 @@ 
 	 * @return \EE_Payment
 	 * @throws \EE_Error
 	 */
-	private function _process_off_site_payment( EE_Offsite_Gateway $gateway ) {
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway) {
 		try {
 			$request_data = \EE_Registry::instance()->REQ->params();
 			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
 			$this->set_handle_IPN_in_this_request(
-				$gateway->handle_IPN_in_this_request( $request_data, false )
+				$gateway->handle_IPN_in_this_request($request_data, false)
 			);
-			if ( $this->handle_IPN_in_this_request() ) {
+			if ($this->handle_IPN_in_this_request()) {
 				// get payment details and process results
 				/** @type EE_Payment_Processor $payment_processor */
-				$payment_processor = EE_Registry::instance()->load_core( 'Payment_Processor' );
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
 				$payment = $payment_processor->process_ipn(
 					$request_data,
 					$this->checkout->transaction,
@@ -2601,14 +2601,14 @@ 
 				$payment = $this->checkout->transaction->last_payment();
 				//$payment_source = 'last_payment';
 			}
-		} catch ( Exception $e ) {
+		} catch (Exception $e) {
 			// let's just eat the exception and try to move on using any previously set payment info
 			$payment = $this->checkout->transaction->last_payment();
 			//$payment_source = 'last_payment after Exception';
 			// but if we STILL don't have a payment object
-			if ( ! $payment instanceof EE_Payment ) {
+			if ( ! $payment instanceof EE_Payment) {
 				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-				$this->_handle_payment_processor_exception( $e );
+				$this->_handle_payment_processor_exception($e);
 			}
 		}
 		// DEBUG LOG
@@ -2633,13 +2633,13 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _process_cancelled_payments( $payment = null ) {
+	private function _process_cancelled_payments($payment = null) {
 		if (
 			$payment instanceof EE_Payment
-			&& isset( $_REQUEST['ee_cancel_payment'] )
+			&& isset($_REQUEST['ee_cancel_payment'])
 			&& $payment->status() === EEM_Payment::status_id_failed
 		) {
-			$payment->set_status( EEM_Payment::status_id_cancelled );
+			$payment->set_status(EEM_Payment::status_id_cancelled);
 		}
 		return $payment;
 	}
@@ -2656,14 +2656,14 @@ 
 	public function get_transaction_details_for_gateways() {
 		$txn_details = array();
 		// ya gotta make a choice man
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$txn_details = array(
-				'error' => __( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				'error' => __('Please select a method of payment before proceeding.', 'event_espresso')
 			);
 		}
 		// get EE_Payment_Method object
 		if (
-			empty( $txn_details )
+			empty($txn_details)
 			&&
 			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
 		) {
@@ -2675,8 +2675,8 @@ 
 				)
 			);
 		}
-		if ( empty( $txn_details ) && $this->checkout->transaction instanceof EE_Transaction ) {
-			$return_url = $this->_get_return_url( $this->checkout->payment_method );
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url = $this->_get_return_url($this->checkout->payment_method);
 			$txn_details = array(
 				'TXN_ID'         => $this->checkout->transaction->ID(),
 				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
@@ -2687,7 +2687,7 @@ 
 				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
 				'payment_amount' => $this->checkout->amount_owing,
 				'return_url'     => $return_url,
-				'cancel_url'     => add_query_arg( array( 'ee_cancel_payment' => true ), $return_url ),
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
 				'notify_url'     => EE_Config::instance()->core->txn_page_url(
 					array(
 						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
@@ -2696,7 +2696,7 @@ 
 				)
 			);
 		}
-		echo wp_json_encode( $txn_details );
+		echo wp_json_encode($txn_details);
 		exit();
 	}
 
@@ -2713,7 +2713,7 @@ 
     public function __sleep()
     {
         // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
+        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
     }
 
 

core/EE_Capabilities.core.php

Indentation +1175 added lines, -1175 removed lines

@@ -17,800 +17,800 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    /**
-     * instance of EE_Capabilities object
-     *
-     * @var EE_Capabilities
-     */
-    private static $_instance;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    private $_caps_map = array();
-
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects that define the granular capabilities mapped to for
-     * a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private $_meta_caps = array();
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @since 4.5.0
-     *
-     * @return EE_Capabilities
-     */
-    public static function instance()
-    {
-        //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     *
-     * @return \EE_Capabilities
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     *
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    public function init_caps($reset = false)
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->_caps_map = $this->_init_caps_map();
-            $this->init_role_caps($reset);
-            $this->_set_meta_caps();
-        }
-    }
-
-
-    /**
-     * This sets the meta caps property.
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_meta_caps()
-    {
-        //make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        $this->_meta_caps = $this->_get_default_meta_caps_array();
-        $this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
-        //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
-            add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
-        }
-    }
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @since  4.8.28.rc.012
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _get_default_meta_caps_array()
-    {
-        static $default_meta_caps = array();
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = array(
-                //edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    array('Registration', '', 'ee_edit_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    array('Registration', '', 'ee_edit_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    array('Ticket', '', 'ee_edit_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    array('Question', '', '', 'ee_edit_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    array('Question_Group', '', '', 'ee_edit_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
-                ),
-                //reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    array('Registration', '', '', 'ee_edit_others_registrations')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    array('Registration', '', '', 'ee_read_others_checkins')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    array('Ticket', '', '', 'ee_read_others_default_tickets')
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
-
-                //deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    array(
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    array(
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    )
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    array('Registration', '', 'ee_delete_others_registrations', '')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    array('Registration', '', 'ee_delete_others_checkins', '')
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    array('Ticket', '', 'ee_delete_others_default_tickets', '')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    array('Question', '', '', 'delete_system_questions')
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    array('Question_Group', '', '', 'delete_system_question_groups')
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
-                ),
-            );
-        }
-        return $default_meta_caps;
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            //loop through our _meta_caps array
-            foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                    continue;
-                }
-                // don't load models if there is no object ID in the args
-                if(!empty($args[0])){
-                    $meta_map->ensure_is_model();
-                }
-                $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-            }
-        }
-        return $caps;
-    }
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    private function _init_caps_map()
-    {
-        $caps = array(
-            'administrator'           => array(
-                //basic access
-                'ee_read_ee',
-                //gateways
-                /**
-                 * note that with payment method capabilities, although we've implemented
-                 * capability mapping which will be used for accessing payment methods owned by
-                 * other users.  This is not fully implemented yet in the payment method ui.
-                 * Currently only the "plural" caps are in active use.
-                 * (Specific payment method caps are in use as well).
-                 **/
-                'ee_manage_gateways',
-                'ee_read_payment_method',
-                'ee_read_payment_methods',
-                'ee_read_others_payment_methods',
-                'ee_edit_payment_method',
-                'ee_edit_payment_methods',
-                'ee_edit_others_payment_methods',
-                'ee_delete_payment_method',
-                'ee_delete_payment_methods',
-                //events
-                'ee_publish_events',
-                'ee_read_private_events',
-                'ee_read_others_events',
-                'ee_read_event',
-                'ee_read_events',
-                'ee_edit_event',
-                'ee_edit_events',
-                'ee_edit_published_events',
-                'ee_edit_others_events',
-                'ee_edit_private_events',
-                'ee_delete_published_events',
-                'ee_delete_private_events',
-                'ee_delete_event',
-                'ee_delete_events',
-                'ee_delete_others_events',
-                //event categories
-                'ee_manage_event_categories',
-                'ee_edit_event_category',
-                'ee_delete_event_category',
-                'ee_assign_event_category',
-                //venues
-                'ee_publish_venues',
-                'ee_read_venue',
-                'ee_read_venues',
-                'ee_read_others_venues',
-                'ee_read_private_venues',
-                'ee_edit_venue',
-                'ee_edit_venues',
-                'ee_edit_others_venues',
-                'ee_edit_published_venues',
-                'ee_edit_private_venues',
-                'ee_delete_venue',
-                'ee_delete_venues',
-                'ee_delete_others_venues',
-                'ee_delete_private_venues',
-                'ee_delete_published_venues',
-                //venue categories
-                'ee_manage_venue_categories',
-                'ee_edit_venue_category',
-                'ee_delete_venue_category',
-                'ee_assign_venue_category',
-                //contacts
-                'ee_read_contact',
-                'ee_read_contacts',
-                'ee_edit_contact',
-                'ee_edit_contacts',
-                'ee_delete_contact',
-                'ee_delete_contacts',
-                //registrations
-                'ee_read_registration',
-                'ee_read_registrations',
-                'ee_read_others_registrations',
-                'ee_edit_registration',
-                'ee_edit_registrations',
-                'ee_edit_others_registrations',
-                'ee_delete_registration',
-                'ee_delete_registrations',
-                //checkins
-                'ee_read_checkin',
-                'ee_read_others_checkins',
-                'ee_read_checkins',
-                'ee_edit_checkin',
-                'ee_edit_checkins',
-                'ee_edit_others_checkins',
-                'ee_delete_checkin',
-                'ee_delete_checkins',
-                'ee_delete_others_checkins',
-                //transactions && payments
-                'ee_read_transaction',
-                'ee_read_transactions',
-                'ee_edit_payments',
-                'ee_delete_payments',
-                //messages
-                'ee_read_message',
-                'ee_read_messages',
-                'ee_read_others_messages',
-                'ee_read_global_messages',
-                'ee_edit_global_messages',
-                'ee_edit_message',
-                'ee_edit_messages',
-                'ee_edit_others_messages',
-                'ee_delete_message',
-                'ee_delete_messages',
-                'ee_delete_others_messages',
-                'ee_delete_global_messages',
-                'ee_send_message',
-                //tickets
-                'ee_read_default_ticket',
-                'ee_read_default_tickets',
-                'ee_read_others_default_tickets',
-                'ee_edit_default_ticket',
-                'ee_edit_default_tickets',
-                'ee_edit_others_default_tickets',
-                'ee_delete_default_ticket',
-                'ee_delete_default_tickets',
-                'ee_delete_others_default_tickets',
-                //prices
-                'ee_edit_default_price',
-                'ee_edit_default_prices',
-                'ee_delete_default_price',
-                'ee_delete_default_prices',
-                'ee_edit_default_price_type',
-                'ee_edit_default_price_types',
-                'ee_delete_default_price_type',
-                'ee_delete_default_price_types',
-                'ee_read_default_prices',
-                'ee_read_default_price_types',
-                //registration form
-                'ee_edit_question',
-                'ee_edit_questions',
-                'ee_edit_system_questions',
-                'ee_read_questions',
-                'ee_delete_question',
-                'ee_delete_questions',
-                'ee_edit_question_group',
-                'ee_edit_question_groups',
-                'ee_read_question_groups',
-                'ee_edit_system_question_groups',
-                'ee_delete_question_group',
-                'ee_delete_question_groups',
-                //event_type taxonomy
-                'ee_assign_event_type',
-                'ee_manage_event_types',
-                'ee_edit_event_type',
-                'ee_delete_event_type',
-            ),
-            'ee_events_administrator' => array(
-                //core wp caps
-                'read',
-                'read_private_pages',
-                'read_private_posts',
-                'edit_users',
-                'edit_posts',
-                'edit_pages',
-                'edit_published_posts',
-                'edit_published_pages',
-                'edit_private_pages',
-                'edit_private_posts',
-                'edit_others_posts',
-                'edit_others_pages',
-                'publish_posts',
-                'publish_pages',
-                'delete_posts',
-                'delete_pages',
-                'delete_private_pages',
-                'delete_private_posts',
-                'delete_published_pages',
-                'delete_published_posts',
-                'delete_others_posts',
-                'delete_others_pages',
-                'manage_categories',
-                'manage_links',
-                'moderate_comments',
-                'unfiltered_html',
-                'upload_files',
-                'export',
-                'import',
-                'list_users',
-                'level_1', //required if user with this role shows up in author dropdowns
-                //basic ee access
-                'ee_read_ee',
-                //events
-                'ee_publish_events',
-                'ee_read_private_events',
-                'ee_read_others_events',
-                'ee_read_event',
-                'ee_read_events',
-                'ee_edit_event',
-                'ee_edit_events',
-                'ee_edit_published_events',
-                'ee_edit_others_events',
-                'ee_edit_private_events',
-                'ee_delete_published_events',
-                'ee_delete_private_events',
-                'ee_delete_event',
-                'ee_delete_events',
-                'ee_delete_others_events',
-                //event categories
-                'ee_manage_event_categories',
-                'ee_edit_event_category',
-                'ee_delete_event_category',
-                'ee_assign_event_category',
-                //venues
-                'ee_publish_venues',
-                'ee_read_venue',
-                'ee_read_venues',
-                'ee_read_others_venues',
-                'ee_read_private_venues',
-                'ee_edit_venue',
-                'ee_edit_venues',
-                'ee_edit_others_venues',
-                'ee_edit_published_venues',
-                'ee_edit_private_venues',
-                'ee_delete_venue',
-                'ee_delete_venues',
-                'ee_delete_others_venues',
-                'ee_delete_private_venues',
-                'ee_delete_published_venues',
-                //venue categories
-                'ee_manage_venue_categories',
-                'ee_edit_venue_category',
-                'ee_delete_venue_category',
-                'ee_assign_venue_category',
-                //contacts
-                'ee_read_contact',
-                'ee_read_contacts',
-                'ee_edit_contact',
-                'ee_edit_contacts',
-                'ee_delete_contact',
-                'ee_delete_contacts',
-                //registrations
-                'ee_read_registration',
-                'ee_read_registrations',
-                'ee_read_others_registrations',
-                'ee_edit_registration',
-                'ee_edit_registrations',
-                'ee_edit_others_registrations',
-                'ee_delete_registration',
-                'ee_delete_registrations',
-                //checkins
-                'ee_read_checkin',
-                'ee_read_others_checkins',
-                'ee_read_checkins',
-                'ee_edit_checkin',
-                'ee_edit_checkins',
-                'ee_edit_others_checkins',
-                'ee_delete_checkin',
-                'ee_delete_checkins',
-                'ee_delete_others_checkins',
-                //transactions && payments
-                'ee_read_transaction',
-                'ee_read_transactions',
-                'ee_edit_payments',
-                'ee_delete_payments',
-                //messages
-                'ee_read_message',
-                'ee_read_messages',
-                'ee_read_others_messages',
-                'ee_read_global_messages',
-                'ee_edit_global_messages',
-                'ee_edit_message',
-                'ee_edit_messages',
-                'ee_edit_others_messages',
-                'ee_delete_message',
-                'ee_delete_messages',
-                'ee_delete_others_messages',
-                'ee_delete_global_messages',
-                'ee_send_message',
-                //tickets
-                'ee_read_default_ticket',
-                'ee_read_default_tickets',
-                'ee_read_others_default_tickets',
-                'ee_edit_default_ticket',
-                'ee_edit_default_tickets',
-                'ee_edit_others_default_tickets',
-                'ee_delete_default_ticket',
-                'ee_delete_default_tickets',
-                'ee_delete_others_default_tickets',
-                //prices
-                'ee_edit_default_price',
-                'ee_edit_default_prices',
-                'ee_delete_default_price',
-                'ee_delete_default_prices',
-                'ee_edit_default_price_type',
-                'ee_edit_default_price_types',
-                'ee_delete_default_price_type',
-                'ee_delete_default_price_types',
-                'ee_read_default_prices',
-                'ee_read_default_price_types',
-                //registration form
-                'ee_edit_question',
-                'ee_edit_questions',
-                'ee_edit_system_questions',
-                'ee_read_questions',
-                'ee_delete_question',
-                'ee_delete_questions',
-                'ee_edit_question_group',
-                'ee_edit_question_groups',
-                'ee_read_question_groups',
-                'ee_edit_system_question_groups',
-                'ee_delete_question_group',
-                'ee_delete_question_groups',
-                //event_type taxonomy
-                'ee_assign_event_type',
-                'ee_manage_event_types',
-                'ee_edit_event_type',
-                'ee_delete_event_type',
-            )
-        );
-        $caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
-        return $caps;
-    }
-
-
-    /**
-     * This adds all the default caps to roles as registered in the _caps_map property.
-     *
-     * @since 4.5.0
-     *
-     * @param bool  $reset      allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                          actually REMOVE any capabilities from existing roles, it just resaves defaults roles
-     *                          and ensures that they are up to date.
-     * @param array $custom_map Optional.  Can be used to send a custom map of roles and capabilities for setting them
-     *                          up.  Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     *
-     * @return void
-     */
-    public function init_role_caps($reset = false, $custom_map = array())
-    {
-        $caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
-        //first let's determine if these caps have already been set.
-        $caps_set_before = get_option(self::option_name, array());
-        //if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($caps_map as $role => $caps_for_role) {
-            foreach ($caps_for_role as $cap) {
-                //first check we haven't already added this cap before, or it's a reset
-                if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
-                    if ($this->add_cap_to_role($role, $cap)) {
-                        $caps_set_before[ $role ][] = $cap;
-                    }
-                }
-            }
-        }
-        //now let's just save the cap that has been set.
-        update_option(self::option_name, $caps_set_before);
-        do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
-    }
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     *
-     * @since 4.5.0
-     *
-     * @param string $role  A WordPress role the capability is being added to
-     * @param string $cap   The capability being added to the role
-     * @param bool   $grant Whether to grant access to this cap on this role.
-     *
-     * @return bool
-     */
-    public function add_cap_to_role($role, $cap, $grant = true)
-    {
-        $role_object = get_role($role);
-        //if the role isn't available then we create it.
-        if (! $role_object instanceof WP_Role) {
-            //if a plugin wants to create a specific role name then they should create the role before
-            //EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace('_', ' ', str_replace('ee_', '', $role)));
-            $role_object = add_role($role, $role_label);
-        }
-        if ($role_object instanceof WP_Role) {
-            $role_object->add_cap($cap, $grant);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     *
-     * @param string $role A WordPress role the capability is being removed from.
-     * @param string $cap  The capability being removed
-     *
-     * @return void
-     */
-    public function remove_cap_from_role($role, $cap)
-    {
-        $role = get_role($role);
-        if ($role instanceof WP_Role) {
-            $role->remove_cap($cap);
-        }
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can($cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
-            $id);
-        return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
-    }
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     *
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, $cap, $context, $id = 0)
-    {
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
-            $id);
-        return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @since 4.5.0
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     *
-     * @return bool  Whether user can or not.
-     */
-    public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
-    {
-        $user_can = ! empty($id)
-            ? current_user_can_for_blog($blog_id, $cap, $id)
-            : current_user_can($blog_id, $cap);
-        //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return $user_can;
-    }
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     * Note this array is filtered.  It is assumed that all available EE capabilities are assigned to the administrator
-     * role.
-     *
-     * @since 4.5.0
-     *
-     * @param string $role If empty then the entire role/capability map is returned.  Otherwise just the capabilities
-     *                     for the given role are returned.
-     *
-     * @return array
-     */
-    public function get_ee_capabilities($role = 'administrator')
-    {
-        $capabilities = $this->_init_caps_map();
-        if (empty($role)) {
-            return $capabilities;
-        }
-        return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
-    }
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	/**
+	 * instance of EE_Capabilities object
+	 *
+	 * @var EE_Capabilities
+	 */
+	private static $_instance;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	private $_caps_map = array();
+
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects that define the granular capabilities mapped to for
+	 * a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private $_meta_caps = array();
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return EE_Capabilities
+	 */
+	public static function instance()
+	{
+		//check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return \EE_Capabilities
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 *
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	public function init_caps($reset = false)
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->_caps_map = $this->_init_caps_map();
+			$this->init_role_caps($reset);
+			$this->_set_meta_caps();
+		}
+	}
+
+
+	/**
+	 * This sets the meta caps property.
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_meta_caps()
+	{
+		//make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		$this->_meta_caps = $this->_get_default_meta_caps_array();
+		$this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
+		//add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
+		}
+	}
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @since  4.8.28.rc.012
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _get_default_meta_caps_array()
+	{
+		static $default_meta_caps = array();
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = array(
+				//edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					array('Registration', '', 'ee_edit_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					array('Registration', '', 'ee_edit_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					array('Ticket', '', 'ee_edit_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					array('Question', '', '', 'ee_edit_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					array('Question_Group', '', '', 'ee_edit_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					array('Payment_Method', '', 'ee_edit_others_payment_methods', '')
+				),
+				//reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					array('Event', '', 'ee_read_others_events', 'ee_read_private_events')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					array('Registration', '', '', 'ee_edit_others_registrations')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					array('Registration', '', '', 'ee_read_others_checkins')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					array('Ticket', '', '', 'ee_read_others_default_tickets')
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
+
+				//deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					array(
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					array(
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					)
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					array('Registration', '', 'ee_delete_others_registrations', '')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					array('Registration', '', 'ee_delete_others_checkins', '')
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					array('Ticket', '', 'ee_delete_others_default_tickets', '')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					array('Question', '', '', 'delete_system_questions')
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					array('Question_Group', '', '', 'delete_system_question_groups')
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					array('Payment_Method', '', 'ee_delete_others_payment_methods', '')
+				),
+			);
+		}
+		return $default_meta_caps;
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			//loop through our _meta_caps array
+			foreach ($this->_meta_caps as $meta_map) {
+				if (! $meta_map instanceof EE_Meta_Capability_Map) {
+					continue;
+				}
+				// don't load models if there is no object ID in the args
+				if(!empty($args[0])){
+					$meta_map->ensure_is_model();
+				}
+				$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+			}
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	private function _init_caps_map()
+	{
+		$caps = array(
+			'administrator'           => array(
+				//basic access
+				'ee_read_ee',
+				//gateways
+				/**
+				 * note that with payment method capabilities, although we've implemented
+				 * capability mapping which will be used for accessing payment methods owned by
+				 * other users.  This is not fully implemented yet in the payment method ui.
+				 * Currently only the "plural" caps are in active use.
+				 * (Specific payment method caps are in use as well).
+				 **/
+				'ee_manage_gateways',
+				'ee_read_payment_method',
+				'ee_read_payment_methods',
+				'ee_read_others_payment_methods',
+				'ee_edit_payment_method',
+				'ee_edit_payment_methods',
+				'ee_edit_others_payment_methods',
+				'ee_delete_payment_method',
+				'ee_delete_payment_methods',
+				//events
+				'ee_publish_events',
+				'ee_read_private_events',
+				'ee_read_others_events',
+				'ee_read_event',
+				'ee_read_events',
+				'ee_edit_event',
+				'ee_edit_events',
+				'ee_edit_published_events',
+				'ee_edit_others_events',
+				'ee_edit_private_events',
+				'ee_delete_published_events',
+				'ee_delete_private_events',
+				'ee_delete_event',
+				'ee_delete_events',
+				'ee_delete_others_events',
+				//event categories
+				'ee_manage_event_categories',
+				'ee_edit_event_category',
+				'ee_delete_event_category',
+				'ee_assign_event_category',
+				//venues
+				'ee_publish_venues',
+				'ee_read_venue',
+				'ee_read_venues',
+				'ee_read_others_venues',
+				'ee_read_private_venues',
+				'ee_edit_venue',
+				'ee_edit_venues',
+				'ee_edit_others_venues',
+				'ee_edit_published_venues',
+				'ee_edit_private_venues',
+				'ee_delete_venue',
+				'ee_delete_venues',
+				'ee_delete_others_venues',
+				'ee_delete_private_venues',
+				'ee_delete_published_venues',
+				//venue categories
+				'ee_manage_venue_categories',
+				'ee_edit_venue_category',
+				'ee_delete_venue_category',
+				'ee_assign_venue_category',
+				//contacts
+				'ee_read_contact',
+				'ee_read_contacts',
+				'ee_edit_contact',
+				'ee_edit_contacts',
+				'ee_delete_contact',
+				'ee_delete_contacts',
+				//registrations
+				'ee_read_registration',
+				'ee_read_registrations',
+				'ee_read_others_registrations',
+				'ee_edit_registration',
+				'ee_edit_registrations',
+				'ee_edit_others_registrations',
+				'ee_delete_registration',
+				'ee_delete_registrations',
+				//checkins
+				'ee_read_checkin',
+				'ee_read_others_checkins',
+				'ee_read_checkins',
+				'ee_edit_checkin',
+				'ee_edit_checkins',
+				'ee_edit_others_checkins',
+				'ee_delete_checkin',
+				'ee_delete_checkins',
+				'ee_delete_others_checkins',
+				//transactions && payments
+				'ee_read_transaction',
+				'ee_read_transactions',
+				'ee_edit_payments',
+				'ee_delete_payments',
+				//messages
+				'ee_read_message',
+				'ee_read_messages',
+				'ee_read_others_messages',
+				'ee_read_global_messages',
+				'ee_edit_global_messages',
+				'ee_edit_message',
+				'ee_edit_messages',
+				'ee_edit_others_messages',
+				'ee_delete_message',
+				'ee_delete_messages',
+				'ee_delete_others_messages',
+				'ee_delete_global_messages',
+				'ee_send_message',
+				//tickets
+				'ee_read_default_ticket',
+				'ee_read_default_tickets',
+				'ee_read_others_default_tickets',
+				'ee_edit_default_ticket',
+				'ee_edit_default_tickets',
+				'ee_edit_others_default_tickets',
+				'ee_delete_default_ticket',
+				'ee_delete_default_tickets',
+				'ee_delete_others_default_tickets',
+				//prices
+				'ee_edit_default_price',
+				'ee_edit_default_prices',
+				'ee_delete_default_price',
+				'ee_delete_default_prices',
+				'ee_edit_default_price_type',
+				'ee_edit_default_price_types',
+				'ee_delete_default_price_type',
+				'ee_delete_default_price_types',
+				'ee_read_default_prices',
+				'ee_read_default_price_types',
+				//registration form
+				'ee_edit_question',
+				'ee_edit_questions',
+				'ee_edit_system_questions',
+				'ee_read_questions',
+				'ee_delete_question',
+				'ee_delete_questions',
+				'ee_edit_question_group',
+				'ee_edit_question_groups',
+				'ee_read_question_groups',
+				'ee_edit_system_question_groups',
+				'ee_delete_question_group',
+				'ee_delete_question_groups',
+				//event_type taxonomy
+				'ee_assign_event_type',
+				'ee_manage_event_types',
+				'ee_edit_event_type',
+				'ee_delete_event_type',
+			),
+			'ee_events_administrator' => array(
+				//core wp caps
+				'read',
+				'read_private_pages',
+				'read_private_posts',
+				'edit_users',
+				'edit_posts',
+				'edit_pages',
+				'edit_published_posts',
+				'edit_published_pages',
+				'edit_private_pages',
+				'edit_private_posts',
+				'edit_others_posts',
+				'edit_others_pages',
+				'publish_posts',
+				'publish_pages',
+				'delete_posts',
+				'delete_pages',
+				'delete_private_pages',
+				'delete_private_posts',
+				'delete_published_pages',
+				'delete_published_posts',
+				'delete_others_posts',
+				'delete_others_pages',
+				'manage_categories',
+				'manage_links',
+				'moderate_comments',
+				'unfiltered_html',
+				'upload_files',
+				'export',
+				'import',
+				'list_users',
+				'level_1', //required if user with this role shows up in author dropdowns
+				//basic ee access
+				'ee_read_ee',
+				//events
+				'ee_publish_events',
+				'ee_read_private_events',
+				'ee_read_others_events',
+				'ee_read_event',
+				'ee_read_events',
+				'ee_edit_event',
+				'ee_edit_events',
+				'ee_edit_published_events',
+				'ee_edit_others_events',
+				'ee_edit_private_events',
+				'ee_delete_published_events',
+				'ee_delete_private_events',
+				'ee_delete_event',
+				'ee_delete_events',
+				'ee_delete_others_events',
+				//event categories
+				'ee_manage_event_categories',
+				'ee_edit_event_category',
+				'ee_delete_event_category',
+				'ee_assign_event_category',
+				//venues
+				'ee_publish_venues',
+				'ee_read_venue',
+				'ee_read_venues',
+				'ee_read_others_venues',
+				'ee_read_private_venues',
+				'ee_edit_venue',
+				'ee_edit_venues',
+				'ee_edit_others_venues',
+				'ee_edit_published_venues',
+				'ee_edit_private_venues',
+				'ee_delete_venue',
+				'ee_delete_venues',
+				'ee_delete_others_venues',
+				'ee_delete_private_venues',
+				'ee_delete_published_venues',
+				//venue categories
+				'ee_manage_venue_categories',
+				'ee_edit_venue_category',
+				'ee_delete_venue_category',
+				'ee_assign_venue_category',
+				//contacts
+				'ee_read_contact',
+				'ee_read_contacts',
+				'ee_edit_contact',
+				'ee_edit_contacts',
+				'ee_delete_contact',
+				'ee_delete_contacts',
+				//registrations
+				'ee_read_registration',
+				'ee_read_registrations',
+				'ee_read_others_registrations',
+				'ee_edit_registration',
+				'ee_edit_registrations',
+				'ee_edit_others_registrations',
+				'ee_delete_registration',
+				'ee_delete_registrations',
+				//checkins
+				'ee_read_checkin',
+				'ee_read_others_checkins',
+				'ee_read_checkins',
+				'ee_edit_checkin',
+				'ee_edit_checkins',
+				'ee_edit_others_checkins',
+				'ee_delete_checkin',
+				'ee_delete_checkins',
+				'ee_delete_others_checkins',
+				//transactions && payments
+				'ee_read_transaction',
+				'ee_read_transactions',
+				'ee_edit_payments',
+				'ee_delete_payments',
+				//messages
+				'ee_read_message',
+				'ee_read_messages',
+				'ee_read_others_messages',
+				'ee_read_global_messages',
+				'ee_edit_global_messages',
+				'ee_edit_message',
+				'ee_edit_messages',
+				'ee_edit_others_messages',
+				'ee_delete_message',
+				'ee_delete_messages',
+				'ee_delete_others_messages',
+				'ee_delete_global_messages',
+				'ee_send_message',
+				//tickets
+				'ee_read_default_ticket',
+				'ee_read_default_tickets',
+				'ee_read_others_default_tickets',
+				'ee_edit_default_ticket',
+				'ee_edit_default_tickets',
+				'ee_edit_others_default_tickets',
+				'ee_delete_default_ticket',
+				'ee_delete_default_tickets',
+				'ee_delete_others_default_tickets',
+				//prices
+				'ee_edit_default_price',
+				'ee_edit_default_prices',
+				'ee_delete_default_price',
+				'ee_delete_default_prices',
+				'ee_edit_default_price_type',
+				'ee_edit_default_price_types',
+				'ee_delete_default_price_type',
+				'ee_delete_default_price_types',
+				'ee_read_default_prices',
+				'ee_read_default_price_types',
+				//registration form
+				'ee_edit_question',
+				'ee_edit_questions',
+				'ee_edit_system_questions',
+				'ee_read_questions',
+				'ee_delete_question',
+				'ee_delete_questions',
+				'ee_edit_question_group',
+				'ee_edit_question_groups',
+				'ee_read_question_groups',
+				'ee_edit_system_question_groups',
+				'ee_delete_question_group',
+				'ee_delete_question_groups',
+				//event_type taxonomy
+				'ee_assign_event_type',
+				'ee_manage_event_types',
+				'ee_edit_event_type',
+				'ee_delete_event_type',
+			)
+		);
+		$caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
+		return $caps;
+	}
+
+
+	/**
+	 * This adds all the default caps to roles as registered in the _caps_map property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param bool  $reset      allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                          actually REMOVE any capabilities from existing roles, it just resaves defaults roles
+	 *                          and ensures that they are up to date.
+	 * @param array $custom_map Optional.  Can be used to send a custom map of roles and capabilities for setting them
+	 *                          up.  Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 *
+	 * @return void
+	 */
+	public function init_role_caps($reset = false, $custom_map = array())
+	{
+		$caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
+		//first let's determine if these caps have already been set.
+		$caps_set_before = get_option(self::option_name, array());
+		//if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($caps_map as $role => $caps_for_role) {
+			foreach ($caps_for_role as $cap) {
+				//first check we haven't already added this cap before, or it's a reset
+				if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
+					if ($this->add_cap_to_role($role, $cap)) {
+						$caps_set_before[ $role ][] = $cap;
+					}
+				}
+			}
+		}
+		//now let's just save the cap that has been set.
+		update_option(self::option_name, $caps_set_before);
+		do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
+	}
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $role  A WordPress role the capability is being added to
+	 * @param string $cap   The capability being added to the role
+	 * @param bool   $grant Whether to grant access to this cap on this role.
+	 *
+	 * @return bool
+	 */
+	public function add_cap_to_role($role, $cap, $grant = true)
+	{
+		$role_object = get_role($role);
+		//if the role isn't available then we create it.
+		if (! $role_object instanceof WP_Role) {
+			//if a plugin wants to create a specific role name then they should create the role before
+			//EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace('_', ' ', str_replace('ee_', '', $role)));
+			$role_object = add_role($role, $role_label);
+		}
+		if ($role_object instanceof WP_Role) {
+			$role_object->add_cap($cap, $grant);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 *
+	 * @param string $role A WordPress role the capability is being removed from.
+	 * @param string $cap  The capability being removed
+	 *
+	 * @return void
+	 */
+	public function remove_cap_from_role($role, $cap)
+	{
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->remove_cap($cap);
+		}
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can($cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
+			$id);
+		return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
+	}
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 *
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, $cap, $context, $id = 0)
+	{
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
+			$id);
+		return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 *
+	 * @return bool  Whether user can or not.
+	 */
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0)
+	{
+		$user_can = ! empty($id)
+			? current_user_can_for_blog($blog_id, $cap, $id)
+			: current_user_can($blog_id, $cap);
+		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return $user_can;
+	}
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 * Note this array is filtered.  It is assumed that all available EE capabilities are assigned to the administrator
+	 * role.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $role If empty then the entire role/capability map is returned.  Otherwise just the capabilities
+	 *                     for the given role are returned.
+	 *
+	 * @return array
+	 */
+	public function get_ee_capabilities($role = 'administrator')
+	{
+		$capabilities = $this->_init_caps_map();
+		if (empty($role)) {
+			return $capabilities;
+		}
+		return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
+	}
 }
 
 
@@ -827,142 +827,142 @@ 
 abstract class EE_Meta_Capability_Map
 {
 
-    public $meta_cap;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    protected $_model_name;
-
-    public $published_cap = '';
-
-    public $others_cap = '';
-
-    public $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @since                        4.5.0
-     *
-     * @param string $meta_cap   What meta capability is this mapping.
-     * @param array  $map_values array {
-     *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
-     *                           capabilities that don't get mapped to.
-     *
-     * @type         $map_values [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values [1] string represents the capability used for published. Optional.
-     * @type         $map_values [2] string represents the capability used for "others". Optional.
-     * @type         $map_values [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     */
-    public function __construct($meta_cap, $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        //verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        //set properties
-        $this->_model = null;
-        $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
-    }
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     *
-     * @return void
-     */
-    public function ensure_is_model()
-    {
-        //is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
-        //error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     *
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     * @since 4.6.x
-     *
-     * @param $caps
-     * @param $cap
-     * @param $user_id
-     * @param $args
-     *
-     * @return array
-     */
-    public function map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
+	public $meta_cap;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	protected $_model_name;
+
+	public $published_cap = '';
+
+	public $others_cap = '';
+
+	public $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @since                        4.5.0
+	 *
+	 * @param string $meta_cap   What meta capability is this mapping.
+	 * @param array  $map_values array {
+	 *                           //array of values that MUST match a count of 4.  It's okay to send an empty string for
+	 *                           capabilities that don't get mapped to.
+	 *
+	 * @type         $map_values [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values [1] string represents the capability used for published. Optional.
+	 * @type         $map_values [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 */
+	public function __construct($meta_cap, $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		//verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		//set properties
+		$this->_model = null;
+		$this->_model_name = $map_values[0];
+		$this->published_cap = (string)$map_values[1];
+		$this->others_cap = (string)$map_values[2];
+		$this->private_cap = (string)$map_values[3];
+	}
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 *
+	 * @return void
+	 */
+	public function ensure_is_model()
+	{
+		//is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		//ensure model name is string
+		$this->_model_name = (string)$this->_model_name;
+		//error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 * @since 4.6.x
+	 *
+	 * @param $caps
+	 * @param $cap
+	 * @param $user_id
+	 * @param $args
+	 *
+	 * @return array
+	 */
+	public function map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -978,83 +978,83 @@ 
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        if ($obj instanceof EE_CPT_Base) {
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                if (empty($this->published_cap)) {
-                    $caps[] = $cap;
-                } else {
-                    //if obj is published...
-                    if ($obj->status() === 'publish') {
-                        $caps[] = $this->published_cap;
-                    } else {
-                        $caps[] = $cap;
-                    }
-                }
-            } else {
-                //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                    && $obj->wp_user()
-                    && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if ($has_cap) {
-                $caps[] = $cap;
-            } else {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		if ($obj instanceof EE_CPT_Base) {
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				if (empty($this->published_cap)) {
+					$caps[] = $cap;
+				} else {
+					//if obj is published...
+					if ($obj->status() === 'publish') {
+						$caps[] = $this->published_cap;
+					} else {
+						$caps[] = $cap;
+					}
+				}
+			} else {
+				//the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+					&& $obj->wp_user()
+					&& $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if ($has_cap) {
+				$caps[] = $cap;
+			} else {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1071,24 +1071,24 @@ 
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1104,75 +1104,75 @@ 
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                $caps[] = $cap;
-                return $caps;
-            }
-            //if the item author is set and the user is the author...
-            if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-                $caps[] = $cap;
-            } elseif ($status_obj->private && ! empty($this->private_cap)) {
-                //the user is trying to view someone else's obj
-                $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
-                $caps[] = $this->others_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        } else {
-            //not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user') && $obj->wp_user() && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if ($has_cap) {
-                $caps[] = $cap;
-            } elseif (! empty($this->private_cap)) {
-                $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
-                $caps[] = $this->others_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				$caps[] = $cap;
+				return $caps;
+			}
+			//if the item author is set and the user is the author...
+			if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+				$caps[] = $cap;
+			} elseif ($status_obj->private && ! empty($this->private_cap)) {
+				//the user is trying to view someone else's obj
+				$caps[] = $this->private_cap;
+			} elseif (! empty($this->others_cap)) {
+				$caps[] = $this->others_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		} else {
+			//not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user') && $obj->wp_user() && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if ($has_cap) {
+				$caps[] = $cap;
+			} elseif (! empty($this->private_cap)) {
+				$caps[] = $this->private_cap;
+			} elseif (! empty($this->others_cap)) {
+				$caps[] = $this->others_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1189,52 +1189,52 @@ 
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        //cast $user_id to int for later explicit comparisons
-        $user_id = (int) $user_id;
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		//cast $user_id to int for later explicit comparisons
+		$user_id = (int) $user_id;
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1251,41 +1251,41 @@ 
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
 
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     *
-     * @return array   actual users capabilities
-     */
-    protected function _map_meta_caps($caps, $cap, $user_id, $args)
-    {
-        //only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = $cap;
-            return $caps;
-        }
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        } else {
-            $caps[] = $cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 *
+	 * @return array   actual users capabilities
+	 */
+	protected function _map_meta_caps($caps, $cap, $user_id, $args)
+	{
+		//only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		//if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = $cap;
+			return $caps;
+		}
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		} else {
+			$caps[] = $cap;
+		}
+		return $caps;
+	}
 
 
 }

Spacing +28 added lines, -28 removed lines

@@ -60,7 +60,7 @@ 
     public static function instance()
     {
         //check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
+        if ( ! self::$_instance instanceof EE_Capabilities) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -112,7 +112,7 @@ 
         $this->_meta_caps = $this->_get_default_meta_caps_array();
         $this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
         //add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+        if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
             add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
         }
     }
@@ -270,11 +270,11 @@ 
         if (did_action('AHEE__EE_System__load_espresso_addons__complete')) {
             //loop through our _meta_caps array
             foreach ($this->_meta_caps as $meta_map) {
-                if (! $meta_map instanceof EE_Meta_Capability_Map) {
+                if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
                     continue;
                 }
                 // don't load models if there is no object ID in the args
-                if(!empty($args[0])){
+                if ( ! empty($args[0])) {
                     $meta_map->ensure_is_model();
                 }
                 $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
@@ -632,9 +632,9 @@ 
         foreach ($caps_map as $role => $caps_for_role) {
             foreach ($caps_for_role as $cap) {
                 //first check we haven't already added this cap before, or it's a reset
-                if ($reset || ! isset($caps_set_before[ $role ]) || ! in_array($cap, $caps_set_before[ $role ])) {
+                if ($reset || ! isset($caps_set_before[$role]) || ! in_array($cap, $caps_set_before[$role])) {
                     if ($this->add_cap_to_role($role, $cap)) {
-                        $caps_set_before[ $role ][] = $cap;
+                        $caps_set_before[$role][] = $cap;
                     }
                 }
             }
@@ -664,7 +664,7 @@ 
     {
         $role_object = get_role($role);
         //if the role isn't available then we create it.
-        if (! $role_object instanceof WP_Role) {
+        if ( ! $role_object instanceof WP_Role) {
             //if a plugin wants to create a specific role name then they should create the role before
             //EE_Capabilities does.  Otherwise this function will create the role name from the slug:
             // - removes any `ee_` namespacing from the start of the slug.
@@ -721,7 +721,7 @@ 
     public function current_user_can($cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
         $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap,
             $id);
         return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
@@ -742,7 +742,7 @@ 
     public function user_can($user, $cap, $context, $id = 0)
     {
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
         $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,
             $id);
         return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
@@ -773,7 +773,7 @@ 
             : current_user_can($blog_id, $cap);
         //apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
         $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context,
             $user_can,
             $blog_id,
             $cap,
@@ -809,7 +809,7 @@ 
         if (empty($role)) {
             return $capabilities;
         }
-        return isset($capabilities[ $role ]) ? $capabilities[ $role ] : array();
+        return isset($capabilities[$role]) ? $capabilities[$role] : array();
     }
 }
 
@@ -875,16 +875,16 @@ 
                         'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
                         'event_espresso'
                     ),
-                    '<br>' . print_r($map_values, true)
+                    '<br>'.print_r($map_values, true)
                 )
             );
         }
         //set properties
         $this->_model = null;
         $this->_model_name = $map_values[0];
-        $this->published_cap = (string)$map_values[1];
-        $this->others_cap = (string)$map_values[2];
-        $this->private_cap = (string)$map_values[3];
+        $this->published_cap = (string) $map_values[1];
+        $this->others_cap = (string) $map_values[2];
+        $this->private_cap = (string) $map_values[3];
     }
 
     /**
@@ -911,11 +911,11 @@ 
             return;
         }
         //ensure model name is string
-        $this->_model_name = (string)$this->_model_name;
+        $this->_model_name = (string) $this->_model_name;
         //error proof if the name has EEM in it
         $this->_model_name = str_replace('EEM', '', $this->_model_name);
         $this->_model = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
+        if ( ! $this->_model instanceof EEM_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1005,7 +1005,7 @@ 
         /** @var EE_Base_Class $obj */
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1024,12 +1024,12 @@ 
                 }
             } else {
                 //the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
+                if ( ! empty($this->published_cap) && $obj->status() === 'publish') {
                     $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+                } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') {
                     $caps[] = $this->private_cap;
                 }
             }
@@ -1048,7 +1048,7 @@ 
             if ($has_cap) {
                 $caps[] = $cap;
             } else {
-                if (! empty($this->others_cap)) {
+                if ( ! empty($this->others_cap)) {
                     $caps[] = $this->others_cap;
                 }
             }
@@ -1130,7 +1130,7 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1146,7 +1146,7 @@ 
             } elseif ($status_obj->private && ! empty($this->private_cap)) {
                 //the user is trying to view someone else's obj
                 $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
+            } elseif ( ! empty($this->others_cap)) {
                 $caps[] = $this->others_cap;
             } else {
                 $caps[] = $cap;
@@ -1163,9 +1163,9 @@ 
             }
             if ($has_cap) {
                 $caps[] = $cap;
-            } elseif (! empty($this->private_cap)) {
+            } elseif ( ! empty($this->private_cap)) {
                 $caps[] = $this->private_cap;
-            } elseif (! empty($this->others_cap)) {
+            } elseif ( ! empty($this->others_cap)) {
                 $caps[] = $this->others_cap;
             } else {
                 $caps[] = $cap;
@@ -1215,7 +1215,7 @@ 
 
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
+        if ( ! $obj instanceof EE_Message_Template_Group) {
             $caps[] = $cap;
             return $caps;
         }
@@ -1273,7 +1273,7 @@ 
         }
         $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
         //if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
+        if ( ! $obj instanceof EE_Base_Class) {
             $caps[] = $cap;
             return $caps;
         }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_payment_method_currencies.dmsstage.php

Spacing +24 added lines, -24 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (!defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
 	exit('No direct script access allowed');
 }
 
@@ -14,7 +14,7 @@ 
  * @deprecated in 4.9.40 because the currency payment method table has been deprecated
  *
  */
-class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage{
+class EE_DMS_4_6_0_payment_method_currencies extends EE_Data_Migration_Script_Stage {
 	protected $_currency_table_name;
 	protected $_currency_payment_method_table_name;
 	protected $_payment_method_table_name;
@@ -90,7 +90,7 @@ 
 	);
 	public function __construct() {
 		global $wpdb;
-		$this->_pretty_name = __( 'Payment Method Currencies', 'event_espresso' );
+		$this->_pretty_name = __('Payment Method Currencies', 'event_espresso');
 		$this->_payment_method_table_name = $wpdb->prefix.'esp_payment_method';
 		$this->_currency_payment_method_table_name = $wpdb->prefix.'esp_currency_payment_method';
 		$this->_currency_table_name = $wpdb->prefix.'esp_currency';
@@ -99,8 +99,8 @@ 
 
 	protected function _count_records_to_migrate() {
 		$count = 0;
-		foreach($this->_gateway_currencies as $currencies){
-			if( $currencies == 'all'){
+		foreach ($this->_gateway_currencies as $currencies) {
+			if ($currencies == 'all') {
 				$currencies = $this->_get_all_currencies();
 			}
 			$count += count($currencies);
@@ -110,20 +110,20 @@ 
 
 
 
-	protected function _migration_step( $num_items_to_migrate = 50 ) {
+	protected function _migration_step($num_items_to_migrate = 50) {
 		$items_actually_migrated = 0;
 		$relations_to_add_this_step = $this->_gather_relations_to_add($num_items_to_migrate);
-		foreach($relations_to_add_this_step as $pm_slug => $currencies){
+		foreach ($relations_to_add_this_step as $pm_slug => $currencies) {
 
-			$id = $this->get_migration_script()->get_mapping_new_pk( 'EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name );
-			foreach( $currencies as $currency ){
-				if( $id ){
-					$this->_add_currency_relations( $id, $currency );
+			$id = $this->get_migration_script()->get_mapping_new_pk('EE_Gateway_Config', $pm_slug, $this->_payment_method_table_name);
+			foreach ($currencies as $currency) {
+				if ($id) {
+					$this->_add_currency_relations($id, $currency);
 				}
 				$items_actually_migrated++;
 			}
 		}
-		if($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()){
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
 			$this->set_completed();
 		}
 		return $items_actually_migrated;
@@ -133,14 +133,14 @@ 
 		$relations_to_add_this_step = array();
 		$migrate_up_to_count = $this->count_records_migrated() + $num_items_to_migrate;
 		$iterator = 0;
-		foreach($this->_gateway_currencies as $pm_slug => $currencies){
-			if( $currencies == 'all' ){
+		foreach ($this->_gateway_currencies as $pm_slug => $currencies) {
+			if ($currencies == 'all') {
 				$currencies = $this->_get_all_currencies();
 			}
-			foreach($currencies as $currency_code){
-				if( $this->count_records_migrated() <= $iterator &&
-						$iterator < $migrate_up_to_count ){
-					$relations_to_add_this_step[ $pm_slug ] [] = $currency_code;
+			foreach ($currencies as $currency_code) {
+				if ($this->count_records_migrated() <= $iterator &&
+						$iterator < $migrate_up_to_count) {
+					$relations_to_add_this_step[$pm_slug] [] = $currency_code;
 				}
 				$iterator++;
 			}
@@ -151,7 +151,7 @@ 
 	 * Gets all the currency codes in the database
 	 * @return array
 	 */
-	private function _get_all_currencies(){
+	private function _get_all_currencies() {
 		global $wpdb;
 		$currencies = $wpdb->get_col("SELECT CUR_code FROM {$this->_currency_table_name}");
 		return $currencies;
@@ -162,7 +162,7 @@ 
 	 * @param int $id
 	 * @param string $gateway_slug
 	 */
-	private function _add_currency_relations($pm_id,$currency_code){
+	private function _add_currency_relations($pm_id, $currency_code) {
 		global $wpdb;
 		$cur_pm_relation = array(
 					'CUR_code'=>$currency_code,
@@ -171,11 +171,11 @@ 
 		$success = $wpdb->insert($this->_currency_payment_method_table_name,
 				$cur_pm_relation,
 				array(
-					'%s',//CUR_code
-					'%d',//PMD_ID
+					'%s', //CUR_code
+					'%d', //PMD_ID
 				));
-		if( ! $success ){
-			$this->add_error( sprintf( __( 'Could not add currency relation %s because %s', "event_espresso" ), wp_json_encode( $cur_pm_relation ), $wpdb->last_error ) );
+		if ( ! $success) {
+			$this->add_error(sprintf(__('Could not add currency relation %s because %s', "event_espresso"), wp_json_encode($cur_pm_relation), $wpdb->last_error));
 		}
 	}
 }

core/data_migration_scripts/EE_DMS_Core_4_9_0.dms.php

Indentation +282 added lines, -282 removed lines

@@ -12,9 +12,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_9_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[$matches[1]] = $filepath;
+	$matches = array();
+	preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[$matches[1]] = $filepath;
 }
 //give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_9_0__autoloaded_stages', $class_to_filepath);
@@ -33,68 +33,68 @@ 
 class EE_DMS_Core_4_9_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_9_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_9_0_Email_System_Question(),
-            new EE_DMS_4_9_0_Answers_With_No_Registration(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_9_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.9.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_9_0_Email_System_Question(),
+			new EE_DMS_4_9_0_Answers_With_No_Registration(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
-            //			echo "$version_string can be migrated from";
-            return true;
-        } elseif ( ! $version_string) {
-            //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.3
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
-            //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.9.0', '<=') && version_compare($version_string, '4.8.0', '>=')) {
+			//			echo "$version_string can be migrated from";
+			return true;
+		} elseif ( ! $version_string) {
+			//			echo "no version string provided: $version_string";
+			//no version string provided... this must be pre 4.3
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
+			//			echo "$version_string doesnt apply";
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
-        $sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'ATT_email');
+		$sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -111,9 +111,9 @@ 
 				KEY ATT_email (ATT_email(191)),
 				KEY ATT_lname (ATT_lname),
 				KEY ATT_fname (ATT_fname)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -121,9 +121,9 @@ 
 				PRIMARY KEY  (CHK_ID),
 				KEY REG_ID (REG_ID),
 				KEY DTT_ID (DTT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -139,29 +139,29 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        //note: although this table is no longer in use,
-        //it hasn't been removed because then queries to the model will have errors.
-        //but you should expect this table and its corresponding model to be removed in
-        //the next few months
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		//note: although this table is no longer in use,
+		//it hasn't been removed because then queries to the model will have errors.
+		//but you should expect this table and its corresponding model to be removed in
+		//the next few months
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
 				DTT_description text NOT NULL,
@@ -178,25 +178,25 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID),
 				KEY DTT_ID (DTT_ID),
 				KEY TKT_ID (TKT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
 				EVT_display_ticket_selector tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -211,34 +211,34 @@ 
 				EVT_donations tinyint(1) NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -246,9 +246,9 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -267,9 +267,9 @@ 
 				PRIMARY KEY  (LIN_ID),
 				KEY LIN_code (LIN_code(191)),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -280,12 +280,12 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message';
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
-        $this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
-        $sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message';
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_to');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_from');
+		$this->_get_table_manager()->dropIndexIfSizeNot($table_name, 'MSG_subject');
+		$sql = "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -317,18 +317,18 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID),
 				KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -340,9 +340,9 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -359,9 +359,9 @@ 
 				PRIMARY KEY  (PAY_ID),
 				KEY PAY_timestamp (PAY_timestamp),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -377,24 +377,24 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID),
 				KEY TKT_ID (TKT_ID),
 				KEY PRC_ID (PRC_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -408,18 +408,18 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -429,9 +429,9 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -455,18 +455,18 @@ 
 				KEY TKT_ID (TKT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
@@ -474,9 +474,9 @@ 
 				PRIMARY KEY  (STA_ID),
 				KEY STA_abbrev (STA_abbrev),
 				KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -484,9 +484,9 @@ 
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 				KEY STS_type (STS_type)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -498,9 +498,9 @@ 
 				PRIMARY KEY  (TXN_ID),
 				KEY TXN_timestamp (TXN_timestamp),
 				KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -519,10 +519,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        //modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		//modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -535,9 +535,9 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -546,9 +546,9 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -571,9 +571,9 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -586,138 +586,138 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        //(because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        /** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
-        $script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
-        $script_4_6_defaults->add_default_admin_only_payments();
-        $script_4_6_defaults->insert_default_currencies();
-        /** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
-        $script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
-        $script_4_8_defaults->verify_new_countries();
-        $script_4_8_defaults->verify_new_currencies();
-        $this->verify_db_collations();
-        $this->verify_db_collations_again();
-        return true;
-    }
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		//(because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		/** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
+		$script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
+		$script_4_6_defaults->add_default_admin_only_payments();
+		$script_4_6_defaults->insert_default_currencies();
+		/** @var EE_DMS_Core_4_8_0 $script_4_8_defaults */
+		$script_4_8_defaults = EE_Registry::instance()->load_dms('Core_4_8_0');
+		$script_4_8_defaults->verify_new_countries();
+		$script_4_8_defaults->verify_new_currencies();
+		$this->verify_db_collations();
+		$this->verify_db_collations_again();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    /**
-     * Verify all EE4 models' tables use utf8mb4 collation
-     *
-     * @return void
-     */
-    public function verify_db_collations()
-    {
-        if (get_option('ee_verified_db_collations', false)) {
-            return;
-        }
-        // grab tables from each model
-        $tables_to_check = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (
-                            strpos($table->get_table_name(), 'esp_')
-                            && (is_main_site()//for main tables, verify global tables
-                                || ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
-                            )
-                            && function_exists('maybe_convert_table_to_utf8mb4')
-                        ) {
-                            $tables_to_check[] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-        //and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
-        //when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
-        //of hard-coding this
-        $addon_tables = array(
-            //mailchimp
-            'esp_event_mailchimp_list_group',
-            'esp_event_question_mailchimp_field',
-            //multisite
-            'esp_blog_meta',
-            //people
-            'esp_people_to_post',
-            //promotions
-            'esp_promotion',
-            'esp_promotion_object',
-        );
-        foreach ($addon_tables as $table_name) {
-                $tables_to_check[] = $table_name;
-        }
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        //ok and now let's remember this was done (without needing to check the db schemas all over again)
-        add_option('ee_verified_db_collations', true, null, 'no');
-        //seeing how this ran with the fix from 10435, no need to check again
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verify all EE4 models' tables use utf8mb4 collation
+	 *
+	 * @return void
+	 */
+	public function verify_db_collations()
+	{
+		if (get_option('ee_verified_db_collations', false)) {
+			return;
+		}
+		// grab tables from each model
+		$tables_to_check = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (
+							strpos($table->get_table_name(), 'esp_')
+							&& (is_main_site()//for main tables, verify global tables
+								|| ! $table->is_global()//if not the main site, then only verify non-global tables (avoid doubling up)
+							)
+							&& function_exists('maybe_convert_table_to_utf8mb4')
+						) {
+							$tables_to_check[] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+		//and let's just be sure these addons' tables get migrated too. They already get handled if their addons are active
+		//when this code is run, but not otherwise. Once we record what tables EE added, we'll be able to use that instead
+		//of hard-coding this
+		$addon_tables = array(
+			//mailchimp
+			'esp_event_mailchimp_list_group',
+			'esp_event_question_mailchimp_field',
+			//multisite
+			'esp_blog_meta',
+			//people
+			'esp_people_to_post',
+			//promotions
+			'esp_promotion',
+			'esp_promotion_object',
+		);
+		foreach ($addon_tables as $table_name) {
+				$tables_to_check[] = $table_name;
+		}
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		//ok and now let's remember this was done (without needing to check the db schemas all over again)
+		add_option('ee_verified_db_collations', true, null, 'no');
+		//seeing how this ran with the fix from 10435, no need to check again
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
-     * which meant some DB collations might not have been updated
-     * @return void
-     */
-    public function verify_db_collations_again(){
-        if (get_option('ee_verified_db_collations_again', false)) {
-            return;
-        }
-        $tables_to_check = array(
-            'esp_attendee_meta',
-            'esp_message'
-        );
-        $this->_verify_db_collations_for_tables(array_unique($tables_to_check));
-        add_option('ee_verified_db_collations_again',true,null,'no');
-    }
+	/**
+	 * Verifies DB collations because a bug was discovered on https://events.codebasehq.com/projects/event-espresso/tickets/10435
+	 * which meant some DB collations might not have been updated
+	 * @return void
+	 */
+	public function verify_db_collations_again(){
+		if (get_option('ee_verified_db_collations_again', false)) {
+			return;
+		}
+		$tables_to_check = array(
+			'esp_attendee_meta',
+			'esp_message'
+		);
+		$this->_verify_db_collations_for_tables(array_unique($tables_to_check));
+		add_option('ee_verified_db_collations_again',true,null,'no');
+	}
 
 
 
-    /**
-     * Runs maybe_convert_table_to_utf8mb4 on the specified tables
-     * @param $tables_to_check
-     * @return boolean true if logic ran, false if it didn't
-     */
-    protected function _verify_db_collations_for_tables($tables_to_check)
-    {
-        foreach ($tables_to_check as $table_name) {
-            $table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
-            if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
-                && $this->_get_table_analysis()->tableExists($table_name)
-            ) {
-                maybe_convert_table_to_utf8mb4($table_name);
-            }
-        }
-    }
+	/**
+	 * Runs maybe_convert_table_to_utf8mb4 on the specified tables
+	 * @param $tables_to_check
+	 * @return boolean true if logic ran, false if it didn't
+	 */
+	protected function _verify_db_collations_for_tables($tables_to_check)
+	{
+		foreach ($tables_to_check as $table_name) {
+			$table_name = $this->_table_analysis->ensureTableNameHasPrefix($table_name);
+			if ( ! apply_filters('FHEE__EE_DMS_Core_4_9_0__verify_db_collations__check_overridden', false, $table_name )
+				&& $this->_get_table_analysis()->tableExists($table_name)
+			) {
+				maybe_convert_table_to_utf8mb4($table_name);
+			}
+		}
+	}
 }
\ No newline at end of file

core/data_migration_scripts/EE_DMS_Core_4_6_0.dms.php

Indentation +269 added lines, -269 removed lines

@@ -14,9 +14,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_6_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[$matches[1]] = $filepath;
+	$matches = array();
+	preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[$matches[1]] = $filepath;
 }
 //give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_6_0__autoloaded_stages', $class_to_filepath);
@@ -35,69 +35,69 @@ 
 class EE_DMS_Core_4_6_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_6_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = __("Data Update to Event Espresso 4.6.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_6_0_gateways(),
-            new EE_DMS_4_6_0_question_types(),
-            new EE_DMS_4_6_0_country_system_question(),
-            new EE_DMS_4_6_0_state_system_question(),
-            new EE_DMS_4_6_0_billing_info(),
-            new EE_DMS_4_6_0_transactions(),
-            new EE_DMS_4_6_0_payments(),
-            new EE_DMS_4_6_0_invoice_settings(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-
-    /**
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.6.0', '<=') && version_compare($version_string, '4.5.0', '>=')) {
+	/**
+	 * return EE_DMS_Core_4_6_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = __("Data Update to Event Espresso 4.6.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_6_0_gateways(),
+			new EE_DMS_4_6_0_question_types(),
+			new EE_DMS_4_6_0_country_system_question(),
+			new EE_DMS_4_6_0_state_system_question(),
+			new EE_DMS_4_6_0_billing_info(),
+			new EE_DMS_4_6_0_transactions(),
+			new EE_DMS_4_6_0_payments(),
+			new EE_DMS_4_6_0_invoice_settings(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+
+	/**
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.6.0', '<=') && version_compare($version_string, '4.5.0', '>=')) {
 //			echo "$version_string can be migrated from";
-            return true;
-        } elseif ( ! $version_string) {
+			return true;
+		} elseif ( ! $version_string) {
 //			echo "no version string provided: $version_string";
-            //no version string provided... this must be pre 4.3
-            return false;//changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			//no version string provided... this must be pre 4.3
+			return false;//changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //			echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        //relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		//relies on 4.1's EEH_Activation::create_table
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					ANS_value TEXT NOT NULL,
 					PRIMARY KEY  (ANS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID INT(10) UNSIGNED NOT	NULL AUTO_INCREMENT,
 						ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 						ATT_fname VARCHAR(45) NOT NULL,
 						ATT_lname VARCHAR(45) NOT	NULL,
@@ -113,9 +113,9 @@ 
 								KEY ATT_fname (ATT_fname),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_email (ATT_email)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  CNT_ISO3 VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  RGN_ID TINYINT(3) UNSIGNED DEFAULT NULL,
 					  CNT_name VARCHAR(45) COLLATE utf8_bin NOT NULL,
@@ -131,24 +131,24 @@ 
 					  CNT_is_EU TINYINT(1) DEFAULT '0',
 					  CNT_active TINYINT(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code VARCHAR(6) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code VARCHAR(6) COLLATE utf8_bin NOT NULL,
 				CUR_single VARCHAR(45) COLLATE utf8_bin DEFAULT 'dollar',
 				CUR_plural VARCHAR(45) COLLATE utf8_bin DEFAULT 'dollars',
 				CUR_sign VARCHAR(45) COLLATE utf8_bin DEFAULT '$',
 				CUR_dec_plc VARCHAR(1) COLLATE utf8_bin NOT NULL DEFAULT '2',
 				CUR_active TINYINT(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID INT(11) NOT NULL AUTO_INCREMENT,
 				CUR_code  VARCHAR(6) COLLATE utf8_bin NOT NULL,
 				PMD_ID INT(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				  DTT_name VARCHAR(255) NOT NULL DEFAULT '',
 				  DTT_description TEXT NOT NULL,
@@ -163,9 +163,9 @@ 
 						PRIMARY KEY  (DTT_ID),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID INT NOT NULL AUTO_INCREMENT,
 			EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 			EVT_display_desc TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
@@ -180,31 +180,31 @@ 
 			EVT_external_URL VARCHAR(200) NULL,
 			EVT_donations TINYINT(1) NULL,
 			PRIMARY KEY  (EVTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					QSG_ID INT UNSIGNED NOT NULL,
 					EQG_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID INT(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 				VNU_ID BIGINT(20) UNSIGNED NOT NULL,
 				EVV_primary TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID INT(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID INT(11) DEFAULT NULL,
 				EXM_type VARCHAR(45) DEFAULT NULL,
 				EXM_key VARCHAR(45) DEFAULT NULL,
 				EXM_value TEXT,
 				PRIMARY KEY  (EXM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID INT(11) NOT NULL AUTO_INCREMENT,
 				LIN_code VARCHAR(245) NOT NULL DEFAULT '',
 				TXN_ID INT(11) DEFAULT NULL,
 				LIN_name VARCHAR(245) NOT NULL DEFAULT '',
@@ -220,9 +220,9 @@ 
 				OBJ_ID INT(11) DEFAULT NULL,
 				OBJ_type VARCHAR(45)DEFAULT NULL,
 				PRIMARY KEY  (LIN_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID INT(11) NOT NULL AUTO_INCREMENT,
 				LOG_time DATETIME DEFAULT NULL,
 				OBJ_ID VARCHAR(45) DEFAULT NULL,
 				OBJ_type VARCHAR(45) DEFAULT NULL,
@@ -230,19 +230,19 @@ 
 				LOG_message TEXT,
 				LOG_wp_user INT(11) DEFAULT NULL,
 				PRIMARY KEY  (LOG_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					GRP_ID INT(10) UNSIGNED NOT NULL,
 					MTP_context VARCHAR(50) NOT NULL,
 					MTP_template_field VARCHAR(30) NOT NULL,
 					MTP_content TEXT NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					MTP_user_id INT(10) NOT NULL DEFAULT '1',
 					MTP_name VARCHAR(245) NOT NULL DEFAULT '',
 					MTP_description VARCHAR(245) NOT NULL DEFAULT '',
@@ -254,17 +254,17 @@ 
 					MTP_is_active TINYINT(1) NOT NULL DEFAULT '1',
 					PRIMARY KEY  (GRP_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 					EVT_ID BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 					GRP_ID INT(10) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EMT_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					TXN_ID INT(10) UNSIGNED DEFAULT NULL,
 					STS_ID VARCHAR(3) COLLATE utf8_bin DEFAULT NULL,
 					PAY_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -281,9 +281,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY TXN_ID (TXN_ID),
 					KEY PAY_timestamp (PAY_timestamp)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID INT(11) NOT NULL AUTO_INCREMENT,
 				PMD_type VARCHAR(124) DEFAULT NULL,
 				PMD_name VARCHAR(255) DEFAULT NULL,
 				PMD_desc TEXT,
@@ -298,28 +298,28 @@ 
 				PMD_scope VARCHAR(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRC_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (TKP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  DTT_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_ID INT(10) UNSIGNED NOT NULL,
 					  PRIMARY KEY  (DTK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_name VARCHAR(45) NOT NULL,
 					  TTM_description TEXT,
 					  TTM_file VARCHAR(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QST_display_text TEXT NOT NULL,
 					QST_admin_label VARCHAR(255) NOT NULL,
 					QST_system VARCHAR(25) DEFAULT NULL,
@@ -331,25 +331,25 @@ 
 					QST_wp_user BIGINT UNSIGNED NULL,
 					QST_deleted TINYINT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_ID INT UNSIGNED NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QGQ_order INT UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID) ";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSO_value VARCHAR(255) NOT NULL,
 					QSO_desc TEXT NOT NULL,
 					QST_ID INT UNSIGNED NOT NULL,
 					QSO_order INT UNSIGNED NOT NULL DEFAULT 0,
 					QSO_deleted TINYINT(1) UNSIGNED NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSO_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  EVT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  ATT_ID BIGINT(20) UNSIGNED NOT NULL,
 					  TXN_ID INT(10) UNSIGNED NOT NULL,
@@ -372,25 +372,25 @@ 
 					  KEY STS_ID (STS_ID),
 					  KEY REG_url_link (REG_url_link),
 					  KEY REG_code (REG_code)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					REG_ID INT(10) UNSIGNED NOT NULL,
 					DTT_ID INT(10) UNSIGNED NOT NULL,
 					CHK_in TINYINT(1) UNSIGNED NOT NULL DEFAULT 1,
 					CHK_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					PRIMARY KEY  (CHK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  CNT_ISO VARCHAR(2) COLLATE utf8_bin NOT NULL,
 					  STA_abbrev VARCHAR(24) COLLATE utf8_bin NOT NULL,
 					  STA_name VARCHAR(100) COLLATE utf8_bin NOT NULL,
 					  STA_active TINYINT(1) DEFAULT '1',
 					  PRIMARY KEY  (STA_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID VARCHAR(3) COLLATE utf8_bin NOT NULL,
 					  STS_code VARCHAR(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit TINYINT(1) NOT NULL DEFAULT 0,
@@ -398,9 +398,9 @@ 
 					  STS_open TINYINT(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total DECIMAL(10,3) DEFAULT '0.00',
 					  TXN_paid DECIMAL(10,3) NOT NULL DEFAULT '0.00',
@@ -412,9 +412,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID INT(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 			VNU_address VARCHAR(255) DEFAULT NULL,
 			VNU_address2 VARCHAR(255) DEFAULT NULL,
@@ -432,10 +432,10 @@ 
 			PRIMARY KEY  (VNUM_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        //modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		//modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  PRT_ID TINYINT(3) UNSIGNED NOT NULL,
 					  PRC_amount DECIMAL(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name VARCHAR(245) NOT NULL,
@@ -447,9 +447,9 @@ 
 					  PRC_wp_user BIGINT UNSIGNED NULL,
 					  PRC_parent INT(10) UNSIGNED DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID TINYINT(3) UNSIGNED NOT NULL AUTO_INCREMENT,
 				  PRT_name VARCHAR(45) NOT NULL,
 				  PBT_ID TINYINT(3) UNSIGNED NOT NULL DEFAULT '1',
 				  PRT_is_percent TINYINT(1) NOT NULL DEFAULT '0',
@@ -458,9 +458,9 @@ 
 				  PRT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
 					  TTM_ID INT(10) UNSIGNED NOT NULL,
 					  TKT_name VARCHAR(245) NOT NULL DEFAULT '',
 					  TKT_description TEXT NOT NULL,
@@ -481,10 +481,10 @@ 
 					  TKT_parent INT(10) UNSIGNED DEFAULT '0',
 					  TKT_deleted TINYINT(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID INT UNSIGNED NOT NULL AUTO_INCREMENT,
 					QSG_name VARCHAR(255) NOT NULL,
 					QSG_identifier VARCHAR(100) NOT NULL,
 					QSG_desc TEXT NULL,
@@ -496,119 +496,119 @@ 
 					QSG_wp_user BIGINT UNSIGNED NULL,
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier ASC)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        //(because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        //setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
-        EE_Config::instance()->update_espresso_config(false, true);
-        $this->add_default_admin_only_payments();
-        $this->insert_default_currencies();
-        return true;
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
-
-
-
-    public function migration_page_hooks()
-    {
-    }
-
-
-
-    public function add_default_admin_only_payments()
-    {
-        global $wpdb;
-        $table_name = $wpdb->prefix . "esp_payment_method";
-        $user_id = EEH_Activation::get_default_creator_id();
-        if ($this->_get_table_analysis()->tableExists($table_name)) {
-            $SQL = "SELECT COUNT( * ) FROM $table_name";
-            $existing_payment_methods = $wpdb->get_var($SQL);
-            $default_admin_only_payment_methods = apply_filters(
-                'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
-                array(
-                    __("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
-                    __("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
-                    __("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
-                    __("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
-                    __("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
-                    __("Invoice", 'event_espresso')     => __("Invoice received with monies included",
-                        'event_espresso'),
-                    __("Money Order", 'event_espresso') => '',
-                    __("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
-                    __('Other', 'event_espresso')       => __('Other method of payment', 'event_espresso'),
-                ));
-            //make sure we hae payment method records for the following
-            //so admins can record payments for them from the admin page
-            foreach ($default_admin_only_payment_methods as $nicename => $description) {
-                $slug = sanitize_key($nicename);
-                //check that such a payment method exists
-                $exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
-                if ( ! $exists) {
-                    $values = array(
-                        'PMD_type'       => 'Admin_Only',
-                        'PMD_name'       => $nicename,
-                        'PMD_admin_name' => $nicename,
-                        'PMD_admin_desc' => $description,
-                        'PMD_slug'       => $slug,
-                        'PMD_wp_user'    => $user_id,
-                        'PMD_scope'      => serialize(array('ADMIN')),
-                    );
-                    $success = $wpdb->insert(
-                        $table_name,
-                        $values,
-                        array(
-                            '%s',//PMD_type
-                            '%s',//PMD_name
-                            '%s',//PMD_admin_name
-                            '%s',//PMD_admin_desc
-                            '%s',//PMD_slug
-                            '%d',//PMD_wp_user
-                            '%s',//PMD_scope
-                        )
-                    );
-                    if ( ! $success) {
-                        $this->add_error(sprintf(__("Could not insert new admin-only payment method with values %s during migration",
-                            "event_espresso"), $this->_json_encode($values)));
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * insert_default_countries
-     *
-     * @static
-     * @return void
-     */
-    public function insert_default_currencies()
-    {
-        global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
-        if ($this->_get_table_analysis()->tableExists($currency_table)) {
-            $SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
-            $countries = $wpdb->get_var($SQL);
-            if ( ! $countries) {
-                $SQL = "INSERT INTO $currency_table
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		//(because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		//setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
+		EE_Config::instance()->update_espresso_config(false, true);
+		$this->add_default_admin_only_payments();
+		$this->insert_default_currencies();
+		return true;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
+
+
+
+	public function migration_page_hooks()
+	{
+	}
+
+
+
+	public function add_default_admin_only_payments()
+	{
+		global $wpdb;
+		$table_name = $wpdb->prefix . "esp_payment_method";
+		$user_id = EEH_Activation::get_default_creator_id();
+		if ($this->_get_table_analysis()->tableExists($table_name)) {
+			$SQL = "SELECT COUNT( * ) FROM $table_name";
+			$existing_payment_methods = $wpdb->get_var($SQL);
+			$default_admin_only_payment_methods = apply_filters(
+				'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
+				array(
+					__("Bank", 'event_espresso')        => __("Bank Draft", 'event_espresso'),
+					__("Cash", 'event_espresso')        => __("Cash Delivered Physically", 'event_espresso'),
+					__("Check", 'event_espresso')       => __("Paper Check", 'event_espresso'),
+					__("Credit Card", 'event_espresso') => __("Offline Credit Card Payment", 'event_espresso'),
+					__("Debit Card", 'event_espresso')  => __("Offline Debit Payment", 'event_espresso'),
+					__("Invoice", 'event_espresso')     => __("Invoice received with monies included",
+						'event_espresso'),
+					__("Money Order", 'event_espresso') => '',
+					__("Paypal", 'event_espresso')      => __("Paypal eCheck, Invoice, etc", 'event_espresso'),
+					__('Other', 'event_espresso')       => __('Other method of payment', 'event_espresso'),
+				));
+			//make sure we hae payment method records for the following
+			//so admins can record payments for them from the admin page
+			foreach ($default_admin_only_payment_methods as $nicename => $description) {
+				$slug = sanitize_key($nicename);
+				//check that such a payment method exists
+				$exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
+				if ( ! $exists) {
+					$values = array(
+						'PMD_type'       => 'Admin_Only',
+						'PMD_name'       => $nicename,
+						'PMD_admin_name' => $nicename,
+						'PMD_admin_desc' => $description,
+						'PMD_slug'       => $slug,
+						'PMD_wp_user'    => $user_id,
+						'PMD_scope'      => serialize(array('ADMIN')),
+					);
+					$success = $wpdb->insert(
+						$table_name,
+						$values,
+						array(
+							'%s',//PMD_type
+							'%s',//PMD_name
+							'%s',//PMD_admin_name
+							'%s',//PMD_admin_desc
+							'%s',//PMD_slug
+							'%d',//PMD_wp_user
+							'%s',//PMD_scope
+						)
+					);
+					if ( ! $success) {
+						$this->add_error(sprintf(__("Could not insert new admin-only payment method with values %s during migration",
+							"event_espresso"), $this->_json_encode($values)));
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * insert_default_countries
+	 *
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_currencies()
+	{
+		global $wpdb;
+		$currency_table = $wpdb->prefix . "esp_currency";
+		if ($this->_get_table_analysis()->tableExists($currency_table)) {
+			$SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
+			$countries = $wpdb->get_var($SQL);
+			if ( ! $countries) {
+				$SQL = "INSERT INTO $currency_table
 				( CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active) VALUES
 				( 'EUR',  'Euro',  'Euros',  '€',  2,1),
 				( 'AED',  'Dirham',  'Dirhams', 'د.إ',2,1),
@@ -762,10 +762,10 @@ 
 				( 'ZAR',  'Rand',  'Rands',  'R',  2,1),
 				( 'ZMK',  'Kwacha',  'Kwachas',  '',  2,1),
 				( 'ZWD', 'Dollar', 'Dollars', 'Z$', 2,1);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
+				$wpdb->query($SQL);
+			}
+		}
+	}
 
 }
 

core/db_models/EEM_Soft_Delete_Base.model.php

Doc Comments +2 added lines, -2 removed lines

@@ -205,7 +205,7 @@ 
      *
      * @param array  $query_params like EEM_Base::get_all
      * @param string $field_to_sum
-     * @return int
+     * @return double
      */
     public function sum_deleted($query_params = null, $field_to_sum = null)
     {
@@ -270,7 +270,7 @@ 
      * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
      *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
      *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
+     * @return integer success
      */
     public function delete_permanently($query_params = array(), $allow_blocking = true)
     {

Indentation +359 added lines, -359 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Base.model.php');
 
@@ -32,362 +32,362 @@ 
 abstract class EEM_Soft_Delete_Base extends EEM_Base
 {
 
-    /**
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
-            $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Searches for field on this model of type 'deleted_flag'. if it is found,
-     * returns it's name.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function deleted_field_name()
-    {
-        $field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
-        if ($field) {
-            return $field->get_name();
-        } else {
-            throw new EE_Error(sprintf(__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
-                'event_espresso'), get_class($this), get_class($this)));
-        }
-    }
-
-
-
-    /**
-     * Gets one item that's been deleted, according to $query_params
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets one item from the DB, regardless of whether it's been soft-deleted or not
-     *
-     * @param array $query_params like EEM_base::get_all's $query_params
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_deleted_or_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_one($query_params);
-    }
-
-
-
-    /**
-     * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
-     *
-     * @param int|string $id
-     * @return EE_Soft_Delete_Base_Class
-     */
-    public function get_one_by_ID_but_ignore_deleted($id)
-    {
-        return $this->get_one(
-            $this->alter_query_params_to_restrict_by_ID(
-                $id,
-                array('default_where_conditions' => 'default')
-            )
-        );
-    }
-
-
-
-    /**
-     * Counts all the deleted/trashed items
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return array like EEM_Base::get_all's $query_params
-     */
-    protected function _alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params[0][$deletedFlagFieldName] = true;
-        return $query_params;
-    }
-
-
-
-    /**
-     * Alters the query params so that only trashed/soft-deleted items are considered
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @return array like EEM_Base::get_all's $query_params
-     */
-    public function alter_query_params_so_only_trashed_items_included($query_params)
-    {
-        return $this->_alter_query_params_so_only_trashed_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
-    {
-        return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-    }
-
-
-
-    /**
-     * Alters the query params so each item's deleted status is ignored.
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'minimum';
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Counts all deleted and undeleted items
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_count
-     * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
-     * @return int
-     */
-    public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::count($query_params, $field_to_count, $distinct);
-    }
-
-
-
-    /**
-     * Sum all the deleted items.
-     *
-     * @param array  $query_params like EEM_Base::get_all
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Sums all the deleted and undeleted items.
-     *
-     * @param array  $query_params lik eEEM_Base::get_all
-     * @param string $field_to_sum
-     * @return int
-     */
-    public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        parent::sum($query_params, $field_to_sum);
-    }
-
-
-
-    /**
-     * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
-     * whether they've been soft-deleted or not
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted_and_undeleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Soft_Delete_Base_Class[]
-     */
-    public function get_all_deleted($query_params = array())
-    {
-        $query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
-        return parent::get_all($query_params);
-    }
-
-
-
-    /**
-     * Permanently deletes the selected rows. When selecting rows for deletion, ignores
-     * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
-     * before you can permanently delete them).
-     * Because this will cause a real deletion, related models may block this deletion (ie, add an error
-     * and abort the delete)
-     *
-     * @param array   $query_params   like EEM_Base::get_all
-     * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
-     *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
-     * @return boolean success
-     */
-    public function delete_permanently($query_params = array(), $allow_blocking = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return parent::delete_permanently($query_params, $allow_blocking);
-    }
-
-
-
-    /**
-     * Restores a particular item by its ID (primary key). Ignores the fact whether the item
-     * has been soft-deleted or not.
-     *
-     * @param mixed $ID int if primary key is an int, string otherwise
-     * @return boolean success
-     */
-    public function restore_by_ID($ID = false)
-    {
-        return $this->delete_or_restore_by_ID(false, $ID);
-    }
-
-
-
-    /**
-     * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
-     * this function will ignore whether the items have been soft-deleted or not.
-     *
-     * @param boolean $delete true for delete, false for restore
-     * @param mixed   $ID     int if primary key is an int, string otherwise
-     * @return boolean
-     */
-    public function delete_or_restore_by_ID($delete = true, $ID = false)
-    {
-        if (! $ID) {
-            return false;
-        }
-        if (
-        $this->delete_or_restore(
-            $delete,
-            $this->alter_query_params_to_restrict_by_ID($ID)
-        )
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent's 'delete' method to instead do a soft delete on all rows that
-     * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
-     * Note: because this item will be soft-deleted only,
-     * doesn't block because of model dependencies
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @param bool  $block_deletes
-     * @return boolean
-     */
-    public function delete($query_params = array(), $block_deletes = false)
-    {
-        //no matter what, we WON'T block soft deletes.
-        return $this->delete_or_restore(true, $query_params);
-    }
-
-
-
-    /**
-     * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
-     * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return boolean
-     */
-    public function restore($query_params = array())
-    {
-        return $this->delete_or_restore(false, $query_params);
-    }
-
-
-
-    /**
-     * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
-     *
-     * @param boolean $delete       true to indicate deletion, false to indicate restoration
-     * @param array   $query_params like EEM_Base::get_all
-     * @return boolean
-     */
-    function delete_or_restore($delete = true, $query_params = array())
-    {
-        $deletedFlagFieldName = $this->deleted_field_name();
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Updates all the items of this model which match the $query params, regardless of whether
-     * they've been soft-deleted or not
-     *
-     * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
-     * @param array   $query_params            like EEM_base::get_all's $query_params
-     * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
-     *                                         in this model's entity map according to $fields_n_values that match $query_params. This
-     *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
-     *                                         be aware that model objects being used could get out-of-sync with the database
-     * @return int number of items updated
-     */
-    public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
-    {
-        $query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
-    }
+	/**
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+			$this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Searches for field on this model of type 'deleted_flag'. if it is found,
+	 * returns it's name.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function deleted_field_name()
+	{
+		$field = $this->get_a_field_of_type('EE_Trashed_Flag_Field');
+		if ($field) {
+			return $field->get_name();
+		} else {
+			throw new EE_Error(sprintf(__('We are trying to find the deleted flag field on %s, but none was found. Are you sure there is a field of type EE_Trashed_Flag_Field in %s constructor?',
+				'event_espresso'), get_class($this), get_class($this)));
+		}
+	}
+
+
+
+	/**
+	 * Gets one item that's been deleted, according to $query_params
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets one item from the DB, regardless of whether it's been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_base::get_all's $query_params
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_deleted_or_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_one($query_params);
+	}
+
+
+
+	/**
+	 * Gets the item indicated by its ID. But if it's soft-deleted, pretends it doesn't exist.
+	 *
+	 * @param int|string $id
+	 * @return EE_Soft_Delete_Base_Class
+	 */
+	public function get_one_by_ID_but_ignore_deleted($id)
+	{
+		return $this->get_one(
+			$this->alter_query_params_to_restrict_by_ID(
+				$id,
+				array('default_where_conditions' => 'default')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Counts all the deleted/trashed items
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return array like EEM_Base::get_all's $query_params
+	 */
+	protected function _alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params[0][$deletedFlagFieldName] = true;
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Alters the query params so that only trashed/soft-deleted items are considered
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @return array like EEM_Base::get_all's $query_params
+	 */
+	public function alter_query_params_so_only_trashed_items_included($query_params)
+	{
+		return $this->_alter_query_params_so_only_trashed_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	public function alter_query_params_so_deleted_and_undeleted_items_included($query_params = array())
+	{
+		return $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+	}
+
+
+
+	/**
+	 * Alters the query params so each item's deleted status is ignored.
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'minimum';
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Counts all deleted and undeleted items
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_count
+	 * @param bool   $distinct     if we want to only count the distinct values for the column then you can trigger that by the setting $distinct to TRUE;
+	 * @return int
+	 */
+	public function count_deleted_and_undeleted($query_params = null, $field_to_count = null, $distinct = false)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::count($query_params, $field_to_count, $distinct);
+	}
+
+
+
+	/**
+	 * Sum all the deleted items.
+	 *
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Sums all the deleted and undeleted items.
+	 *
+	 * @param array  $query_params lik eEEM_Base::get_all
+	 * @param string $field_to_sum
+	 * @return int
+	 */
+	public function sum_deleted_and_undeleted($query_params = null, $field_to_sum = null)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		parent::sum($query_params, $field_to_sum);
+	}
+
+
+
+	/**
+	 * Gets all deleted and undeleted mode objects from the db that meet the criteria, regardless of
+	 * whether they've been soft-deleted or not
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted_and_undeleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * For 'soft deletable' models, gets all which ARE deleted, according to conditions specified in $query_params.
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Soft_Delete_Base_Class[]
+	 */
+	public function get_all_deleted($query_params = array())
+	{
+		$query_params = $this->_alter_query_params_so_only_trashed_items_included($query_params);
+		return parent::get_all($query_params);
+	}
+
+
+
+	/**
+	 * Permanently deletes the selected rows. When selecting rows for deletion, ignores
+	 * whether they've been soft-deleted or not. (ie, you don't have to soft-delete objects
+	 * before you can permanently delete them).
+	 * Because this will cause a real deletion, related models may block this deletion (ie, add an error
+	 * and abort the delete)
+	 *
+	 * @param array   $query_params   like EEM_Base::get_all
+	 * @param boolean $allow_blocking if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data); if false, deletes regardless of other objects
+	 *                                which may depend on it. Its generally advisable to always leave this as TRUE, otherwise you could easily corrupt your DB
+	 * @return boolean success
+	 */
+	public function delete_permanently($query_params = array(), $allow_blocking = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return parent::delete_permanently($query_params, $allow_blocking);
+	}
+
+
+
+	/**
+	 * Restores a particular item by its ID (primary key). Ignores the fact whether the item
+	 * has been soft-deleted or not.
+	 *
+	 * @param mixed $ID int if primary key is an int, string otherwise
+	 * @return boolean success
+	 */
+	public function restore_by_ID($ID = false)
+	{
+		return $this->delete_or_restore_by_ID(false, $ID);
+	}
+
+
+
+	/**
+	 * For deleting or restoring a particular item. Note that this model is a SOFT-DELETABLE model! However,
+	 * this function will ignore whether the items have been soft-deleted or not.
+	 *
+	 * @param boolean $delete true for delete, false for restore
+	 * @param mixed   $ID     int if primary key is an int, string otherwise
+	 * @return boolean
+	 */
+	public function delete_or_restore_by_ID($delete = true, $ID = false)
+	{
+		if (! $ID) {
+			return false;
+		}
+		if (
+		$this->delete_or_restore(
+			$delete,
+			$this->alter_query_params_to_restrict_by_ID($ID)
+		)
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent's 'delete' method to instead do a soft delete on all rows that
+	 * meet the criteria in $where_col_n_values. This particular function ignores whether the items have been soft-deleted or not.
+	 * Note: because this item will be soft-deleted only,
+	 * doesn't block because of model dependencies
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @param bool  $block_deletes
+	 * @return boolean
+	 */
+	public function delete($query_params = array(), $block_deletes = false)
+	{
+		//no matter what, we WON'T block soft deletes.
+		return $this->delete_or_restore(true, $query_params);
+	}
+
+
+
+	/**
+	 * 'Un-deletes' the chosen items. Note that this model is a SOFT-DELETABLE model! That means that, by default, trashed/soft-deleted
+	 * items are ignored in queries. However, this particular function ignores whether the items have been soft-deleted or not.
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return boolean
+	 */
+	public function restore($query_params = array())
+	{
+		return $this->delete_or_restore(false, $query_params);
+	}
+
+
+
+	/**
+	 * Performs deletes or restores on items. Both soft-deleted and non-soft-deleted items considered.
+	 *
+	 * @param boolean $delete       true to indicate deletion, false to indicate restoration
+	 * @param array   $query_params like EEM_Base::get_all
+	 * @return boolean
+	 */
+	function delete_or_restore($delete = true, $query_params = array())
+	{
+		$deletedFlagFieldName = $this->deleted_field_name();
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		if ($this->update(array($deletedFlagFieldName => $delete), $query_params)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Updates all the items of this model which match the $query params, regardless of whether
+	 * they've been soft-deleted or not
+	 *
+	 * @param array   $fields_n_values         like EEM_Base::update's $fields_n_value
+	 * @param array   $query_params            like EEM_base::get_all's $query_params
+	 * @param boolean $keep_model_objs_in_sync if TRUE, makes sure we ALSO update model objects
+	 *                                         in this model's entity map according to $fields_n_values that match $query_params. This
+	 *                                         obviously has some overhead, so you can disable it by setting this to FALSE, but
+	 *                                         be aware that model objects being used could get out-of-sync with the database
+	 * @return int number of items updated
+	 */
+	public function update_deleted_and_undeleted($fields_n_values, $query_params, $keep_model_objs_in_sync = true)
+	{
+		$query_params = $this->_alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		return $this->update($fields_n_values, $query_params, $keep_model_objs_in_sync);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -1,7 +1,7 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 
 
@@ -37,7 +37,7 @@ 
      */
     protected function __construct($timezone = null)
     {
-        if (! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
+        if ( ! $this->_default_where_conditions_strategy instanceof EE_Default_Where_Conditions) {
             $this->_default_where_conditions_strategy = new EE_Soft_Delete_Where_Conditions();
         }
         parent::__construct($timezone);
@@ -176,7 +176,7 @@ 
      */
     protected function _alter_query_params_so_deleted_and_undeleted_items_included($query_params)
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'minimum';
         }
         return $query_params;
@@ -304,7 +304,7 @@ 
      */
     public function delete_or_restore_by_ID($delete = true, $ID = false)
     {
-        if (! $ID) {
+        if ( ! $ID) {
             return false;
         }
         if (