eventespresso / event-espresso-core

core/db_classes/EE_Attendee.class.php

Spacing +12 added lines, -12 removed lines

@@ -36,16 +36,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -325,7 +325,7 @@ 
         $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
@@ -340,7 +340,7 @@ 
         }
         // lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -622,18 +622,18 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
         // double-check the form isn't totally hidden, in which case pretend there is no form
         $form_totally_hidden = true;
         foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+            if ( ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
                 $form_totally_hidden = false;
                 break;
             }
@@ -660,7 +660,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         }
         return null;
     }
@@ -677,7 +677,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(esc_html__('Cannot save billing info because there is none.', 'event_espresso'));
             return false;
         }

Indentation +742 added lines, -742 removed lines

@@ -25,746 +25,746 @@
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, EEI_Address, EEI_Admin_Links, EEI_Attendee
 {
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            // $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     * @throws EE_Error
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     * @throws EE_Error
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     * @throws EE_Error
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     * @throws EE_Error
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     * @throws EE_Error
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     * @throws EE_Error
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     * @throws EE_Error
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     * @throws EE_Error
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     * @throws EE_Error
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     * @throws EE_Error
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     * @throws EE_Error
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_full_name()
-    {
-        echo $this->full_name(); // sanitized
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname(),
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     * @throws EE_Error
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        // now handle state and country
-        $state_obj = $this->state_obj();
-        if ($state_obj instanceof EE_State) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if ($country_obj instanceof EE_Country) {
-            $full_address_array[] = $country_obj->name();
-        }
-        // lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address()
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address2()
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function city()
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     *        get Attendee State ID
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State
-     * @throws EE_Error
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_name()
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        }
-        return $this->state_name();
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country
-     * @throws EE_Error
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_name()
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        }
-        return '';
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        }
-        return $this->country_name();
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function zip()
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related(
-            'Registration',
-            array('order_by' => array('REG_date' => 'DESC'))
-        ); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related(
-            'Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
-        );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     * @throws EE_Error
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        // double-check the form isn't totally hidden, in which case pretend there is no form
-        $form_totally_hidden = true;
-        foreach ($billing_form->inputs_in_subsections() as $input) {
-            if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-                $form_totally_hidden = false;
-                break;
-            }
-        }
-        if ($form_totally_hidden) {
-            return null;
-        }
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        }
-        return null;
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(esc_html__('Cannot save billing info because there is none.', 'event_espresso'));
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta(
-            $this->ID(),
-            $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true)
-        );
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			// $fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 * @throws EE_Error
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 * @throws EE_Error
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 * @throws EE_Error
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 * @throws EE_Error
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 * @throws EE_Error
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 * @throws EE_Error
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 * @throws EE_Error
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 * @throws EE_Error
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 * @throws EE_Error
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 * @throws EE_Error
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 * @throws EE_Error
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_full_name()
+	{
+		echo $this->full_name(); // sanitized
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname(),
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		// now handle state and country
+		$state_obj = $this->state_obj();
+		if ($state_obj instanceof EE_State) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if ($country_obj instanceof EE_Country) {
+			$full_address_array[] = $country_obj->name();
+		}
+		// lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address()
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address2()
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function city()
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 *        get Attendee State ID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State
+	 * @throws EE_Error
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_name()
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		}
+		return $this->state_name();
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country
+	 * @throws EE_Error
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_name()
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		}
+		return '';
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		}
+		return $this->country_name();
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function zip()
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related(
+			'Registration',
+			array('order_by' => array('REG_date' => 'DESC'))
+		); // null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related(
+			'Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
+		);
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 * @throws EE_Error
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		// double-check the form isn't totally hidden, in which case pretend there is no form
+		$form_totally_hidden = true;
+		foreach ($billing_form->inputs_in_subsections() as $input) {
+			if (! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+				$form_totally_hidden = false;
+				break;
+			}
+		}
+		if ($form_totally_hidden) {
+			return null;
+		}
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(esc_html__('Cannot save billing info because there is none.', 'event_espresso'));
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta(
+			$this->ID(),
+			$this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true)
+		);
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

core/db_classes/EE_Ticket.class.php

Indentation +1724 added lines, -1724 removed lines

