eventespresso / event-espresso-core

core/db_classes/EE_Payment.class.php

Spacing +6 added lines, -6 removed lines

@@ -296,7 +296,7 @@ 
      */
     public function timestamp($dt_frmt = '', $tm_frmt = '')
     {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
     }
 
 
@@ -481,7 +481,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->STS_ID() ];
+        return $icon.$status[$this->STS_ID()];
     }
 
 
@@ -627,7 +627,7 @@ 
     public function redirect_form($inside_form_html = null)
     {
         $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
+        if ( ! empty($redirect_url)) {
             // what ? no inner form content?
             if ($inside_form_html === null) {
                 $inside_form_html = EEH_HTML::p(
@@ -657,7 +657,7 @@ 
                 $get_params = null;
                 parse_str($querystring, $get_params);
                 $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+                $redirect_url = str_replace('?'.$querystring, '', $redirect_url);
             }
             $form = EEH_HTML::nl(1)
                     . '<form method="'
@@ -665,9 +665,9 @@ 
                     . '" name="gateway_form" action="'
                     . $redirect_url
                     . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+            $form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
             $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+            $form .= EEH_HTML::nl(-1).'</form>'.EEH_HTML::nl(-1);
             return $form;
         } else {
             return null;

Doc Comments +3 added lines, -3 removed lines

@@ -13,7 +13,7 @@ 
      * @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
+     * @param string[]  $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_Payment
      * @throws \EE_Error
@@ -588,7 +588,7 @@ 
      * Gets all the extra meta info on this payment
      *
      * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Extra_Meta
+     * @return EE_Base_Class[]
      * @throws \EE_Error
      */
     public function extra_meta($query_params = array())
@@ -836,7 +836,7 @@ 
     /**
      * Returns the payment's transaction's primary registration
      *
-     * @return EE_Registration|null
+     * @return EE_Base_Class|null
      */
     public function get_primary_registration()
     {

Indentation +851 added lines, -851 removed lines

@@ -9,855 +9,855 @@
 class EE_Payment extends EE_Base_Class implements EEI_Payment
 {
 
-    /**
-     * @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_Payment
-     * @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_Payment
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Set Transaction ID
-     *
-     * @access public
-     * @param int $TXN_ID
-     * @throws \EE_Error
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets the transaction related to this payment
-     *
-     * @return EE_Transaction
-     * @throws \EE_Error
-     */
-    public function transaction()
-    {
-        return $this->get_first_related('Transaction');
-    }
-
-
-    /**
-     * Set Status
-     *
-     * @access public
-     * @param string $STS_ID
-     * @throws \EE_Error
-     */
-    public function set_status($STS_ID = '')
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Set Payment Timestamp
-     *
-     * @access public
-     * @param int $timestamp
-     * @throws \EE_Error
-     */
-    public function set_timestamp($timestamp = 0)
-    {
-        $this->set('PAY_timestamp', $timestamp);
-    }
-
-
-    /**
-     * Set Payment Method
-     *
-     * @access public
-     * @param string $PAY_source
-     * @throws \EE_Error
-     */
-    public function set_source($PAY_source = '')
-    {
-        $this->set('PAY_source', $PAY_source);
-    }
-
-
-    /**
-     * Set Payment Amount
-     *
-     * @access public
-     * @param float $amount
-     * @throws \EE_Error
-     */
-    public function set_amount($amount = 0.00)
-    {
-        $this->set('PAY_amount', (float) $amount);
-    }
-
-
-    /**
-     * Set Payment Gateway Response
-     *
-     * @access public
-     * @param string $gateway_response
-     * @throws \EE_Error
-     */
-    public function set_gateway_response($gateway_response = '')
-    {
-        $this->set('PAY_gateway_response', $gateway_response);
-    }
-
-
-    /**
-     * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
-     * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
-     * used on it
-     *
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public function gateway()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment::gateway',
-            __(
-                'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
-                'event_espresso'
-            ),
-            '4.6.0'
-        );
-        return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
-    }
-
-
-    /**
-     * Set Gateway Transaction ID
-     *
-     * @access public
-     * @param string $txn_id_chq_nmbr
-     * @throws \EE_Error
-     */
-    public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
-    {
-        $this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
-    }
-
-
-    /**
-     * Set Purchase Order Number
-     *
-     * @access public
-     * @param string $po_number
-     * @throws \EE_Error
-     */
-    public function set_po_number($po_number = '')
-    {
-        $this->set('PAY_po_number', $po_number);
-    }
-
-
-    /**
-     * Set Extra Accounting Field
-     *
-     * @access public
-     * @param string $extra_accntng
-     * @throws \EE_Error
-     */
-    public function set_extra_accntng($extra_accntng = '')
-    {
-        $this->set('PAY_extra_accntng', $extra_accntng);
-    }
-
-
-    /**
-     * Set Payment made via admin flag
-     *
-     * @access public
-     * @param bool $via_admin
-     * @throws \EE_Error
-     */
-    public function set_payment_made_via_admin($via_admin = false)
-    {
-        if ($via_admin) {
-            $this->set('PAY_source', EEM_Payment_Method::scope_admin);
-        } else {
-            $this->set('PAY_source', EEM_Payment_Method::scope_cart);
-        }
-    }
-
-
-    /**
-     * Set Payment Details
-     *
-     * @access public
-     * @param string|array $details
-     * @throws \EE_Error
-     */
-    public function set_details($details = '')
-    {
-        if (is_array($details)) {
-            array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $details = wp_strip_all_tags($details);
-        }
-        $this->set('PAY_details', $details);
-    }
-
-
-    /**
-     * Sets redirect_url
-     *
-     * @param string $redirect_url
-     * @throws \EE_Error
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->set('PAY_redirect_url', $redirect_url);
-    }
-
-
-    /**
-     * Sets redirect_args
-     *
-     * @param array $redirect_args
-     * @throws \EE_Error
-     */
-    public function set_redirect_args($redirect_args)
-    {
-        $this->set('PAY_redirect_args', $redirect_args);
-    }
-
-
-    /**
-     * get Payment Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function status()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Status
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * get Payment Timestamp
-     *
-     * @access public
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
-    public function timestamp($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
-    }
-
-
-    /**
-     * get Payment Source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function source()
-    {
-        return $this->get('PAY_source');
-    }
-
-
-    /**
-     * get Payment Amount
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function amount()
-    {
-        return (float) $this->get('PAY_amount');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function amount_no_code()
-    {
-        return $this->get_pretty('PAY_amount', 'no_currency_code');
-    }
-
-
-    /**
-     * get Payment Gateway Response
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function gateway_response()
-    {
-        return $this->get('PAY_gateway_response');
-    }
-
-
-    /**
-     * get Payment Gateway Transaction ID
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function txn_id_chq_nmbr()
-    {
-        return $this->get('PAY_txn_id_chq_nmbr');
-    }
-
-
-    /**
-     * get Purchase Order Number
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function po_number()
-    {
-        return $this->get('PAY_po_number');
-    }
-
-
-    /**
-     * get Extra Accounting Field
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function extra_accntng()
-    {
-        return $this->get('PAY_extra_accntng');
-    }
-
-
-    /**
-     * get Payment made via admin source
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function payment_made_via_admin()
-    {
-        return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
-    }
-
-
-    /**
-     * get Payment Details
-     *
-     * @access public
-     * @throws \EE_Error
-     */
-    public function details()
-    {
-        return $this->get('PAY_details');
-    }
-
-
-    /**
-     * Gets redirect_url
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_url()
-    {
-        return $this->get('PAY_redirect_url');
-    }
-
-
-    /**
-     * Gets redirect_args
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function redirect_args()
-    {
-        return $this->get('PAY_redirect_args');
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws \EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws \EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->STS_ID() => __('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->STS_ID()) {
-            case EEM_Payment::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_pending:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Payment::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->STS_ID() ];
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is approved or not
-     * @throws \EE_Error
-     */
-    public function is_approved()
-    {
-        return $this->status_is(EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * Generally determines if the status of this payment equals
-     * the $STS_ID string
-     *
-     * @param string $STS_ID an ID from the esp_status table/
-     *                       one of the status_id_* on the EEM_Payment model
-     * @return boolean whether the status of this payment equals the status id
-     * @throws \EE_Error
-     */
-    protected function status_is($STS_ID)
-    {
-        return $STS_ID === $this->STS_ID() ? true : false;
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean whether the payment is pending or not
-     * @throws \EE_Error
-     */
-    public function is_pending()
-    {
-        return $this->status_is(EEM_Payment::status_id_pending);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_cancelled()
-    {
-        return $this->status_is(EEM_Payment::status_id_cancelled);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_declined()
-    {
-        return $this->status_is(EEM_Payment::status_id_declined);
-    }
-
-
-    /**
-     * For determining the status of the payment
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_failed()
-    {
-        return $this->status_is(EEM_Payment::status_id_failed);
-    }
-
-
-    /**
-     * For determining if the payment is actually a refund ( ie: has a negative value )
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_a_refund()
-    {
-        return $this->amount() < 0 ? true : false;
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws \EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Extra_Meta
-     * @throws \EE_Error
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public function payment_method()
-    {
-        return $this->get_first_related('Payment_Method');
-    }
-
-
-    /**
-     * Gets the HTML for redirecting the user to an offsite gateway
-     * You can pass it special content to put inside the form, or use
-     * the default inner content (or possibly generate this all yourself using
-     * redirect_url() and redirect_args() or redirect_args_as_inputs()).
-     * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
-     * (and any querystring variables in the redirect_url are converted into html inputs
-     * so browsers submit them properly)
-     *
-     * @param string $inside_form_html
-     * @return string html
-     * @throws \EE_Error
-     */
-    public function redirect_form($inside_form_html = null)
-    {
-        $redirect_url = $this->redirect_url();
-        if (! empty($redirect_url)) {
-            // what ? no inner form content?
-            if ($inside_form_html === null) {
-                $inside_form_html = EEH_HTML::p(
-                    sprintf(
-                        __(
-                            'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
-                            'event_espresso'
-                        ),
-                        EEH_HTML::br(2),
-                        '<input type="submit" value="',
-                        '">'
-                    ),
-                    '',
-                    '',
-                    'text-align:center;'
-                );
-            }
-            $method = apply_filters(
-                'FHEE__EE_Payment__redirect_form__method',
-                $this->redirect_args() ? 'POST' : 'GET',
-                $this
-            );
-            // if it's a GET request, we need to remove all the GET params in the querystring
-            // and put them into the form instead
-            if ($method === 'GET') {
-                $querystring = parse_url($redirect_url, PHP_URL_QUERY);
-                $get_params = null;
-                parse_str($querystring, $get_params);
-                $inside_form_html .= $this->_args_as_inputs($get_params);
-                $redirect_url = str_replace('?' . $querystring, '', $redirect_url);
-            }
-            $form = EEH_HTML::nl(1)
-                    . '<form method="'
-                    . $method
-                    . '" name="gateway_form" action="'
-                    . $redirect_url
-                    . '">';
-            $form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
-            $form .= $inside_form_html;
-            $form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
-            return $form;
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Changes all the name-value pairs of the redirect args into html inputs
-     * and returns the html as a string
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function redirect_args_as_inputs()
-    {
-        return $this->_args_as_inputs($this->redirect_args());
-    }
-
-
-    /**
-     * Converts a 1d array of key-value pairs into html hidden inputs
-     * and returns the string of html
-     *
-     * @param array $args key-value pairs
-     * @return string
-     */
-    protected function _args_as_inputs($args)
-    {
-        $html = '';
-        if ($args !== null && is_array($args)) {
-            foreach ($args as $name => $value) {
-                $html .= EEH_HTML::nl(0)
-                         . '<input type="hidden" name="'
-                         . $name
-                         . '" value="'
-                         . esc_attr($value)
-                         . '"/>';
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * Returns the currency of the payment.
-     * (At the time of writing, this will always be the currency in the configuration;
-     * however in the future it is anticipated that this will be stored on the payment
-     * object itself)
-     *
-     * @return string for the currency code
-     */
-    public function currency_code()
-    {
-        return EE_Config::instance()->currency->code;
-    }
-
-
-    /**
-     * apply wp_strip_all_tags to all elements within an array
-     *
-     * @access private
-     * @param mixed $item
-     */
-    private function _strip_all_tags_within_array(&$item)
-    {
-        if (is_object($item)) {
-            $item = (array) $item;
-        }
-        if (is_array($item)) {
-            array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
-        } else {
-            $item = wp_strip_all_tags($item);
-        }
-    }
-
-
-    /**
-     * Returns TRUE is this payment was set to approved during this request (or
-     * is approved and was created during this request). False otherwise.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function just_approved()
-    {
-        $original_status = EEH_Array::is_set(
-            $this->_props_n_values_provided_in_constructor,
-            'STS_ID',
-            $this->get_model()->field_settings_for('STS_ID')->get_default_value()
-        );
-        $current_status = $this->status();
-        if ($original_status !== EEM_Payment::status_id_approved
-            && $current_status === EEM_Payment::status_id_approved
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parents' get_pretty() function just for legacy reasons
-     * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        if ($field_name === 'PAY_gateway') {
-            return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
-        }
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * Gets details regarding which registrations this payment was applied to
-     *
-     * @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_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     *
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     *
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if ($primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * @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_Payment
+	 * @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_Payment
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Set Transaction ID
+	 *
+	 * @access public
+	 * @param int $TXN_ID
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets the transaction related to this payment
+	 *
+	 * @return EE_Transaction
+	 * @throws \EE_Error
+	 */
+	public function transaction()
+	{
+		return $this->get_first_related('Transaction');
+	}
+
+
+	/**
+	 * Set Status
+	 *
+	 * @access public
+	 * @param string $STS_ID
+	 * @throws \EE_Error
+	 */
+	public function set_status($STS_ID = '')
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Set Payment Timestamp
+	 *
+	 * @access public
+	 * @param int $timestamp
+	 * @throws \EE_Error
+	 */
+	public function set_timestamp($timestamp = 0)
+	{
+		$this->set('PAY_timestamp', $timestamp);
+	}
+
+
+	/**
+	 * Set Payment Method
+	 *
+	 * @access public
+	 * @param string $PAY_source
+	 * @throws \EE_Error
+	 */
+	public function set_source($PAY_source = '')
+	{
+		$this->set('PAY_source', $PAY_source);
+	}
+
+
+	/**
+	 * Set Payment Amount
+	 *
+	 * @access public
+	 * @param float $amount
+	 * @throws \EE_Error
+	 */
+	public function set_amount($amount = 0.00)
+	{
+		$this->set('PAY_amount', (float) $amount);
+	}
+
+
+	/**
+	 * Set Payment Gateway Response
+	 *
+	 * @access public
+	 * @param string $gateway_response
+	 * @throws \EE_Error
+	 */
+	public function set_gateway_response($gateway_response = '')
+	{
+		$this->set('PAY_gateway_response', $gateway_response);
+	}
+
+
+	/**
+	 * Returns the name of the payment method used on this payment (previously known merely as 'gateway')
+	 * but since 4.6.0, payment methods are models and the payment keeps a foreign key to the payment method
+	 * used on it
+	 *
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function gateway()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment::gateway',
+			__(
+				'The method EE_Payment::gateway() has been deprecated. Consider instead using EE_Payment::payment_method()->name()',
+				'event_espresso'
+			),
+			'4.6.0'
+		);
+		return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
+	}
+
+
+	/**
+	 * Set Gateway Transaction ID
+	 *
+	 * @access public
+	 * @param string $txn_id_chq_nmbr
+	 * @throws \EE_Error
+	 */
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '')
+	{
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
+	}
+
+
+	/**
+	 * Set Purchase Order Number
+	 *
+	 * @access public
+	 * @param string $po_number
+	 * @throws \EE_Error
+	 */
+	public function set_po_number($po_number = '')
+	{
+		$this->set('PAY_po_number', $po_number);
+	}
+
+
+	/**
+	 * Set Extra Accounting Field
+	 *
+	 * @access public
+	 * @param string $extra_accntng
+	 * @throws \EE_Error
+	 */
+	public function set_extra_accntng($extra_accntng = '')
+	{
+		$this->set('PAY_extra_accntng', $extra_accntng);
+	}
+
+
+	/**
+	 * Set Payment made via admin flag
+	 *
+	 * @access public
+	 * @param bool $via_admin
+	 * @throws \EE_Error
+	 */
+	public function set_payment_made_via_admin($via_admin = false)
+	{
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
+		} else {
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
+		}
+	}
+
+
+	/**
+	 * Set Payment Details
+	 *
+	 * @access public
+	 * @param string|array $details
+	 * @throws \EE_Error
+	 */
+	public function set_details($details = '')
+	{
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$details = wp_strip_all_tags($details);
+		}
+		$this->set('PAY_details', $details);
+	}
+
+
+	/**
+	 * Sets redirect_url
+	 *
+	 * @param string $redirect_url
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->set('PAY_redirect_url', $redirect_url);
+	}
+
+
+	/**
+	 * Sets redirect_args
+	 *
+	 * @param array $redirect_args
+	 * @throws \EE_Error
+	 */
+	public function set_redirect_args($redirect_args)
+	{
+		$this->set('PAY_redirect_args', $redirect_args);
+	}
+
+
+	/**
+	 * get Payment Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function status()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Status
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * get Payment Timestamp
+	 *
+	 * @access public
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function timestamp($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt . ' ' . $tm_frmt));
+	}
+
+
+	/**
+	 * get Payment Source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function source()
+	{
+		return $this->get('PAY_source');
+	}
+
+
+	/**
+	 * get Payment Amount
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function amount()
+	{
+		return (float) $this->get('PAY_amount');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function amount_no_code()
+	{
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
+	}
+
+
+	/**
+	 * get Payment Gateway Response
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function gateway_response()
+	{
+		return $this->get('PAY_gateway_response');
+	}
+
+
+	/**
+	 * get Payment Gateway Transaction ID
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function txn_id_chq_nmbr()
+	{
+		return $this->get('PAY_txn_id_chq_nmbr');
+	}
+
+
+	/**
+	 * get Purchase Order Number
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function po_number()
+	{
+		return $this->get('PAY_po_number');
+	}
+
+
+	/**
+	 * get Extra Accounting Field
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function extra_accntng()
+	{
+		return $this->get('PAY_extra_accntng');
+	}
+
+
+	/**
+	 * get Payment made via admin source
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function payment_made_via_admin()
+	{
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
+	}
+
+
+	/**
+	 * get Payment Details
+	 *
+	 * @access public
+	 * @throws \EE_Error
+	 */
+	public function details()
+	{
+		return $this->get('PAY_details');
+	}
+
+
+	/**
+	 * Gets redirect_url
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_url()
+	{
+		return $this->get('PAY_redirect_url');
+	}
+
+
+	/**
+	 * Gets redirect_args
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function redirect_args()
+	{
+		return $this->get('PAY_redirect_args');
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->STS_ID() => __('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->STS_ID()) {
+			case EEM_Payment::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_pending:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Payment::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->STS_ID() ];
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is approved or not
+	 * @throws \EE_Error
+	 */
+	public function is_approved()
+	{
+		return $this->status_is(EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * Generally determines if the status of this payment equals
+	 * the $STS_ID string
+	 *
+	 * @param string $STS_ID an ID from the esp_status table/
+	 *                       one of the status_id_* on the EEM_Payment model
+	 * @return boolean whether the status of this payment equals the status id
+	 * @throws \EE_Error
+	 */
+	protected function status_is($STS_ID)
+	{
+		return $STS_ID === $this->STS_ID() ? true : false;
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean whether the payment is pending or not
+	 * @throws \EE_Error
+	 */
+	public function is_pending()
+	{
+		return $this->status_is(EEM_Payment::status_id_pending);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_is(EEM_Payment::status_id_cancelled);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_declined()
+	{
+		return $this->status_is(EEM_Payment::status_id_declined);
+	}
+
+
+	/**
+	 * For determining the status of the payment
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_failed()
+	{
+		return $this->status_is(EEM_Payment::status_id_failed);
+	}
+
+
+	/**
+	 * For determining if the payment is actually a refund ( ie: has a negative value )
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_a_refund()
+	{
+		return $this->amount() < 0 ? true : false;
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws \EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Extra_Meta
+	 * @throws \EE_Error
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public function payment_method()
+	{
+		return $this->get_first_related('Payment_Method');
+	}
+
+
+	/**
+	 * Gets the HTML for redirecting the user to an offsite gateway
+	 * You can pass it special content to put inside the form, or use
+	 * the default inner content (or possibly generate this all yourself using
+	 * redirect_url() and redirect_args() or redirect_args_as_inputs()).
+	 * Creates a POST request by default, but if no redirect args are specified, creates a GET request instead
+	 * (and any querystring variables in the redirect_url are converted into html inputs
+	 * so browsers submit them properly)
+	 *
+	 * @param string $inside_form_html
+	 * @return string html
+	 * @throws \EE_Error
+	 */
+	public function redirect_form($inside_form_html = null)
+	{
+		$redirect_url = $this->redirect_url();
+		if (! empty($redirect_url)) {
+			// what ? no inner form content?
+			if ($inside_form_html === null) {
+				$inside_form_html = EEH_HTML::p(
+					sprintf(
+						__(
+							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
+							'event_espresso'
+						),
+						EEH_HTML::br(2),
+						'<input type="submit" value="',
+						'">'
+					),
+					'',
+					'',
+					'text-align:center;'
+				);
+			}
+			$method = apply_filters(
+				'FHEE__EE_Payment__redirect_form__method',
+				$this->redirect_args() ? 'POST' : 'GET',
+				$this
+			);
+			// if it's a GET request, we need to remove all the GET params in the querystring
+			// and put them into the form instead
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
+				$get_params = null;
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?' . $querystring, '', $redirect_url);
+			}
+			$form = EEH_HTML::nl(1)
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
+			$form .= EEH_HTML::nl(1) . $this->redirect_args_as_inputs();
+			$form .= $inside_form_html;
+			$form .= EEH_HTML::nl(-1) . '</form>' . EEH_HTML::nl(-1);
+			return $form;
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Changes all the name-value pairs of the redirect args into html inputs
+	 * and returns the html as a string
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function redirect_args_as_inputs()
+	{
+		return $this->_args_as_inputs($this->redirect_args());
+	}
+
+
+	/**
+	 * Converts a 1d array of key-value pairs into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param array $args key-value pairs
+	 * @return string
+	 */
+	protected function _args_as_inputs($args)
+	{
+		$html = '';
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= EEH_HTML::nl(0)
+						 . '<input type="hidden" name="'
+						 . $name
+						 . '" value="'
+						 . esc_attr($value)
+						 . '"/>';
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * Returns the currency of the payment.
+	 * (At the time of writing, this will always be the currency in the configuration;
+	 * however in the future it is anticipated that this will be stored on the payment
+	 * object itself)
+	 *
+	 * @return string for the currency code
+	 */
+	public function currency_code()
+	{
+		return EE_Config::instance()->currency->code;
+	}
+
+
+	/**
+	 * apply wp_strip_all_tags to all elements within an array
+	 *
+	 * @access private
+	 * @param mixed $item
+	 */
+	private function _strip_all_tags_within_array(&$item)
+	{
+		if (is_object($item)) {
+			$item = (array) $item;
+		}
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
+		} else {
+			$item = wp_strip_all_tags($item);
+		}
+	}
+
+
+	/**
+	 * Returns TRUE is this payment was set to approved during this request (or
+	 * is approved and was created during this request). False otherwise.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function just_approved()
+	{
+		$original_status = EEH_Array::is_set(
+			$this->_props_n_values_provided_in_constructor,
+			'STS_ID',
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
+		);
+		$current_status = $this->status();
+		if ($original_status !== EEM_Payment::status_id_approved
+			&& $current_status === EEM_Payment::status_id_approved
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parents' get_pretty() function just for legacy reasons
+	 * (to allow ticket https://events.codebasehq.com/projects/event-espresso/tickets/7420)
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
+		}
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Gets details regarding which registrations this payment was applied to
+	 *
+	 * @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_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 *
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 *
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if ($primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }

core/db_classes/EE_Registration_Payment.class.php

Indentation +94 added lines, -94 removed lines

@@ -14,98 +14,98 @@
 class EE_Registration_Payment extends EE_Base_Class
 {
 
-    /**
-     *
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Registration_Payment
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $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
-     * @param string $timezone
-     * @return EE_Registration_Payment
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * registration_ID
-     *
-     * @access    public
-     * @return    int
-     */
-    public function registration_ID()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     * payment_ID
-     *
-     * @access    public
-     * @return    int
-     */
-    public function payment_ID()
-    {
-        return $this->get('PAY_ID');
-    }
-
-
-    /**
-     * amount
-     *
-     * @access    public
-     * @return    float
-     */
-    public function amount()
-    {
-        return $this->get('RPY_amount');
-    }
-
-
-    /**
-     * amount
-     *
-     * @access    public
-     * @param float $amount
-     */
-    public function set_amount($amount = 0.000)
-    {
-        $this->set('RPY_amount', $amount);
-    }
-
-
-    /**
-     * registration
-     *
-     * @access    public
-     * @return \EE_Registration
-     */
-    public function registration()
-    {
-        return $this->get_first_related('Registration');
-    }
-
-
-    /**
-     * payment
-     *
-     * @access    public
-     * @return \EE_Payment
-     */
-    public function payment()
-    {
-        return $this->get_first_related('Payment');
-    }
+	/**
+	 *
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Registration_Payment
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $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
+	 * @param string $timezone
+	 * @return EE_Registration_Payment
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * registration_ID
+	 *
+	 * @access    public
+	 * @return    int
+	 */
+	public function registration_ID()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 * payment_ID
+	 *
+	 * @access    public
+	 * @return    int
+	 */
+	public function payment_ID()
+	{
+		return $this->get('PAY_ID');
+	}
+
+
+	/**
+	 * amount
+	 *
+	 * @access    public
+	 * @return    float
+	 */
+	public function amount()
+	{
+		return $this->get('RPY_amount');
+	}
+
+
+	/**
+	 * amount
+	 *
+	 * @access    public
+	 * @param float $amount
+	 */
+	public function set_amount($amount = 0.000)
+	{
+		$this->set('RPY_amount', $amount);
+	}
+
+
+	/**
+	 * registration
+	 *
+	 * @access    public
+	 * @return \EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->get_first_related('Registration');
+	}
+
+
+	/**
+	 * payment
+	 *
+	 * @access    public
+	 * @return \EE_Payment
+	 */
+	public function payment()
+	{
+		return $this->get_first_related('Payment');
+	}
 }

core/db_classes/EE_Question_Group_Question.class.php

Indentation +17 added lines, -17 removed lines

@@ -6,23 +6,23 @@
 class EE_Question_Group_Question extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group_Question|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group_Question|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group_Question
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 }

core/db_classes/EE_State.class.php

Indentation +100 added lines, -100 removed lines

@@ -11,104 +11,104 @@
 class EE_State extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_State|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_State
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_iso()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function abbrev()
-    {
-        return $this->get('STA_abbrev');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function active()
-    {
-        return $this->get('STA_active');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('STA_name');
-    }
-
-
-    /**
-     * @return EE_Country
-     */
-    public function country()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * @param $iso
-     */
-    public function set_country_iso($iso)
-    {
-        $this->set('CNT_ISO', $iso);
-    }
-
-
-    /**
-     * @param $abbrev
-     */
-    public function set_abbrev($abbrev)
-    {
-        $this->set('STA_abbrev', $abbrev);
-    }
-
-
-    /**
-     * @param $active
-     */
-    public function set_active($active)
-    {
-        $this->set('STA_active', $active);
-    }
-
-
-    /**
-     * @param $name
-     */
-    public function set_name($name)
-    {
-        $this->set('STA_name', $name);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_State|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_State
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_iso()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function abbrev()
+	{
+		return $this->get('STA_abbrev');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function active()
+	{
+		return $this->get('STA_active');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('STA_name');
+	}
+
+
+	/**
+	 * @return EE_Country
+	 */
+	public function country()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * @param $iso
+	 */
+	public function set_country_iso($iso)
+	{
+		$this->set('CNT_ISO', $iso);
+	}
+
+
+	/**
+	 * @param $abbrev
+	 */
+	public function set_abbrev($abbrev)
+	{
+		$this->set('STA_abbrev', $abbrev);
+	}
+
+
+	/**
+	 * @param $active
+	 */
+	public function set_active($active)
+	{
+		$this->set('STA_active', $active);
+	}
+
+
+	/**
+	 * @param $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('STA_name', $name);
+	}
 }

core/db_classes/EE_Event_Message_Template.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Event_Message_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @param null  $timezone
-     * @return EE_Event_Message_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null)
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @param null  $timezone
+	 * @return EE_Event_Message_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null)
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @param null  $timezone
-     * @return EE_Event_Message_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @param null  $timezone
+	 * @return EE_Event_Message_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Change_Log.class.php

Indentation +213 added lines, -213 removed lines

@@ -11,217 +11,217 @@
 class EE_Change_Log extends EE_Base_Class
 {
 
-    /**
-     * @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_Change_Log
-     * @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_Change_Log
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-    /**
-     * Gets message
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function message()
-    {
-        return $this->get('LOG_message');
-    }
-
-    /**
-     * Sets message
-     *
-     * @param mixed $message
-     * @throws EE_Error
-     */
-    public function set_message($message)
-    {
-        $this->set('LOG_message', $message);
-    }
-
-    /**
-     * Gets time
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function time()
-    {
-        return $this->get('LOG_time');
-    }
-
-    /**
-     * Sets time
-     *
-     * @param string $time
-     * @throws EE_Error
-     */
-    public function set_time($time)
-    {
-        $this->set('LOG_time', $time);
-    }
-
-    /**
-     * Gets log_type
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type()
-    {
-        return $this->get('LOG_type');
-    }
-
-
-    /**
-     * Return the localized log type label.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function log_type_label()
-    {
-        return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
-    }
-
-    /**
-     * Sets log_type
-     *
-     * @param string $log_type
-     * @throws EE_Error
-     */
-    public function set_log_type($log_type)
-    {
-        $this->set('LOG_type', $log_type);
-    }
-
-    /**
-     * Gets type of the model object related to this log
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function OBJ_type()
-    {
-        return $this->get('OBJ_type');
-    }
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @throws EE_Error
-     */
-    public function set_OBJ_type($type)
-    {
-        $this->set('OBJ_type', $type);
-    }
-
-    /**
-     * Gets OBJ_ID (the ID of the item related to this log)
-     *
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function OBJ_ID()
-    {
-        return $this->get('OBJ_ID');
-    }
-
-    /**
-     * Sets OBJ_ID
-     *
-     * @param mixed $OBJ_ID
-     * @throws EE_Error
-     */
-    public function set_OBJ_ID($OBJ_ID)
-    {
-        $this->set('OBJ_ID', $OBJ_ID);
-    }
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('LOG_wp_user');
-    }
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('LOG_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Gets the model object attached to this log
-     *
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function object()
-    {
-        $model_name_of_related_obj = $this->OBJ_type();
-        $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
-            return null;
-        } else {
-            return $this->get_first_related($model_name_of_related_obj);
-        }
-    }
-
-    /**
-     * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
-     * _add_relation_to because you don't have to specify what type of model you're
-     * associating it with
-     *
-     * @param EE_Base_Class $object
-     * @param boolean       $save
-     * @return bool if $save=true, NULL is $save=false
-     * @throws EE_Error
-     */
-    public function set_object($object, $save = true)
-    {
-        if ($object instanceof EE_Base_Class) {
-            $this->set_OBJ_type($object->get_model()->get_this_model_name());
-            $this->set_OBJ_ID($object->ID());
-        } else {
-            $this->set_OBJ_type(null);
-            $this->set_OBJ_ID(null);
-        }
-        if ($save) {
-            return $this->save();
-        } else {
-            return null;
-        }
-    }
+	/**
+	 * @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_Change_Log
+	 * @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_Change_Log
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+	/**
+	 * Gets message
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function message()
+	{
+		return $this->get('LOG_message');
+	}
+
+	/**
+	 * Sets message
+	 *
+	 * @param mixed $message
+	 * @throws EE_Error
+	 */
+	public function set_message($message)
+	{
+		$this->set('LOG_message', $message);
+	}
+
+	/**
+	 * Gets time
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function time()
+	{
+		return $this->get('LOG_time');
+	}
+
+	/**
+	 * Sets time
+	 *
+	 * @param string $time
+	 * @throws EE_Error
+	 */
+	public function set_time($time)
+	{
+		$this->set('LOG_time', $time);
+	}
+
+	/**
+	 * Gets log_type
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type()
+	{
+		return $this->get('LOG_type');
+	}
+
+
+	/**
+	 * Return the localized log type label.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function log_type_label()
+	{
+		return EEM_Change_Log::get_pretty_label_for_type($this->log_type());
+	}
+
+	/**
+	 * Sets log_type
+	 *
+	 * @param string $log_type
+	 * @throws EE_Error
+	 */
+	public function set_log_type($log_type)
+	{
+		$this->set('LOG_type', $log_type);
+	}
+
+	/**
+	 * Gets type of the model object related to this log
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function OBJ_type()
+	{
+		return $this->get('OBJ_type');
+	}
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_type($type)
+	{
+		$this->set('OBJ_type', $type);
+	}
+
+	/**
+	 * Gets OBJ_ID (the ID of the item related to this log)
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function OBJ_ID()
+	{
+		return $this->get('OBJ_ID');
+	}
+
+	/**
+	 * Sets OBJ_ID
+	 *
+	 * @param mixed $OBJ_ID
+	 * @throws EE_Error
+	 */
+	public function set_OBJ_ID($OBJ_ID)
+	{
+		$this->set('OBJ_ID', $OBJ_ID);
+	}
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('LOG_wp_user');
+	}
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('LOG_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Gets the model object attached to this log
+	 *
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function object()
+	{
+		$model_name_of_related_obj = $this->OBJ_type();
+		$is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
+		if (! $is_model_name) {
+			return null;
+		} else {
+			return $this->get_first_related($model_name_of_related_obj);
+		}
+	}
+
+	/**
+	 * Shorthand for setting the OBJ_ID and OBJ_type. Slightly handier than using
+	 * _add_relation_to because you don't have to specify what type of model you're
+	 * associating it with
+	 *
+	 * @param EE_Base_Class $object
+	 * @param boolean       $save
+	 * @return bool if $save=true, NULL is $save=false
+	 * @throws EE_Error
+	 */
+	public function set_object($object, $save = true)
+	{
+		if ($object instanceof EE_Base_Class) {
+			$this->set_OBJ_type($object->get_model()->get_this_model_name());
+			$this->set_OBJ_ID($object->ID());
+		} else {
+			$this->set_OBJ_type(null);
+			$this->set_OBJ_ID(null);
+		}
+		if ($save) {
+			return $this->save();
+		} else {
+			return null;
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
     {
         $model_name_of_related_obj = $this->OBJ_type();
         $is_model_name = EE_Registry::instance()->is_model_name($model_name_of_related_obj);
-        if (! $is_model_name) {
+        if ( ! $is_model_name) {
             return null;
         } else {
             return $this->get_first_related($model_name_of_related_obj);

core/libraries/line_item_filters/EE_Line_Item_Filter_Processor.class.php

Indentation +75 added lines, -75 removed lines

@@ -36,88 +36,88 @@
 class EE_Line_Item_Filter_Processor
 {
 
-    /**
-     * @type EE_Line_Item_Filter_Collection $line_item_filters
-     */
-    protected $line_item_filters;
+	/**
+	 * @type EE_Line_Item_Filter_Collection $line_item_filters
+	 */
+	protected $line_item_filters;
 
-    /**
-     * @type EEI_Line_Item $grand_total_line_item
-     */
-    protected $grand_total_line_item;
+	/**
+	 * @type EEI_Line_Item $grand_total_line_item
+	 */
+	protected $grand_total_line_item;
 
 
-    /**
-     * EE_Line_Item_Filter_Processor constructor.
-     *
-     * @param \EE_Line_Item_Filter_Collection $line_item_filters
-     * @param \EEI_Line_Item                  $grand_total_line_item
-     * @throws \EE_Error
-     */
-    public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
-    {
-        $this->line_item_filters = $line_item_filters;
-        if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
-            throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
-        }
-        $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
-    }
+	/**
+	 * EE_Line_Item_Filter_Processor constructor.
+	 *
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filters
+	 * @param \EEI_Line_Item                  $grand_total_line_item
+	 * @throws \EE_Error
+	 */
+	public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
+	{
+		$this->line_item_filters = $line_item_filters;
+		if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
+			throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
+		}
+		$this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
+	}
 
 
-    /**
-     * clone_and_reset_line_item_tree
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
-    {
-        $cloned_line_item = $this->clone_and_reset_line_item($line_item);
-        foreach ($line_item->children() as $child_line_item) {
-            $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
-        }
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item_tree
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
+	{
+		$cloned_line_item = $this->clone_and_reset_line_item($line_item);
+		foreach ($line_item->children() as $child_line_item) {
+			$cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
+		}
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * clone_and_reset_line_item
-     *
-     * clones the incoming object
-     * resets any fields that represent database primary keys
-     * resets total
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
-    {
-        // we don't actually want to work with the original line item, so clone it
-        $cloned_line_item = clone $line_item;
-        $cloned_line_item->set('LIN_ID', null);
-        $cloned_line_item->set('LIN_parent', null);
-        $cloned_line_item->clear_related_line_item_cache();
-        foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
-            $cloned_line_item->clear_cache($relation_name, null, true);
-        }
-        $cloned_line_item->set_allow_persist(false);
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item
+	 *
+	 * clones the incoming object
+	 * resets any fields that represent database primary keys
+	 * resets total
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
+	{
+		// we don't actually want to work with the original line item, so clone it
+		$cloned_line_item = clone $line_item;
+		$cloned_line_item->set('LIN_ID', null);
+		$cloned_line_item->set('LIN_parent', null);
+		$cloned_line_item->clear_related_line_item_cache();
+		foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
+			$cloned_line_item->clear_cache($relation_name, null, true);
+		}
+		$cloned_line_item->set_allow_persist(false);
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * process
-     *
-     * @return EEI_Line_Item
-     */
-    public function process()
-    {
-        $this->line_item_filters->rewind();
-        while ($this->line_item_filters->valid()) {
-            $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
-            $this->line_item_filters->next();
-        }
-        $this->grand_total_line_item->recalculate_total_including_taxes();
-        return $this->grand_total_line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @return EEI_Line_Item
+	 */
+	public function process()
+	{
+		$this->line_item_filters->rewind();
+		while ($this->line_item_filters->valid()) {
+			$this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
+			$this->line_item_filters->next();
+		}
+		$this->grand_total_line_item->recalculate_total_including_taxes();
+		return $this->grand_total_line_item;
+	}
 }

core/libraries/line_item_filters/EE_Non_Zero_Line_Item_Filter.class.php

Indentation +86 added lines, -86 removed lines

@@ -14,96 +14,96 @@
 class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
 
-    /**
-     * EE_Non_Zero_Line_Item_Filter constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * EE_Non_Zero_Line_Item_Filter constructor.
+	 */
+	public function __construct()
+	{
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        if ($line_item->children()) {
-            $ticket_or_subtotals_with_tkt_children_count = 0;
-            foreach ($line_item->children() as $child_line_item) {
-                $code = $child_line_item->code();
-                $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
-                    $line_item->delete_child_line_item($code);
-                    continue;
-                }
-                if ((
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_sub_total
-                    )
-                    || (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_line_item
-                        && $child_line_item->OBJ_type() === 'Ticket'
-                    )
-                ) {
-                    $ticket_or_subtotals_with_tkt_children_count++;
-                }
-            }
-            // if this is an event subtotal with NO ticket children
-            // we basically want to ignore it
-            return $this->_filter_zero_subtotal_line_item(
-                $non_zero_line_item,
-                $ticket_or_subtotals_with_tkt_children_count
-            );
-        }
-        return $non_zero_line_item;
-    }
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$non_zero_line_item = $this->_filter_zero_line_item($line_item);
+		if (! $non_zero_line_item instanceof EEI_Line_Item) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		if ($line_item->children()) {
+			$ticket_or_subtotals_with_tkt_children_count = 0;
+			foreach ($line_item->children() as $child_line_item) {
+				$code = $child_line_item->code();
+				$child_line_item = $this->process($child_line_item);
+				if (! $child_line_item instanceof EEI_Line_Item) {
+					$line_item->delete_child_line_item($code);
+					continue;
+				}
+				if ((
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_sub_total
+					)
+					|| (
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_line_item
+						&& $child_line_item->OBJ_type() === 'Ticket'
+					)
+				) {
+					$ticket_or_subtotals_with_tkt_children_count++;
+				}
+			}
+			// if this is an event subtotal with NO ticket children
+			// we basically want to ignore it
+			return $this->_filter_zero_subtotal_line_item(
+				$non_zero_line_item,
+				$ticket_or_subtotals_with_tkt_children_count
+			);
+		}
+		return $non_zero_line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_line_item(EEI_Line_Item $line_item)
-    {
-        if ($line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === 'Ticket'
-            && (int) $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_line_item(EEI_Line_Item $line_item)
+	{
+		if ($line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === 'Ticket'
+			&& (int) $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @param int           $ticket_children
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
-    {
-        if ((int) $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param int           $ticket_children
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
+	{
+		if ((int) $ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
+        if ( ! $non_zero_line_item instanceof EEI_Line_Item) {
             return null;
         }
         // if this is an event subtotal, we want to only include it if it
@@ -42,7 +42,7 @@ 
             foreach ($line_item->children() as $child_line_item) {
                 $code = $child_line_item->code();
                 $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
+                if ( ! $child_line_item instanceof EEI_Line_Item) {
                     $line_item->delete_child_line_item($code);
                     continue;
                 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Collection.class.php

Indentation +7 added lines, -7 removed lines

@@ -18,11 +18,11 @@
 {
 
 
-    /**
-     * EE_Line_Item_Filter_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EEI_Line_Item_Filter';
-    }
+	/**
+	 * EE_Line_Item_Filter_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EEI_Line_Item_Filter';
+	}
 }