@@ -14,1732 +14,1732 @@
 class EE_Ticket extends EE_Soft_Delete_Base_Class implements EEI_Line_Item_Object, EEI_Event_Relation, EEI_Has_Icon
 {
 
-    /**
-     * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
-     */
-    const sold_out = 'TKS';
-
-    /**
-     *
-     */
-    const expired = 'TKE';
-
-    /**
-     *
-     */
-    const archived = 'TKA';
-
-    /**
-     *
-     */
-    const pending = 'TKP';
-
-    /**
-     *
-     */
-    const onsale = 'TKO';
-
-    /**
-     * extra meta key for tracking ticket reservations
-     *
-     * @type string
-     */
-    const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
-
-    /**
-     * cached result from method of the same name
-     *
-     * @var float $_ticket_total_with_taxes
-     */
-    private $_ticket_total_with_taxes;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Ticket
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Ticket
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function parent()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function available($DTT_ID = 0)
-    {
-        // are we checking availability for a particular datetime ?
-        if ($DTT_ID) {
-            // get that datetime object
-            $datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
-            // if  ticket sales for this datetime have exceeded the reg limit...
-            if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
-                return false;
-            }
-        }
-        // datetime is still open for registration, but is this ticket sold out ?
-        return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
-    }
-
-
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
-     *                               relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
-     *               further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws EE_Error
-     */
-    public function ticket_status($display = false, $remaining = null)
-    {
-        $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
-        }
-        if ($this->get('TKT_deleted')) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
-        }
-        if ($this->is_expired()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
-        }
-        if ($this->is_pending()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
-        }
-        if ($this->is_on_sale()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
-        }
-        return '';
-    }
-
-
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
-     * considering ALL the factors used for figuring that out.
-     *
-     * @access public
-     * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws EE_Error
-     */
-    public function is_remaining($DTT_ID = 0)
-    {
-        $num_remaining = $this->remaining($DTT_ID);
-        if ($num_remaining === 0) {
-            return false;
-        }
-        if ($num_remaining > 0 && $num_remaining < $this->min()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws EE_Error
-     */
-    public function remaining($DTT_ID = 0)
-    {
-        return $this->real_quantity_on_ticket('saleable', $DTT_ID);
-    }
-
-
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function min()
-    {
-        return $this->get('TKT_min');
-    }
-
-
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('TKT_end_date') < time());
-    }
-
-
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_pending()
-    {
-        return ($this->get_raw('TKT_start_date') > time());
-    }
-
-
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_on_sale()
-    {
-        return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $dt_frmt
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
-     *                            the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws EE_Error
-     */
-    public function date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
-        $first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
-            : '';
-        $last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $dt_frmt) : '';
-
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
-    }
-
-
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        $datetimes = $this->datetimes(array('limit' => 1));
-        return reset($datetimes);
-    }
-
-
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by']['DTT_order'] = 'ASC';
-        }
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function last_datetime()
-    {
-        $datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
-        return end($datetimes);
-    }
-
-
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws EE_Error
-     */
-    public function tickets_sold($what = 'ticket', $dtt_id = null)
-    {
-        $total = 0;
-        $tickets_sold = $this->_all_tickets_sold();
-        switch ($what) {
-            case 'ticket':
-                return $tickets_sold['ticket'];
-                break;
-            case 'datetime':
-                if (empty($tickets_sold['datetime'])) {
-                    return $total;
-                }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return $total;
-                }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
-                break;
-            default:
-                return $total;
-        }
-    }
-
-
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    protected function _all_tickets_sold()
-    {
-        $datetimes = $this->get_many_related('Datetime');
-        $tickets_sold = array();
-        if (! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
-            }
-        }
-        // Tickets sold
-        $tickets_sold['ticket'] = $this->sold();
-        return $tickets_sold;
-    }
-
-
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param  bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function base_price($return_array = false)
-    {
-        $_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
-        return $return_array
-            ? $this->get_many_related('Price', array($_where))
-            : $this->get_first_related('Price', array($_where));
-    }
-
-
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @access public
-     * @return EE_Price[]
-     * @throws EE_Error
-     */
-    public function price_modifiers()
-    {
-        $query_params = array(
-            0 => array(
-                'Price_Type.PBT_ID' => array(
-                    'NOT IN',
-                    array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax),
-                ),
-            ),
-        );
-        return $this->prices($query_params);
-    }
-
-
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function prices($query_params = array())
-    {
-        return $this->get_many_related('Price', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function datetime_tickets($query_params = array())
-    {
-        return $this->get_many_related('Datetime_Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted
-        );
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     * get the author of the ticket.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('TKT_wp_user');
-    }
-
-
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws EE_Error
-     */
-    public function template()
-    {
-        return $this->get_first_related('Ticket_Template');
-    }
-
-
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws EE_Error
-     */
-    public function get_ticket_taxes_for_admin()
-    {
-        return EE_Taxes::get_taxes_for_admin();
-    }
-
-
-    /**
-     * @return float
-     * @throws EE_Error
-     */
-    public function ticket_price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function pretty_price()
-    {
-        return $this->get_pretty('TKT_price');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_free()
-    {
-        return $this->get_ticket_total_with_taxes() === (float) 0;
-    }
-
-
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws EE_Error
-     */
-    public function get_ticket_total_with_taxes($no_cache = false)
-    {
-        if ($this->_ticket_total_with_taxes === null || $no_cache) {
-            $this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
-        }
-        return (float) $this->_ticket_total_with_taxes;
-    }
-
-
-    public function ensure_TKT_Price_correct()
-    {
-        $this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
-        $this->save();
-    }
-
-
-    /**
-     * @return float
-     * @throws EE_Error
-     */
-    public function get_ticket_subtotal()
-    {
-        return EE_Taxes::get_subtotal_for_admin($this);
-    }
-
-
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function get_ticket_taxes_total_for_admin()
-    {
-        return EE_Taxes::get_total_taxes_for_admin($this);
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('TKT_name', $name);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('TKT_description');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws EE_Error
-     */
-    public function set_description($description)
-    {
-        $this->set('TKT_description', $description);
-    }
-
-
-    /**
-     * Gets start_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws EE_Error
-     */
-    public function start_date($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
-    }
-
-
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_start_date($start_date)
-    {
-        $this->_set_date_time('B', $start_date, 'TKT_start_date');
-    }
-
-
-    /**
-     * Gets end_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws EE_Error
-     */
-    public function end_date($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
-    }
-
-
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_end_date($end_date)
-    {
-        $this->_set_date_time('B', $end_date, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets sell until time
-     *
-     * @since 4.5.0
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws EE_Error
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_min($min)
-    {
-        $this->set('TKT_min', $min);
-    }
-
-
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function max()
-    {
-        return $this->get('TKT_max');
-    }
-
-
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_max($max)
-    {
-        $this->set('TKT_max', $max);
-    }
-
-
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_price($price)
-    {
-        $this->set('TKT_price', $price);
-    }
-
-
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function sold()
-    {
-        return $this->get_raw('TKT_sold');
-    }
-
-
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('TKT_sold', $sold);
-    }
-
-
-    /**
-     * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
-     * associated datetimes.
-     *
-     * @since 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function increaseSold($qty = 1)
-    {
-        $qty = absint($qty);
-        // increment sold and decrement reserved datetime quantities simultaneously
-        // don't worry about failures, because they must have already had a spot reserved
-        $this->increaseSoldForDatetimes($qty);
-        // Increment and decrement ticket quantities simultaneously
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_reserved' => $qty * -1,
-                'TKT_sold' => $qty
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-    /**
-     * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
-     *
-     * @since 4.9.80.p
-     * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
-     *             Negative means to decreases old counts (and increase reserved counts).
-     * @param EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function increaseSoldForDatetimes($qty, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            $datetime->increaseSold($qty);
-        }
-    }
-
-
-
-    /**
-     * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
-     * DB and then updates the model objects.
-     * Does not affect the reserved counts.
-     *
-     * @since 4.9.80.p
-     * @param int $qty
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function decreaseSold($qty = 1)
-    {
-        $qty = absint($qty);
-        $this->decreaseSoldForDatetimes($qty);
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_sold' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__decrease_sold',
-            $this,
-            $qty,
-            $this->sold(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @since 4.9.80.p
-     * @param int $qty
-     * @param EE_Datetime[] $datetimes
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function decreaseSoldForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->decreaseSold($qty);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function reserved()
-    {
-        return $this->get_raw('TKT_reserved');
-    }
-
-
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_reserved($reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, (int) $reserved);
-        $this->set('TKT_reserved', $reserved);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @since 4.9.80.p
-     * @param int    $qty
-     * @param string $source
-     * @return bool whether we successfully reserved the ticket or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function increaseReserved($qty = 1, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved__begin',
-            $this,
-            $qty,
-            $source
-        );
-        $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "{$qty} from {$source}");
-        $success = false;
-        $datetimes_adjusted_successfully = $this->increaseReservedForDatetimes($qty);
-        if ($datetimes_adjusted_successfully) {
-            $success = $this->incrementFieldConditionallyInDb(
-                'TKT_reserved',
-                'TKT_sold',
-                'TKT_qty',
-                $qty
-            );
-            if (! $success) {
-                // The datetimes were successfully bumped, but not the
-                // ticket. So we need to manually rollback the datetimes.
-                $this->decreaseReservedForDatetimes($qty);
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Increases reserved counts on related datetimes
-     *
-     * @since 4.9.80.p
-     * @param int $qty
-     * @param EE_Datetime[] $datetimes
-     * @return boolean indicating success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function increaseReservedForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        $datetimes_updated = [];
-        $limit_exceeded = false;
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    if ($datetime->increaseReserved($qty)) {
-                        $datetimes_updated[] = $datetime;
-                    } else {
-                        $limit_exceeded = true;
-                        break;
-                    }
-                }
-            }
-            // If somewhere along the way we detected a datetime whose
-            // limit was exceeded, do a manual rollback.
-            if ($limit_exceeded) {
-                $this->decreaseReservedForDatetimes($qty, $datetimes_updated);
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @since 4.9.80.p
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function decreaseReserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        $this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "-{$qty} from {$source}");
-        if ($adjust_datetimes) {
-            $this->decreaseReservedForDatetimes($qty);
-        }
-        $success = $this->adjustNumericFieldsInDb(
-            [
-                'TKT_reserved' => $qty * -1
-            ]
-        );
-        do_action(
-            'AHEE__EE_Ticket__decrease_reserved',
-            $this,
-            $qty,
-            $this->reserved(),
-            $success
-        );
-        return $success;
-    }
-
-
-    /**
-     * Decreases the reserved count on the specified datetimes.
-     *
-     * @since 4.9.80.p
-     * @param int           $qty
-     * @param EE_Datetime[] $datetimes
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function decreaseReservedForDatetimes($qty = 1, array $datetimes = [])
-    {
-        $datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $datetime->decreaseReserved($qty);
-            }
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws EE_Error
-     */
-    public function qty($context = '')
-    {
-        switch ($context) {
-            case 'reg_limit':
-                return $this->real_quantity_on_ticket();
-            case 'saleable':
-                return $this->real_quantity_on_ticket('saleable');
-            default:
-                return $this->get_raw('TKT_qty');
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param  int   $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int
-     * @throws EE_Error
-     */
-    public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
-    {
-        $raw = $this->get_raw('TKT_qty');
-        // return immediately if it's zero
-        if ($raw === 0) {
-            return $raw;
-        }
-        // echo "\n\n<br />Ticket: " . $this->name() . '<br />';
-        // ensure qty doesn't exceed raw value for THIS ticket
-        $qty = min(EE_INF, $raw);
-        // echo "\n . qty: " . $qty . '<br />';
-        // calculate this ticket's total sales and reservations
-        $sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
-        // echo "\n . sold: " . $this->sold() . '<br />';
-        // echo "\n . reserved: " . $this->reserved() . '<br />';
-        // echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
-        // first we need to calculate the maximum number of tickets available for the datetime
-        // do we want data for one datetime or all of them ?
-        $query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
-        $datetimes = $this->datetimes($query_params);
-        if (is_array($datetimes) && ! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->refresh_from_db();
-                    // echo "\n . . datetime name: " . $datetime->name() . '<br />';
-                    // echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
-                    // initialize with no restrictions for each datetime
-                    // but adjust datetime qty based on datetime reg limit
-                    $datetime_qty = min(EE_INF, $datetime->reg_limit());
-                    // echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
-                    // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    // if we want the actual saleable amount, then we need to consider OTHER ticket sales
-                    // and reservations for this datetime, that do NOT include sales and reservations
-                    // for this ticket (so we add $this->sold() and $this->reserved() back in)
-                    if ($context === 'saleable') {
-                        $datetime_qty = max(
-                            $datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
-                            0
-                        );
-                        // echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
-                        // echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
-                        // echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                        $datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    }
-                    $qty = min($datetime_qty, $qty);
-                    // echo "\n . . qty: " . $qty . '<br />';
-                }
-            }
-        }
-        // NOW that we know the  maximum number of tickets available for the datetime
-        // we can finally factor in the details for this specific ticket
-        if ($qty > 0 && $context === 'saleable') {
-            // and subtract the sales for THIS ticket
-            $qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
-            // echo "\n . qty: " . $qty . '<br />';
-        }
-        // echo "\nFINAL QTY: " . $qty . "<br /><br />";
-        return $qty;
-    }
-
-
-    /**
-     * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_qty($qty)
-    {
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $qty = min($qty, $datetime->reg_limit());
-            }
-        }
-        $this->set('TKT_qty', $qty);
-    }
-
-
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function uses()
-    {
-        return $this->get('TKT_uses');
-    }
-
-
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_uses($uses)
-    {
-        $this->set('TKT_uses', $uses);
-    }
-
-
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function required()
-    {
-        return $this->get('TKT_required');
-    }
-
-
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_required($required)
-    {
-        $this->set('TKT_required', $required);
-    }
-
-
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function taxable()
-    {
-        return $this->get('TKT_taxable');
-    }
-
-
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_taxable($taxable)
-    {
-        $this->set('TKT_taxable', $taxable);
-    }
-
-
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_default()
-    {
-        return $this->get('TKT_is_default');
-    }
-
-
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_is_default($is_default)
-    {
-        $this->set('TKT_is_default', $is_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('TKT_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('TKT_order', $order);
-    }
-
-
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function row()
-    {
-        return $this->get('TKT_row');
-    }
-
-
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_row($row)
-    {
-        $this->set('TKT_row', $row);
-    }
-
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('TKT_deleted');
-    }
-
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_deleted($deleted)
-    {
-        $this->set('TKT_deleted', $deleted);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function parent_ID()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('TKT_parent', $parent);
-    }
-
-
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name_and_info()
-    {
-        $times = array();
-        foreach ($this->datetimes() as $datetime) {
-            $times[] = $datetime->start_date_and_time();
-        }
-        return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('TKT_name');
-    }
-
-
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function update_tickets_sold()
-    {
-        $count_regs_for_this_ticket = $this->count_registrations(
-            array(
-                array(
-                    'STS_ID'      => EEM_Registration::status_id_approved,
-                    'REG_deleted' => 0,
-                ),
-            )
-        );
-        $this->set_sold($count_regs_for_this_ticket);
-        $this->save();
-        return $count_regs_for_this_ticket;
-    }
-
-
-    /**
-     * Counts the registrations for this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     */
-    public function count_registrations($query_params = array())
-    {
-        return $this->count_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-tickets-alt"></span>';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function get_related_event()
-    {
-        // get one datetime to use for getting the event
-        $datetime = $this->first_datetime();
-        if (! $datetime instanceof \EE_Datetime) {
-            throw new UnexpectedEntityException(
-                $datetime,
-                'EE_Datetime',
-                sprintf(
-                    esc_html__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        $event = $datetime->event();
-        if (! $event instanceof \EE_Event) {
-            throw new UnexpectedEntityException(
-                $event,
-                'EE_Event',
-                sprintf(
-                    esc_html__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        return $event;
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function get_event_name()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->name() : '';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function get_event_ID()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->ID() : 0;
-    }
-
-
-    /**
-     * This simply returns whether a ticket can be permanently deleted or not.
-     * The criteria for determining this is whether the ticket has any related registrations.
-     * If there are none then it can be permanently deleted.
-     *
-     * @return bool
-     */
-    public function is_permanently_deleteable()
-    {
-        return $this->count_registrations() === 0;
-    }
-
-
-    /*******************************************************************
+	/**
+	 * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
+	 */
+	const sold_out = 'TKS';
+
+	/**
+	 *
+	 */
+	const expired = 'TKE';
+
+	/**
+	 *
+	 */
+	const archived = 'TKA';
+
+	/**
+	 *
+	 */
+	const pending = 'TKP';
+
+	/**
+	 *
+	 */
+	const onsale = 'TKO';
+
+	/**
+	 * extra meta key for tracking ticket reservations
+	 *
+	 * @type string
+	 */
+	const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
+
+	/**
+	 * cached result from method of the same name
+	 *
+	 * @var float $_ticket_total_with_taxes
+	 */
+	private $_ticket_total_with_taxes;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Ticket
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Ticket
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function parent()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function available($DTT_ID = 0)
+	{
+		// are we checking availability for a particular datetime ?
+		if ($DTT_ID) {
+			// get that datetime object
+			$datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
+			// if  ticket sales for this datetime have exceeded the reg limit...
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
+				return false;
+			}
+		}
+		// datetime is still open for registration, but is this ticket sold out ?
+		return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
+	}
+
+
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
+	 *                               relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
+	 *               further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws EE_Error
+	 */
+	public function ticket_status($display = false, $remaining = null)
+	{
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if (! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
+		}
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
+		}
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
+		}
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
+		}
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
+		}
+		return '';
+	}
+
+
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
+	 * considering ALL the factors used for figuring that out.
+	 *
+	 * @access public
+	 * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws EE_Error
+	 */
+	public function is_remaining($DTT_ID = 0)
+	{
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
+			return false;
+		}
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function remaining($DTT_ID = 0)
+	{
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
+	}
+
+
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function min()
+	{
+		return $this->get('TKT_min');
+	}
+
+
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('TKT_end_date') < time());
+	}
+
+
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_pending()
+	{
+		return ($this->get_raw('TKT_start_date') > time());
+	}
+
+
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_on_sale()
+	{
+		return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $dt_frmt
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
+	 *                            the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
+			: '';
+		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $dt_frmt) : '';
+
+		return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+	}
+
+
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		$datetimes = $this->datetimes(array('limit' => 1));
+		return reset($datetimes);
+	}
+
+
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
+		}
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function last_datetime()
+	{
+		$datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
+		return end($datetimes);
+	}
+
+
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws EE_Error
+	 */
+	public function tickets_sold($what = 'ticket', $dtt_id = null)
+	{
+		$total = 0;
+		$tickets_sold = $this->_all_tickets_sold();
+		switch ($what) {
+			case 'ticket':
+				return $tickets_sold['ticket'];
+				break;
+			case 'datetime':
+				if (empty($tickets_sold['datetime'])) {
+					return $total;
+				}
+				if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+					EE_Error::add_error(
+						esc_html__(
+							'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return $total;
+				}
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+				break;
+			default:
+				return $total;
+		}
+	}
+
+
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	protected function _all_tickets_sold()
+	{
+		$datetimes = $this->get_many_related('Datetime');
+		$tickets_sold = array();
+		if (! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+			}
+		}
+		// Tickets sold
+		$tickets_sold['ticket'] = $this->sold();
+		return $tickets_sold;
+	}
+
+
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param  bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function base_price($return_array = false)
+	{
+		$_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
+		return $return_array
+			? $this->get_many_related('Price', array($_where))
+			: $this->get_first_related('Price', array($_where));
+	}
+
+
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @access public
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 */
+	public function price_modifiers()
+	{
+		$query_params = array(
+			0 => array(
+				'Price_Type.PBT_ID' => array(
+					'NOT IN',
+					array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax),
+				),
+			),
+		);
+		return $this->prices($query_params);
+	}
+
+
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function prices($query_params = array())
+	{
+		return $this->get_many_related('Price', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function datetime_tickets($query_params = array())
+	{
+		return $this->get_many_related('Datetime_Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted
+		);
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('TKT_wp_user');
+	}
+
+
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function template()
+	{
+		return $this->get_first_related('Ticket_Template');
+	}
+
+
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws EE_Error
+	 */
+	public function get_ticket_taxes_for_admin()
+	{
+		return EE_Taxes::get_taxes_for_admin();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function ticket_price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function pretty_price()
+	{
+		return $this->get_pretty('TKT_price');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_free()
+	{
+		return $this->get_ticket_total_with_taxes() === (float) 0;
+	}
+
+
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function get_ticket_total_with_taxes($no_cache = false)
+	{
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
+			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
+		}
+		return (float) $this->_ticket_total_with_taxes;
+	}
+
+
+	public function ensure_TKT_Price_correct()
+	{
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
+		$this->save();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function get_ticket_subtotal()
+	{
+		return EE_Taxes::get_subtotal_for_admin($this);
+	}
+
+
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function get_ticket_taxes_total_for_admin()
+	{
+		return EE_Taxes::get_total_taxes_for_admin($this);
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('TKT_name', $name);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('TKT_description');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws EE_Error
+	 */
+	public function set_description($description)
+	{
+		$this->set('TKT_description', $description);
+	}
+
+
+	/**
+	 * Gets start_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function start_date($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
+	}
+
+
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_start_date($start_date)
+	{
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
+	}
+
+
+	/**
+	 * Gets end_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function end_date($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
+	}
+
+
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_end_date($end_date)
+	{
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets sell until time
+	 *
+	 * @since 4.5.0
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws EE_Error
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_min($min)
+	{
+		$this->set('TKT_min', $min);
+	}
+
+
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function max()
+	{
+		return $this->get('TKT_max');
+	}
+
+
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_max($max)
+	{
+		$this->set('TKT_max', $max);
+	}
+
+
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_price($price)
+	{
+		$this->set('TKT_price', $price);
+	}
+
+
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function sold()
+	{
+		return $this->get_raw('TKT_sold');
+	}
+
+
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
+	}
+
+
+	/**
+	 * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
+	 * associated datetimes.
+	 *
+	 * @since 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function increaseSold($qty = 1)
+	{
+		$qty = absint($qty);
+		// increment sold and decrement reserved datetime quantities simultaneously
+		// don't worry about failures, because they must have already had a spot reserved
+		$this->increaseSoldForDatetimes($qty);
+		// Increment and decrement ticket quantities simultaneously
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_reserved' => $qty * -1,
+				'TKT_sold' => $qty
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+	/**
+	 * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
+	 *
+	 * @since 4.9.80.p
+	 * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
+	 *             Negative means to decreases old counts (and increase reserved counts).
+	 * @param EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function increaseSoldForDatetimes($qty, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			$datetime->increaseSold($qty);
+		}
+	}
+
+
+
+	/**
+	 * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
+	 * DB and then updates the model objects.
+	 * Does not affect the reserved counts.
+	 *
+	 * @since 4.9.80.p
+	 * @param int $qty
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function decreaseSold($qty = 1)
+	{
+		$qty = absint($qty);
+		$this->decreaseSoldForDatetimes($qty);
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_sold' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__decrease_sold',
+			$this,
+			$qty,
+			$this->sold(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @since 4.9.80.p
+	 * @param int $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function decreaseSoldForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decreaseSold($qty);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function reserved()
+	{
+		return $this->get_raw('TKT_reserved');
+	}
+
+
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_reserved($reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @since 4.9.80.p
+	 * @param int    $qty
+	 * @param string $source
+	 * @return bool whether we successfully reserved the ticket or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function increaseReserved($qty = 1, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved__begin',
+			$this,
+			$qty,
+			$source
+		);
+		$this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "{$qty} from {$source}");
+		$success = false;
+		$datetimes_adjusted_successfully = $this->increaseReservedForDatetimes($qty);
+		if ($datetimes_adjusted_successfully) {
+			$success = $this->incrementFieldConditionallyInDb(
+				'TKT_reserved',
+				'TKT_sold',
+				'TKT_qty',
+				$qty
+			);
+			if (! $success) {
+				// The datetimes were successfully bumped, but not the
+				// ticket. So we need to manually rollback the datetimes.
+				$this->decreaseReservedForDatetimes($qty);
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Increases reserved counts on related datetimes
+	 *
+	 * @since 4.9.80.p
+	 * @param int $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @return boolean indicating success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function increaseReservedForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		$datetimes_updated = [];
+		$limit_exceeded = false;
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					if ($datetime->increaseReserved($qty)) {
+						$datetimes_updated[] = $datetime;
+					} else {
+						$limit_exceeded = true;
+						break;
+					}
+				}
+			}
+			// If somewhere along the way we detected a datetime whose
+			// limit was exceeded, do a manual rollback.
+			if ($limit_exceeded) {
+				$this->decreaseReservedForDatetimes($qty, $datetimes_updated);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @since 4.9.80.p
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function decreaseReserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		$this->add_extra_meta(EE_Ticket::META_KEY_TICKET_RESERVATIONS, "-{$qty} from {$source}");
+		if ($adjust_datetimes) {
+			$this->decreaseReservedForDatetimes($qty);
+		}
+		$success = $this->adjustNumericFieldsInDb(
+			[
+				'TKT_reserved' => $qty * -1
+			]
+		);
+		do_action(
+			'AHEE__EE_Ticket__decrease_reserved',
+			$this,
+			$qty,
+			$this->reserved(),
+			$success
+		);
+		return $success;
+	}
+
+
+	/**
+	 * Decreases the reserved count on the specified datetimes.
+	 *
+	 * @since 4.9.80.p
+	 * @param int           $qty
+	 * @param EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function decreaseReservedForDatetimes($qty = 1, array $datetimes = [])
+	{
+		$datetimes = ! empty($datetimes) ? $datetimes : $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$datetime->decreaseReserved($qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function qty($context = '')
+	{
+		switch ($context) {
+			case 'reg_limit':
+				return $this->real_quantity_on_ticket();
+			case 'saleable':
+				return $this->real_quantity_on_ticket('saleable');
+			default:
+				return $this->get_raw('TKT_qty');
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param  int   $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
+	{
+		$raw = $this->get_raw('TKT_qty');
+		// return immediately if it's zero
+		if ($raw === 0) {
+			return $raw;
+		}
+		// echo "\n\n<br />Ticket: " . $this->name() . '<br />';
+		// ensure qty doesn't exceed raw value for THIS ticket
+		$qty = min(EE_INF, $raw);
+		// echo "\n . qty: " . $qty . '<br />';
+		// calculate this ticket's total sales and reservations
+		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
+		// echo "\n . sold: " . $this->sold() . '<br />';
+		// echo "\n . reserved: " . $this->reserved() . '<br />';
+		// echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
+		// first we need to calculate the maximum number of tickets available for the datetime
+		// do we want data for one datetime or all of them ?
+		$query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
+		$datetimes = $this->datetimes($query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->refresh_from_db();
+					// echo "\n . . datetime name: " . $datetime->name() . '<br />';
+					// echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
+					// initialize with no restrictions for each datetime
+					// but adjust datetime qty based on datetime reg limit
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
+					// echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
+					// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
+					// and reservations for this datetime, that do NOT include sales and reservations
+					// for this ticket (so we add $this->sold() and $this->reserved() back in)
+					if ($context === 'saleable') {
+						$datetime_qty = max(
+							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
+							0
+						);
+						// echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
+						// echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
+						// echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					}
+					$qty = min($datetime_qty, $qty);
+					// echo "\n . . qty: " . $qty . '<br />';
+				}
+			}
+		}
+		// NOW that we know the  maximum number of tickets available for the datetime
+		// we can finally factor in the details for this specific ticket
+		if ($qty > 0 && $context === 'saleable') {
+			// and subtract the sales for THIS ticket
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
+			// echo "\n . qty: " . $qty . '<br />';
+		}
+		// echo "\nFINAL QTY: " . $qty . "<br /><br />";
+		return $qty;
+	}
+
+
+	/**
+	 * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_qty($qty)
+	{
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
+			}
+		}
+		$this->set('TKT_qty', $qty);
+	}
+
+
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function uses()
+	{
+		return $this->get('TKT_uses');
+	}
+
+
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_uses($uses)
+	{
+		$this->set('TKT_uses', $uses);
+	}
+
+
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function required()
+	{
+		return $this->get('TKT_required');
+	}
+
+
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_required($required)
+	{
+		$this->set('TKT_required', $required);
+	}
+
+
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function taxable()
+	{
+		return $this->get('TKT_taxable');
+	}
+
+
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_taxable($taxable)
+	{
+		$this->set('TKT_taxable', $taxable);
+	}
+
+
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_default()
+	{
+		return $this->get('TKT_is_default');
+	}
+
+
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_is_default($is_default)
+	{
+		$this->set('TKT_is_default', $is_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('TKT_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('TKT_order', $order);
+	}
+
+
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function row()
+	{
+		return $this->get('TKT_row');
+	}
+
+
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_row($row)
+	{
+		$this->set('TKT_row', $row);
+	}
+
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('TKT_deleted');
+	}
+
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_deleted($deleted)
+	{
+		$this->set('TKT_deleted', $deleted);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function parent_ID()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('TKT_parent', $parent);
+	}
+
+
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name_and_info()
+	{
+		$times = array();
+		foreach ($this->datetimes() as $datetime) {
+			$times[] = $datetime->start_date_and_time();
+		}
+		return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('TKT_name');
+	}
+
+
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function update_tickets_sold()
+	{
+		$count_regs_for_this_ticket = $this->count_registrations(
+			array(
+				array(
+					'STS_ID'      => EEM_Registration::status_id_approved,
+					'REG_deleted' => 0,
+				),
+			)
+		);
+		$this->set_sold($count_regs_for_this_ticket);
+		$this->save();
+		return $count_regs_for_this_ticket;
+	}
+
+
+	/**
+	 * Counts the registrations for this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 */
+	public function count_registrations($query_params = array())
+	{
+		return $this->count_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-tickets-alt"></span>';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function get_related_event()
+	{
+		// get one datetime to use for getting the event
+		$datetime = $this->first_datetime();
+		if (! $datetime instanceof \EE_Datetime) {
+			throw new UnexpectedEntityException(
+				$datetime,
+				'EE_Datetime',
+				sprintf(
+					esc_html__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		$event = $datetime->event();
+		if (! $event instanceof \EE_Event) {
+			throw new UnexpectedEntityException(
+				$event,
+				'EE_Event',
+				sprintf(
+					esc_html__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function get_event_name()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->name() : '';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function get_event_ID()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->ID() : 0;
+	}
+
+
+	/**
+	 * This simply returns whether a ticket can be permanently deleted or not.
+	 * The criteria for determining this is whether the ticket has any related registrations.
+	 * If there are none then it can be permanently deleted.
+	 *
+	 * @return bool
+	 */
+	public function is_permanently_deleteable()
+	{
+		return $this->count_registrations() === 0;
+	}
+
+
+	/*******************************************************************
      ***********************  DEPRECATED METHODS  **********************
      *******************************************************************/
 
 
-    /**
-     * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
-     * associated datetimes.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function increase_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->increaseSold($qty);
-    }
-
-
-    /**
-     * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
-     *                 Negative means to decreases old counts (and increase reserved counts).
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _increase_sold_for_datetimes($qty)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseSoldForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->increaseSoldForDatetimes($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
-     * DB and then updates the model objects.
-     * Does not affect the reserved counts.
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function decrease_sold($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseSold() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseSold($qty);
-    }
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _decrease_sold_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseSoldForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseSoldForDatetimes($qty);
-    }
-
-
-    /**
-     * Increments reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int    $qty
-     * @param string $source
-     * @return bool whether we successfully reserved the ticket or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function increase_reserved($qty = 1, $source = 'unknown')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReserved($qty);
-    }
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return boolean indicating success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _increase_reserved_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::increaseReservedForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        return $this->increaseReservedForDatetimes($qty);
-    }
-
-
-    /**
-     * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
-     *
-     * @deprecated 4.9.80.p
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseReserved() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseReserved($qty);
-    }
-
-
-    /**
-     * Decreases reserved on related datetimes
-     *
-     * @deprecated 4.9.80.p
-     * @param int $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _decrease_reserved_for_datetimes($qty = 1)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__('Please use EE_Ticket::decreaseReservedForDatetimes() instead', 'event_espresso'),
-            '4.9.80.p',
-            '5.0.0.p'
-        );
-        $this->decreaseReservedForDatetimes($qty);
-    }
+	/**
+	 * Increments sold by amount passed by $qty AND decrements the reserved count on both this ticket and its
+	 * associated datetimes.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function increase_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->increaseSold($qty);
+	}
+
+
+	/**
+	 * On each datetime related to this ticket, increases its sold count and decreases its reserved count by $qty.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty positive or negative. Positive means to increase sold counts (and decrease reserved counts),
+	 *                 Negative means to decreases old counts (and increase reserved counts).
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _increase_sold_for_datetimes($qty)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseSoldForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->increaseSoldForDatetimes($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) sold by amount passed by $qty on both the ticket and its related datetimes directly in the
+	 * DB and then updates the model objects.
+	 * Does not affect the reserved counts.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseSold() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseSold($qty);
+	}
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _decrease_sold_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseSoldForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseSoldForDatetimes($qty);
+	}
+
+
+	/**
+	 * Increments reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int    $qty
+	 * @param string $source
+	 * @return bool whether we successfully reserved the ticket or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function increase_reserved($qty = 1, $source = 'unknown')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReserved($qty);
+	}
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return boolean indicating success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _increase_reserved_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::increaseReservedForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		return $this->increaseReservedForDatetimes($qty);
+	}
+
+
+	/**
+	 * Decrements (subtracts) reserved by amount passed by $qty, and persists it immediately to the database.
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseReserved() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseReserved($qty);
+	}
+
+
+	/**
+	 * Decreases reserved on related datetimes
+	 *
+	 * @deprecated 4.9.80.p
+	 * @param int $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _decrease_reserved_for_datetimes($qty = 1)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__('Please use EE_Ticket::decreaseReservedForDatetimes() instead', 'event_espresso'),
+			'4.9.80.p',
+			'5.0.0.p'
+		);
+		$this->decreaseReservedForDatetimes($qty);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -129,7 +129,7 @@ 
     public function ticket_status($display = false, $remaining = null)
     {
         $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
+        if ( ! $remaining) {
             return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
         }
         if ($this->get('TKT_deleted')) {
@@ -248,7 +248,7 @@ 
             : '';
         $last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->get_i18n_datetime('DTT_EVT_end', $dt_frmt) : '';
 
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+        return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
     }
 
 
@@ -275,7 +275,7 @@ 
      */
     public function datetimes($query_params = array())
     {
-        if (! isset($query_params['order_by'])) {
+        if ( ! isset($query_params['order_by'])) {
             $query_params['order_by']['DTT_order'] = 'ASC';
         }
         return $this->get_many_related('Datetime', $query_params);
@@ -320,7 +320,7 @@ 
                 if (empty($tickets_sold['datetime'])) {
                     return $total;
                 }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+                if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
                     EE_Error::add_error(
                         esc_html__(
                             'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
@@ -332,7 +332,7 @@ 
                     );
                     return $total;
                 }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
                 break;
             default:
                 return $total;
@@ -350,9 +350,9 @@ 
     {
         $datetimes = $this->get_many_related('Datetime');
         $tickets_sold = array();
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+                $tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
             }
         }
         // Tickets sold
@@ -925,7 +925,7 @@ 
                 'TKT_qty',
                 $qty
             );
-            if (! $success) {
+            if ( ! $success) {
                 // The datetimes were successfully bumped, but not the
                 // ticket. So we need to manually rollback the datetimes.
                 $this->decreaseReservedForDatetimes($qty);
@@ -1374,7 +1374,7 @@ 
         foreach ($this->datetimes() as $datetime) {
             $times[] = $datetime->start_date_and_time();
         }
-        return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
+        return $this->name().' @ '.implode(', ', $times).' for '.$this->pretty_price();
     }
 
 
@@ -1473,7 +1473,7 @@ 
     {
         // get one datetime to use for getting the event
         $datetime = $this->first_datetime();
-        if (! $datetime instanceof \EE_Datetime) {
+        if ( ! $datetime instanceof \EE_Datetime) {
             throw new UnexpectedEntityException(
                 $datetime,
                 'EE_Datetime',
@@ -1484,7 +1484,7 @@ 
             );
         }
         $event = $datetime->event();
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new UnexpectedEntityException(
                 $event,
                 'EE_Event',

core/EE_Payment_Processor.core.php

Indentation +842 added lines, -842 removed lines

@@ -18,846 +18,846 @@
 class EE_Payment_Processor extends EE_Processor_Base implements ResettableInterface
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Payment_Processor
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float) $amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()), // make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            form post data
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request (true, like PayPal)
-     *                                                 or is processed manually (false, like Authorize.net)
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     * @throws \RuntimeException
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } elseif ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
-                                'event_espresso'
-                            ),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // that's actually pretty ok. The IPN just wasn't able
-                // to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array('IPN data' => $_req_data),
-                            $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        // that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment(
-                    $transaction,
-                    $payment,
-                    $update_txn,
-                    $separate_IPN_request
-                );
-            } else {
-                // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $payment_method
-                    );
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $transaction
-                    );
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log',
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__(
-                        'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
-                $value
-            );
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        }
-        return null;
-    }
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if (
-                    $payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        // EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->process_registration_payment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        if (
-            $available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )
-        ) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to(
-                $payment,
-                'Payment',
-                array('RPY_amount' => $payment_amount)
-            );
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        // EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float) abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float) $registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float) abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if (
-            $IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            // ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $payment
-            );
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => (string) esc_html__('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Payment_Processor
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float) $amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()), // make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            form post data
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request (true, like PayPal)
+	 *                                                 or is processed manually (false, like Authorize.net)
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 * @throws \RuntimeException
+	 * @throws \ReflectionException
+	 * @throws \InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} elseif ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
+								'event_espresso'
+							),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// that's actually pretty ok. The IPN just wasn't able
+				// to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array('IPN data' => $_req_data),
+							$payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						// that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment(
+					$transaction,
+					$payment,
+					$update_txn,
+					$separate_IPN_request
+				);
+			} else {
+				// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$payment_method
+					);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$transaction
+					);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log',
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__(
+						'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+						'event_espresso'
+					),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+				$value
+			);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if (
+					$payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		// EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->process_registration_payment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		if (
+			$available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)
+		) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to(
+				$payment,
+				'Payment',
+				array('RPY_amount' => $payment_amount)
+			);
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		// EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float) abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float) $registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float) abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if (
+			$IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			// ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$payment
+			);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => (string) esc_html__('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
+        if ( ! self::$_instance instanceof EE_Payment_Processor) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -170,7 +170,7 @@ 
         /** @type \EE_Transaction $transaction */
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
+        if ( ! $primary_reg instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -265,7 +265,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -309,7 +309,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -380,7 +380,7 @@ 
     {
         $return_data = array();
         foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+            $return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters(
                 $value
             );
         }

core/services/assets/Registry.php

Indentation +773 added lines, -773 removed lines

@@ -26,784 +26,784 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     *
-     * @var array
-     */
-    private $script_handles_with_data = array();
-
-
-    /**
-     * Holds the manifest data obtained from registered manifest files.
-     * Manifests are maps of asset chunk name to actual built asset file names.
-     * Shape of this array is:
-     * array(
-     *  'some_namespace_slug' => array(
-     *      'some_chunk_name' => array(
-     *          'js' => 'filename.js'
-     *          'css' => 'filename.js'
-     *      ),
-     *      'url_base' => 'https://baseurl.com/to/assets
-     *  )
-     * )
-     *
-     * @var array
-     */
-    private $manifest_data = array();
-
-
-    /**
-     * Holds any dependency data obtained from registered dependency map json.
-     * Dependency map json is generated via the @wordpress/dependency-extraction-webpack-plugin via the webpack config.
-     * @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
-     *
-     * @var array
-     */
-    private $dependencies_data = [];
-
-
-    /**
-     * This is a known array of possible wp css handles that correspond to what may be exposed as dependencies in our
-     * build process.  Currently the dependency export process in webpack does not consider css imports, so we derive
-     * them via the js dependencies (WP uses the same handle for both js and css). This is a list of known handles that
-     * are used for both js and css.
-     * @var array
-     */
-    private $wp_css_handle_dependencies = [
-        'wp-components',
-        'wp-block-editor',
-        'wp-block-library',
-        'wp-edit-post',
-        'wp-edit-widgets',
-        'wp-editor',
-        'wp-format-library',
-        'wp-list-reusable-blocks',
-        'wp-nux',
-    ];
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection      $assets
-     * @param I18nRegistry         $i18n_registry
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
-     * translation handling.
-     *
-     * @return I18nRegistry
-     */
-    public function getI18nRegistry()
-    {
-        return $this->i18n_registry;
-    }
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @since 4.9.62.p
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_add_inline_script(
-            'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
-            'before'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasInlineDataCallback()) {
-                $localize = $script->inlineDataCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     *
-     * When you use this method, the value you include will be merged with the array on $key.
-     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 *
+	 * @var array
+	 */
+	private $script_handles_with_data = array();
+
+
+	/**
+	 * Holds the manifest data obtained from registered manifest files.
+	 * Manifests are maps of asset chunk name to actual built asset file names.
+	 * Shape of this array is:
+	 * array(
+	 *  'some_namespace_slug' => array(
+	 *      'some_chunk_name' => array(
+	 *          'js' => 'filename.js'
+	 *          'css' => 'filename.js'
+	 *      ),
+	 *      'url_base' => 'https://baseurl.com/to/assets
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	private $manifest_data = array();
+
+
+	/**
+	 * Holds any dependency data obtained from registered dependency map json.
+	 * Dependency map json is generated via the @wordpress/dependency-extraction-webpack-plugin via the webpack config.
+	 * @see https://github.com/WordPress/gutenberg/tree/master/packages/dependency-extraction-webpack-plugin
+	 *
+	 * @var array
+	 */
+	private $dependencies_data = [];
+
+
+	/**
+	 * This is a known array of possible wp css handles that correspond to what may be exposed as dependencies in our
+	 * build process.  Currently the dependency export process in webpack does not consider css imports, so we derive
+	 * them via the js dependencies (WP uses the same handle for both js and css). This is a list of known handles that
+	 * are used for both js and css.
+	 * @var array
+	 */
+	private $wp_css_handle_dependencies = [
+		'wp-components',
+		'wp-block-editor',
+		'wp-block-library',
+		'wp-edit-post',
+		'wp-edit-widgets',
+		'wp-editor',
+		'wp-format-library',
+		'wp-list-reusable-blocks',
+		'wp-nux',
+	];
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection      $assets
+	 * @param I18nRegistry         $i18n_registry
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
+	 * translation handling.
+	 *
+	 * @return I18nRegistry
+	 */
+	public function getI18nRegistry()
+	{
+		return $this->i18n_registry;
+	}
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @since 4.9.62.p
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_add_inline_script(
+			'eejs-core',
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+			'before'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasInlineDataCallback()) {
+				$localize = $script->inlineDataCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 *
+	 * When you use this method, the value you include will be merged with the array on $key.
+	 * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[ $key ])
+			&& ! is_array($this->jsdata[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
-        }
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
-            : '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData($key)
-    {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
-            : false;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting($key)
-    {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if ( ! isset( $this->jsdata[ $key ] ) ) {
+			$this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+		}
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'][ $template_reference ])
+			? $this->jsdata['templates'][ $template_reference ]
+			: '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData($key)
+	{
+		return isset($this->jsdata[ $key ])
+			? $this->jsdata[ $key ]
+			: false;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting($key)
+	{
+		if (isset($this->jsdata[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->jsdata[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Get the actual asset path for asset manifests.
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
-     *
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
-     *                           asset file location.
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return string
-     * @since 4.9.59.p
-     */
-    public function getAssetUrl($namespace, $chunk_name, $asset_type)
-    {
-        $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
-        )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
-            : $chunk_name;
-
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $url,
-            $namespace,
-            $chunk_name,
-            $asset_type
-        );
-    }
-
-
-
-    /**
-     * Return the url to a js file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getJsUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Return the url to a css file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getCssUrl($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * Return the dependencies array and version string for a given asset $chunk_name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return array
-     * @since 4.9.82.p
-     */
-    private function getDetailsForAsset($namespace, $chunk_name, $asset_type)
-    {
-        $asset_index = $chunk_name . '.' . $asset_type;
-        if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
-            $path = isset($this->manifest_data[ $namespace ]['path'])
-                ? $this->manifest_data[ $namespace ]['path']
-                : '';
-            $dependencies_index = $chunk_name . '.' . Asset::TYPE_PHP;
-            $file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
-                ? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
-                :
-                '';
-            $this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
-                ? $this->getDetailsForAssetType($namespace, $asset_type, $file_path, $chunk_name)
-                : [];
-        }
-        $details = $this->dependencies_data[ $namespace ][ $asset_index ];
-        return $details;
-    }
-
-
-    /**
-     * Return dependencies array and version string according to asset type.
-     * For css assets, this filters the auto generated dependencies by css type.
-     *
-     * @param string $namespace
-     * @param string $asset_type
-     * @param string $file_path
-     * @param string $chunk_name
-     * @return array
-     * @since 4.9.82.p
-     */
-    private function getDetailsForAssetType($namespace, $asset_type, $file_path, $chunk_name)
-    {
-        // $asset_dependencies = json_decode(file_get_contents($file_path), true);
-        $asset_details = require($file_path);
-        $asset_details['dependencies'] = isset($asset_details['dependencies'])
-            ? $asset_details['dependencies']
-            : [];
-        $asset_details['version'] = isset($asset_details['version'])
-            ? $asset_details['version']
-            : '';
-        if ($asset_type === Asset::TYPE_JS) {
-            $asset_details['dependencies'] =  $chunk_name === 'eejs-core'
-                ? $asset_details['dependencies']
-                : $asset_details['dependencies'] + [ CoreAssetManager::JS_HANDLE_JS_CORE ];
-            return $asset_details;
-        }
-        // for css we need to make sure there is actually a css file related to this chunk.
-        if (isset($this->manifest_data[ $namespace ])) {
-            // array of css chunk files for ee.
-            $css_chunks = array_map(
-                static function ($value) {
-                    return str_replace('.css', '', $value);
-                },
-                array_filter(
-                    array_keys($this->manifest_data[ $namespace ]),
-                    static function ($value) {
-                        return strpos($value, '.css') !== false;
-                    }
-                )
-            );
-            // add known wp chunks with css
-            $css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
-            // flip for easier search
-            $css_chunks = array_flip($css_chunks);
-            // now let's filter the dependencies for the incoming chunk to actual chunks that have styles
-            $asset_details['dependencies'] = array_filter(
-                $asset_details['dependencies'],
-                static function ($chunk_name) use ($css_chunks) {
-                    return isset($css_chunks[ $chunk_name ]);
-                }
-            );
-            return $asset_details;
-        }
-        return ['dependencies' => [], 'version' => ''];
-    }
-
-
-    /**
-     * Get the dependencies array and version string for the given js asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @since 4.10.2.p
-     */
-    public function getJsAssetDetails($namespace, $chunk_name)
-    {
-        return $this->getDetailsForAsset($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Get the dependencies array and version string for the given css asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @since 4.10.2.p
-     */
-    public function getCssAssetDetails($namespace, $chunk_name)
-    {
-        return $this->getDetailsForAsset($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
-                $manifest_file->filepath()
-            );
-        }
-    }
-
-
-    /**
-     * Used to register a js/css manifest file with the registered_manifest_files property.
-     *
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
-     * @param string $url_base      The url base for the manifest file location.
-     * @param string $manifest_file The absolute path to the manifest file.
-     * @param string $manifest_file_path  The path to the folder containing the manifest file. If not provided will be
-     *                                    default to `plugin_root/assets/dist`.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
-                        'event_espresso'
-                    ),
-                    $namespace
-                )
-            );
-        }
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
-            if (is_admin()) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
-                            'event_espresso'
-                        ),
-                        'Event Espresso',
-                        $url_base,
-                        'plugins_url',
-                        'WP_PLUGIN_URL'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return;
-        }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
-        }
-        if (! isset($this->manifest_data[ $namespace ]['path'])) {
-            $this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
-        }
-    }
-
-
-    /**
-     * Decodes json from the provided manifest file.
-     *
-     * @since 4.9.59.p
-     * @param string $manifest_file Path to manifest file.
-     * @return array
-     * @throws InvalidFilePathException
-     */
-    private function decodeManifestFile($manifest_file)
-    {
-        if (! file_exists($manifest_file)) {
-            throw new InvalidFilePathException($manifest_file);
-        }
-        return json_decode(file_get_contents($manifest_file), true);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($script_handle)
-    {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
-    }
-
-
-    /**i
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get the actual asset path for asset manifests.
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
+	 *
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
+	 *                           asset file location.
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public function getAssetUrl($namespace, $chunk_name, $asset_type)
+	{
+		$url = isset(
+			$this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
+			$this->manifest_data[ $namespace ]['url_base']
+		)
+			? $this->manifest_data[ $namespace ]['url_base']
+			  . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+			: $chunk_name;
+
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$url,
+			$namespace,
+			$chunk_name,
+			$asset_type
+		);
+	}
+
+
+
+	/**
+	 * Return the url to a js file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getJsUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Return the url to a css file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getCssUrl($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * Return the dependencies array and version string for a given asset $chunk_name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	private function getDetailsForAsset($namespace, $chunk_name, $asset_type)
+	{
+		$asset_index = $chunk_name . '.' . $asset_type;
+		if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
+			$path = isset($this->manifest_data[ $namespace ]['path'])
+				? $this->manifest_data[ $namespace ]['path']
+				: '';
+			$dependencies_index = $chunk_name . '.' . Asset::TYPE_PHP;
+			$file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
+				? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
+				:
+				'';
+			$this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
+				? $this->getDetailsForAssetType($namespace, $asset_type, $file_path, $chunk_name)
+				: [];
+		}
+		$details = $this->dependencies_data[ $namespace ][ $asset_index ];
+		return $details;
+	}
+
+
+	/**
+	 * Return dependencies array and version string according to asset type.
+	 * For css assets, this filters the auto generated dependencies by css type.
+	 *
+	 * @param string $namespace
+	 * @param string $asset_type
+	 * @param string $file_path
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.9.82.p
+	 */
+	private function getDetailsForAssetType($namespace, $asset_type, $file_path, $chunk_name)
+	{
+		// $asset_dependencies = json_decode(file_get_contents($file_path), true);
+		$asset_details = require($file_path);
+		$asset_details['dependencies'] = isset($asset_details['dependencies'])
+			? $asset_details['dependencies']
+			: [];
+		$asset_details['version'] = isset($asset_details['version'])
+			? $asset_details['version']
+			: '';
+		if ($asset_type === Asset::TYPE_JS) {
+			$asset_details['dependencies'] =  $chunk_name === 'eejs-core'
+				? $asset_details['dependencies']
+				: $asset_details['dependencies'] + [ CoreAssetManager::JS_HANDLE_JS_CORE ];
+			return $asset_details;
+		}
+		// for css we need to make sure there is actually a css file related to this chunk.
+		if (isset($this->manifest_data[ $namespace ])) {
+			// array of css chunk files for ee.
+			$css_chunks = array_map(
+				static function ($value) {
+					return str_replace('.css', '', $value);
+				},
+				array_filter(
+					array_keys($this->manifest_data[ $namespace ]),
+					static function ($value) {
+						return strpos($value, '.css') !== false;
+					}
+				)
+			);
+			// add known wp chunks with css
+			$css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
+			// flip for easier search
+			$css_chunks = array_flip($css_chunks);
+			// now let's filter the dependencies for the incoming chunk to actual chunks that have styles
+			$asset_details['dependencies'] = array_filter(
+				$asset_details['dependencies'],
+				static function ($chunk_name) use ($css_chunks) {
+					return isset($css_chunks[ $chunk_name ]);
+				}
+			);
+			return $asset_details;
+		}
+		return ['dependencies' => [], 'version' => ''];
+	}
+
+
+	/**
+	 * Get the dependencies array and version string for the given js asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.10.2.p
+	 */
+	public function getJsAssetDetails($namespace, $chunk_name)
+	{
+		return $this->getDetailsForAsset($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Get the dependencies array and version string for the given css asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @since 4.10.2.p
+	 */
+	public function getCssAssetDetails($namespace, $chunk_name)
+	{
+		return $this->getDetailsForAsset($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
+				$manifest_file->filepath()
+			);
+		}
+	}
+
+
+	/**
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
+	 *
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
+	 * @param string $url_base      The url base for the manifest file location.
+	 * @param string $manifest_file The absolute path to the manifest file.
+	 * @param string $manifest_file_path  The path to the folder containing the manifest file. If not provided will be
+	 *                                    default to `plugin_root/assets/dist`.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
+						'event_espresso'
+					),
+					$namespace
+				)
+			);
+		}
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
+			if (is_admin()) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
+							'event_espresso'
+						),
+						'Event Espresso',
+						$url_base,
+						'plugins_url',
+						'WP_PLUGIN_URL'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return;
+		}
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+		}
+		if (! isset($this->manifest_data[ $namespace ]['path'])) {
+			$this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
+		}
+	}
+
+
+	/**
+	 * Decodes json from the provided manifest file.
+	 *
+	 * @since 4.9.59.p
+	 * @param string $manifest_file Path to manifest file.
+	 * @return array
+	 * @throws InvalidFilePathException
+	 */
+	private function decodeManifestFile($manifest_file)
+	{
+		if (! file_exists($manifest_file)) {
+			throw new InvalidFilePathException($manifest_file);
+		}
+		return json_decode(file_get_contents($manifest_file), true);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($script_handle)
+	{
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
+	}
+
+
+	/**i
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
      * Dependency stored in WP_Scripts if its set.
      */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     *
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
-    {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
-            global $wp_scripts;
-            $unset_handle = false;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
-                $unset_handle = true;
-            }
-            //deal with inline_scripts
-            if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
-                $unset_handle = true;
-            }
-            if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
-            }
-            if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     */
-    private function debug()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
-
-
-    /**
-     * Get the dependencies array for the given js asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 4.10.2.p
-     * @since 4.9.82.p
-     */
-    public function getJsDependencies($namespace, $chunk_name)
-    {
-        $details = $this->getJsAssetDetails($namespace, $chunk_name);
-        return isset($details['dependencies']) ? $details['dependencies'] : [];
-    }
-
-
-    /**
-     * Get the dependencies array for the given css asset chunk name
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 4.10.2.p
-     * @since      4.9.82.p
-     */
-    public function getCssDependencies($namespace, $chunk_name)
-    {
-        $details = $this->getCssAssetDetails($namespace, $chunk_name);
-        return isset($details['dependencies']) ? $details['dependencies'] : [];
-    }
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 *
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
+	{
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
+			global $wp_scripts;
+			$unset_handle = false;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+				$unset_handle = true;
+			}
+			//deal with inline_scripts
+			if ($wp_scripts->get_data($script_handle, 'before')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+				$unset_handle = true;
+			}
+			if ($wp_scripts->get_data($script_handle, 'after')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+			}
+			if ($unset_handle) {
+				unset($this->script_handles_with_data[ $script_handle ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 */
+	private function debug()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
+
+
+	/**
+	 * Get the dependencies array for the given js asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 4.10.2.p
+	 * @since 4.9.82.p
+	 */
+	public function getJsDependencies($namespace, $chunk_name)
+	{
+		$details = $this->getJsAssetDetails($namespace, $chunk_name);
+		return isset($details['dependencies']) ? $details['dependencies'] : [];
+	}
+
+
+	/**
+	 * Get the dependencies array for the given css asset chunk name
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 4.10.2.p
+	 * @since      4.9.82.p
+	 */
+	public function getCssDependencies($namespace, $chunk_name)
+	{
+		$details = $this->getCssAssetDetails($namespace, $chunk_name);
+		return isset($details['dependencies']) ? $details['dependencies'] : [];
+	}
 }

Spacing +57 added lines, -57 removed lines

@@ -184,7 +184,7 @@ 
                 $script->version(),
                 $script->loadInFooter()
             );
-            if (! $registered && $this->debug()) {
+            if ( ! $registered && $this->debug()) {
                 throw new AssetRegistrationException($script->handle());
             }
             $script->setRegistered($registered);
@@ -245,7 +245,7 @@ 
         $this->removeAlreadyRegisteredDataForScriptHandles();
         wp_add_inline_script(
             'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+            'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)),
             'before'
         );
         $scripts = $this->assets->getJavascriptAssetsWithData();
@@ -275,7 +275,7 @@ 
     public function addData($key, $value)
     {
         if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
+            $this->jsdata[$key] = $value;
         }
     }
 
@@ -300,10 +300,10 @@ 
      */
     public function pushData($key, $value)
     {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
+        if (isset($this->jsdata[$key])
+            && ! is_array($this->jsdata[$key])
         ) {
-            if (! $this->debug()) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -318,10 +318,10 @@ 
                 )
             );
         }
-        if ( ! isset( $this->jsdata[ $key ] ) ) {
-            $this->jsdata[ $key ] = is_array($value) ? $value : [$value];
+        if ( ! isset($this->jsdata[$key])) {
+            $this->jsdata[$key] = is_array($value) ? $value : [$value];
         } else {
-            $this->jsdata[ $key ] = array_merge( $this->jsdata[$key], (array) $value);
+            $this->jsdata[$key] = array_merge($this->jsdata[$key], (array) $value);
         }
     }
 
@@ -336,12 +336,12 @@ 
      */
     public function addTemplate($template_reference, $template_content)
     {
-        if (! isset($this->jsdata['templates'])) {
+        if ( ! isset($this->jsdata['templates'])) {
             $this->jsdata['templates'] = array();
         }
         //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata['templates'][$template_reference])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -354,7 +354,7 @@ 
                 )
             );
         }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
+        $this->jsdata['templates'][$template_reference] = $template_content;
     }
 
 
@@ -366,8 +366,8 @@ 
      */
     public function getTemplate($template_reference)
     {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
+        return isset($this->jsdata['templates'][$template_reference])
+            ? $this->jsdata['templates'][$template_reference]
             : '';
     }
 
@@ -380,8 +380,8 @@ 
      */
     public function getData($key)
     {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
+        return isset($this->jsdata[$key])
+            ? $this->jsdata[$key]
             : false;
     }
 
@@ -396,11 +396,11 @@ 
      */
     protected function verifyDataNotExisting($key)
     {
-        if (isset($this->jsdata[ $key ])) {
-            if (! $this->debug()) {
+        if (isset($this->jsdata[$key])) {
+            if ( ! $this->debug()) {
                 return false;
             }
-            if (is_array($this->jsdata[ $key ])) {
+            if (is_array($this->jsdata[$key])) {
                 throw new InvalidArgumentException(
                     sprintf(
                         esc_html__(
@@ -443,11 +443,11 @@ 
     public function getAssetUrl($namespace, $chunk_name, $asset_type)
     {
         $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
+            $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type],
+            $this->manifest_data[$namespace]['url_base']
         )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name . '.' . $asset_type ]
+            ? $this->manifest_data[$namespace]['url_base']
+              . $this->manifest_data[$namespace][$chunk_name.'.'.$asset_type]
             : $chunk_name;
 
         return apply_filters(
@@ -498,21 +498,21 @@ 
      */
     private function getDetailsForAsset($namespace, $chunk_name, $asset_type)
     {
-        $asset_index = $chunk_name . '.' . $asset_type;
-        if (! isset( $this->dependencies_data[ $namespace ][ $asset_index ])) {
-            $path = isset($this->manifest_data[ $namespace ]['path'])
-                ? $this->manifest_data[ $namespace ]['path']
+        $asset_index = $chunk_name.'.'.$asset_type;
+        if ( ! isset($this->dependencies_data[$namespace][$asset_index])) {
+            $path = isset($this->manifest_data[$namespace]['path'])
+                ? $this->manifest_data[$namespace]['path']
                 : '';
-            $dependencies_index = $chunk_name . '.' . Asset::TYPE_PHP;
-            $file_path = isset($this->manifest_data[ $namespace ][ $dependencies_index ])
-                ? $path . $this->manifest_data[ $namespace ][ $dependencies_index ]
+            $dependencies_index = $chunk_name.'.'.Asset::TYPE_PHP;
+            $file_path = isset($this->manifest_data[$namespace][$dependencies_index])
+                ? $path.$this->manifest_data[$namespace][$dependencies_index]
                 :
                 '';
-            $this->dependencies_data[ $namespace ][ $asset_index ] = $file_path !== '' && file_exists($file_path)
+            $this->dependencies_data[$namespace][$asset_index] = $file_path !== '' && file_exists($file_path)
                 ? $this->getDetailsForAssetType($namespace, $asset_type, $file_path, $chunk_name)
                 : [];
         }
-        $details = $this->dependencies_data[ $namespace ][ $asset_index ];
+        $details = $this->dependencies_data[$namespace][$asset_index];
         return $details;
     }
 
@@ -539,34 +539,34 @@ 
             ? $asset_details['version']
             : '';
         if ($asset_type === Asset::TYPE_JS) {
-            $asset_details['dependencies'] =  $chunk_name === 'eejs-core'
+            $asset_details['dependencies'] = $chunk_name === 'eejs-core'
                 ? $asset_details['dependencies']
-                : $asset_details['dependencies'] + [ CoreAssetManager::JS_HANDLE_JS_CORE ];
+                : $asset_details['dependencies'] + [CoreAssetManager::JS_HANDLE_JS_CORE];
             return $asset_details;
         }
         // for css we need to make sure there is actually a css file related to this chunk.
-        if (isset($this->manifest_data[ $namespace ])) {
+        if (isset($this->manifest_data[$namespace])) {
             // array of css chunk files for ee.
             $css_chunks = array_map(
-                static function ($value) {
+                static function($value) {
                     return str_replace('.css', '', $value);
                 },
                 array_filter(
-                    array_keys($this->manifest_data[ $namespace ]),
-                    static function ($value) {
+                    array_keys($this->manifest_data[$namespace]),
+                    static function($value) {
                         return strpos($value, '.css') !== false;
                     }
                 )
             );
             // add known wp chunks with css
-            $css_chunks = array_merge( $css_chunks, $this->wp_css_handle_dependencies);
+            $css_chunks = array_merge($css_chunks, $this->wp_css_handle_dependencies);
             // flip for easier search
             $css_chunks = array_flip($css_chunks);
             // now let's filter the dependencies for the incoming chunk to actual chunks that have styles
             $asset_details['dependencies'] = array_filter(
                 $asset_details['dependencies'],
-                static function ($chunk_name) use ($css_chunks) {
-                    return isset($css_chunks[ $chunk_name ]);
+                static function($chunk_name) use ($css_chunks) {
+                    return isset($css_chunks[$chunk_name]);
                 }
             );
             return $asset_details;
@@ -615,7 +615,7 @@ 
             $this->registerManifestFile(
                 $manifest_file->assetNamespace(),
                 $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST,
+                $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST,
                 $manifest_file->filepath()
             );
         }
@@ -636,8 +636,8 @@ 
      */
     public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
     {
-        if (isset($this->manifest_data[ $namespace ])) {
-            if (! $this->debug()) {
+        if (isset($this->manifest_data[$namespace])) {
+            if ( ! $this->debug()) {
                 return;
             }
             throw new InvalidArgumentException(
@@ -670,12 +670,12 @@ 
             }
             return;
         }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+        $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file);
+        if ( ! isset($this->manifest_data[$namespace]['url_base'])) {
+            $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base);
         }
-        if (! isset($this->manifest_data[ $namespace ]['path'])) {
-            $this->manifest_data[ $namespace ]['path'] = $manifest_file_path;
+        if ( ! isset($this->manifest_data[$namespace]['path'])) {
+            $this->manifest_data[$namespace]['path'] = $manifest_file_path;
         }
     }
 
@@ -690,7 +690,7 @@ 
      */
     private function decodeManifestFile($manifest_file)
     {
-        if (! file_exists($manifest_file)) {
+        if ( ! file_exists($manifest_file)) {
             throw new InvalidFilePathException($manifest_file);
         }
         return json_decode(file_get_contents($manifest_file), true);
@@ -704,7 +704,7 @@ 
      */
     private function addRegisteredScriptHandlesWithData($script_handle)
     {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
+        $this->script_handles_with_data[$script_handle] = $script_handle;
     }
 
 
@@ -730,23 +730,23 @@ 
      */
     private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
     {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
+        if (isset($this->script_handles_with_data[$script_handle])) {
             global $wp_scripts;
             $unset_handle = false;
             if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+                unset($wp_scripts->registered[$script_handle]->extra['data']);
                 $unset_handle = true;
             }
             //deal with inline_scripts
             if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+                unset($wp_scripts->registered[$script_handle]->extra['before']);
                 $unset_handle = true;
             }
             if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+                unset($wp_scripts->registered[$script_handle]->extra['after']);
             }
             if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
+                unset($this->script_handles_with_data[$script_handle]);
             }
         }
     }

core/services/collections/CollectionLoaderException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionLoaderException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/InvalidCollectionIdentifierException.php

Indentation +21 added lines, -21 removed lines

@@ -16,26 +16,26 @@
 class InvalidCollectionIdentifierException extends OutOfBoundsException
 {
 
-    /**
-     * InvalidCollectionIdentifierException constructor.
-     *
-     * @param                $identifier
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied identifier "%1$s" does not exist within this collection. 
+	/**
+	 * InvalidCollectionIdentifierException constructor.
+	 *
+	 * @param                $identifier
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied identifier "%1$s" does not exist within this collection. 
                     You may need to delay adding this asset until the required dependency has been added.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/CollectionDetailsException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionDetailsException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The following error occurred during the collection details generation: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The following error occurred during the collection details generation: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/DuplicateCollectionIdentifierException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class DuplicateCollectionIdentifierException extends OutOfRangeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param                $identifier
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied identifier "%1$s" already exists within this collection.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param                $identifier
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied identifier "%1$s" already exists within this collection.',
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/container/CoffeeMaker.php

Indentation +152 added lines, -152 removed lines

@@ -18,156 +18,156 @@
 abstract class CoffeeMaker implements CoffeeMakerInterface
 {
 
-    /**
-     * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
-     */
-    const BREW_NEW = 'new';
-
-    /**
-     * Indicates that CoffeeMaker should always return a SHARED instance
-     */
-    const BREW_SHARED = 'shared';
-
-    /**
-     * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
-     */
-    const BREW_LOAD_ONLY = 'load_only';
-
-
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var DependencyInjector $injector
-     */
-    private $injector;
-
-
-    /**
-     * @return array
-     */
-    public static function getTypes()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
-            array(
-                CoffeeMaker::BREW_NEW,
-                CoffeeMaker::BREW_SHARED,
-                CoffeeMaker::BREW_LOAD_ONLY,
-            )
-        );
-    }
-
-
-    /**
-     * @param $type
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     */
-    public static function validateType($type)
-    {
-        $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
-            throw new InvalidIdentifierException(
-                is_object($type) ? get_class($type) : gettype($type),
-                esc_html__(
-                    'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
-                    'event_espresso'
-                )
-            );
-        }
-        return $type;
-    }
-
-
-    /**
-     * CoffeeMaker constructor.
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param InjectorInterface  $injector
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->injector = $injector;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\CoffeePotInterface
-     */
-    protected function coffeePot()
-    {
-        return $this->coffee_pot;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\DependencyInjector
-     */
-    protected function injector()
-    {
-        return $this->injector;
-    }
-
-
-    /**
-     * Examines the constructor to determine which method should be used for instantiation
-     *
-     * @param \ReflectionClass $reflector
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function resolveInstantiationMethod(\ReflectionClass $reflector)
-    {
-        if ($reflector->getConstructor() === null) {
-            return 'NewInstance';
-        }
-        if ($reflector->isInstantiable()) {
-            return 'NewInstanceArgs';
-        }
-        if (method_exists($reflector->getName(), 'instance')) {
-            return 'instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance')) {
-            return 'new_instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance_from_db')) {
-            return 'new_instance_from_db';
-        }
-        throw new InstantiationException($reflector->getName());
-    }
-
-
-    /**
-     * Ensures files for classes that are not PSR-4 compatible are loaded
-     * and then verifies that classes exist where applicable
-     *
-     * @param RecipeInterface $recipe
-     * @return bool
-     * @throws InvalidClassException
-     */
-    protected function resolveClassAndFilepath(RecipeInterface $recipe)
-    {
-        $paths = $recipe->paths();
-        if (! empty($paths)) {
-            foreach ($paths as $path) {
-                if (strpos($path, '*') === false && is_readable($path)) {
-                    require_once($path);
-                }
-            }
-        }
-        // re: using "false" for class_exists() second param:
-        // if a class name is not already known to PHP, then class_exists() will run through
-        // all of the registered spl_autoload functions until it either finds the class,
-        // or gets to the end of the registered spl_autoload functions.
-        // When the second parameter is true, it will also attempt to load the class file,
-        // but it will also trigger an error if the class can not be loaded.
-        // We don't want that extra error in the mix, so we have set the second param to "false"
-        if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
-            throw new InvalidClassException($recipe->identifier());
-        }
-        return true;
-    }
+	/**
+	 * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
+	 */
+	const BREW_NEW = 'new';
+
+	/**
+	 * Indicates that CoffeeMaker should always return a SHARED instance
+	 */
+	const BREW_SHARED = 'shared';
+
+	/**
+	 * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
+	 */
+	const BREW_LOAD_ONLY = 'load_only';
+
+
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var DependencyInjector $injector
+	 */
+	private $injector;
+
+
+	/**
+	 * @return array
+	 */
+	public static function getTypes()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
+			array(
+				CoffeeMaker::BREW_NEW,
+				CoffeeMaker::BREW_SHARED,
+				CoffeeMaker::BREW_LOAD_ONLY,
+			)
+		);
+	}
+
+
+	/**
+	 * @param $type
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 */
+	public static function validateType($type)
+	{
+		$types = CoffeeMaker::getTypes();
+		if (! in_array($type, $types, true)) {
+			throw new InvalidIdentifierException(
+				is_object($type) ? get_class($type) : gettype($type),
+				esc_html__(
+					'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
+					'event_espresso'
+				)
+			);
+		}
+		return $type;
+	}
+
+
+	/**
+	 * CoffeeMaker constructor.
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param InjectorInterface  $injector
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->injector = $injector;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\CoffeePotInterface
+	 */
+	protected function coffeePot()
+	{
+		return $this->coffee_pot;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\DependencyInjector
+	 */
+	protected function injector()
+	{
+		return $this->injector;
+	}
+
+
+	/**
+	 * Examines the constructor to determine which method should be used for instantiation
+	 *
+	 * @param \ReflectionClass $reflector
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function resolveInstantiationMethod(\ReflectionClass $reflector)
+	{
+		if ($reflector->getConstructor() === null) {
+			return 'NewInstance';
+		}
+		if ($reflector->isInstantiable()) {
+			return 'NewInstanceArgs';
+		}
+		if (method_exists($reflector->getName(), 'instance')) {
+			return 'instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance')) {
+			return 'new_instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance_from_db')) {
+			return 'new_instance_from_db';
+		}
+		throw new InstantiationException($reflector->getName());
+	}
+
+
+	/**
+	 * Ensures files for classes that are not PSR-4 compatible are loaded
+	 * and then verifies that classes exist where applicable
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return bool
+	 * @throws InvalidClassException
+	 */
+	protected function resolveClassAndFilepath(RecipeInterface $recipe)
+	{
+		$paths = $recipe->paths();
+		if (! empty($paths)) {
+			foreach ($paths as $path) {
+				if (strpos($path, '*') === false && is_readable($path)) {
+					require_once($path);
+				}
+			}
+		}
+		// re: using "false" for class_exists() second param:
+		// if a class name is not already known to PHP, then class_exists() will run through
+		// all of the registered spl_autoload functions until it either finds the class,
+		// or gets to the end of the registered spl_autoload functions.
+		// When the second parameter is true, it will also attempt to load the class file,
+		// but it will also trigger an error if the class can not be loaded.
+		// We don't want that extra error in the mix, so we have set the second param to "false"
+		if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
+			throw new InvalidClassException($recipe->identifier());
+		}
+		return true;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     public static function validateType($type)
     {
         $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
+        if ( ! in_array($type, $types, true)) {
             throw new InvalidIdentifierException(
                 is_object($type) ? get_class($type) : gettype($type),
                 esc_html__(
@@ -151,7 +151,7 @@ 
     protected function resolveClassAndFilepath(RecipeInterface $recipe)
     {
         $paths = $recipe->paths();
-        if (! empty($paths)) {
+        if ( ! empty($paths)) {
             foreach ($paths as $path) {
                 if (strpos($path, '*') === false && is_readable($path)) {
                     require_once($path);