eventespresso / event-espresso-core

core/db_classes/EE_Payment.class.php

Spacing +8 added lines, -8 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;
@@ -725,8 +725,8 @@ 
             return $html;
         }
         return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
+            . '<input type="hidden" name="'.$name.'"'
+            . ' value="'.esc_attr($value).'"/>';
     }
 
 

Indentation +870 added lines, -870 removed lines

@@ -10,874 +10,874 @@
 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',
-            esc_html__(
-                '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() : esc_html__('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); // already escaped
-    }
-
-
-    /**
-     * 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() => esc_html__('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(
-                        esc_html__(
-                            '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 2d 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 .= $this->generateInput($name, $value);
-            }
-        }
-        return $html;
-    }
-
-    /**
-     * Converts either a single name and value or array of values into html hidden inputs
-     * and returns the string of html
-     *
-     * @param string $name
-     * @param string|array $value
-     * @return string
-     */
-    private function generateInput($name, $value)
-    {
-        if (is_array($value)) {
-            $html = '';
-            $name = "{$name}[]";
-            foreach ($value as $array_value) {
-                $html .= $this->generateInput($name, $array_value);
-            }
-            return $html;
-        }
-        return EEH_HTML::nl()
-            . '<input type="hidden" name="' . $name . '"'
-            . ' value="' . esc_attr($value) . '"/>';
-    }
-
-
-    /**
-     * 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() : esc_html__('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() : esc_html__('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',
+			esc_html__(
+				'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() : esc_html__('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); // already escaped
+	}
+
+
+	/**
+	 * 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() => esc_html__('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(
+						esc_html__(
+							'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 2d 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 .= $this->generateInput($name, $value);
+			}
+		}
+		return $html;
+	}
+
+	/**
+	 * Converts either a single name and value or array of values into html hidden inputs
+	 * and returns the string of html
+	 *
+	 * @param string $name
+	 * @param string|array $value
+	 * @return string
+	 */
+	private function generateInput($name, $value)
+	{
+		if (is_array($value)) {
+			$html = '';
+			$name = "{$name}[]";
+			foreach ($value as $array_value) {
+				$html .= $this->generateInput($name, $array_value);
+			}
+			return $html;
+		}
+		return EEH_HTML::nl()
+			. '<input type="hidden" name="' . $name . '"'
+			. ' value="' . esc_attr($value) . '"/>';
+	}
+
+
+	/**
+	 * 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() : esc_html__('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() : esc_html__('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_Payment_Method.class.php

Spacing +8 added lines, -8 removed lines

@@ -445,11 +445,11 @@ 
      */
     public function type_obj()
     {
-        if (! $this->_type_obj) {
+        if ( ! $this->_type_obj) {
             EE_Registry::instance()->load_lib('Payment_Method_Manager');
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
                 $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
+                if ( ! class_exists($class_name)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -458,7 +458,7 @@ 
                             ),
                             $class_name,
                             '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
+                            '<a href="'.admin_url('plugins.php').'">',
                             '</a>'
                         )
                     );
@@ -499,7 +499,7 @@ 
         foreach ($fields as $key => $value) {
             if (strpos($key, 'PMD_') === 0) {
                 $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
+                $combined_settings_array [$key_sans_model_prefix] = $value;
             }
         }
         $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
@@ -522,14 +522,14 @@ 
 		 <div id="'
                . $this->slug()
                . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+               . $payment_occurs.'-payment-gateway reg-page-payment-option-dv'.$css_class.'">
 			<a id="payment-gateway-button-' . $this->slug()
                . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
-				<img src="' . $this->button_url() . '" alt="' . sprintf(
+               . $this->slug().'" href="'.$url.'" >
+				<img src="' . $this->button_url().'" alt="'.sprintf(
                    esc_attr__('Pay using %s', 'event_espresso'),
                    $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+               ).'" />
 			</a>
 		</div>
 ';

Indentation +572 added lines, -572 removed lines

@@ -14,582 +14,582 @@
 class EE_Payment_Method extends EE_Base_Class
 {
 
-    /**
-     * Payment Method type object, which has all the info about this type of payment method,
-     * including functions for processing payments, to get settings forms, etc.
-     *
-     * @var EE_PMT_Base
-     */
-    protected $_type_obj;
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    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, false);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Payment_Method
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-
-    /**
-     * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
-     * Otherwise returns a normal EE_Payment_Method
-     *
-     * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
-     *                              the classname minus 'EEPM_')
-     * @return string
-     */
-    // private static function _payment_method_type($props_n_values)
-    // {
-    //     EE_Registry::instance()->load_lib('Payment_Method_Manager');
-    //     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
-    //     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
-    //         return 'EEPM_' . $type_string;
-    //     } else {
-    //         return __CLASS__;
-    //     }
-    // }
-
-
-    /**
-     * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
-     *
-     * @return boolean
-     */
-    public function active()
-    {
-        return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
-    }
-
-
-    /**
-     * Sets this PM as active by making it usable within the CART scope. Offline gateways
-     * are also usable from the admin-scope as well. DOES NOT SAVE it
-     *
-     * @throws \EE_Error
-     */
-    public function set_active()
-    {
-        $default_scopes = array(EEM_Payment_Method::scope_cart);
-        if (
-            $this->type_obj() &&
-            $this->type_obj()->payment_occurs() === EE_PMT_Base::offline
-        ) {
-            $default_scopes[] = EEM_Payment_Method::scope_admin;
-        }
-        $this->set_scope($default_scopes);
-    }
-
-
-    /**
-     * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
-     */
-    public function deactivate()
-    {
-        $this->set_scope(array());
-    }
-
-
-    /**
-     * Gets button_url
-     *
-     * @return string
-     */
-    public function button_url()
-    {
-        return $this->get('PMD_button_url');
-    }
-
-
-    /**
-     * Sets button_url
-     *
-     * @param string $button_url
-     */
-    public function set_button_url($button_url)
-    {
-        $this->set('PMD_button_url', $button_url);
-    }
-
-
-    /**
-     * Gets debug_mode
-     *
-     * @return boolean
-     */
-    public function debug_mode()
-    {
-        return $this->get('PMD_debug_mode');
-    }
-
-
-    /**
-     * Sets debug_mode
-     *
-     * @param boolean $debug_mode
-     */
-    public function set_debug_mode($debug_mode)
-    {
-        $this->set('PMD_debug_mode', $debug_mode);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('PMD_desc');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     */
-    public function set_description($description)
-    {
-        $this->set('PMD_desc', $description);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('PMD_name');
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     */
-    public function set_name($name)
-    {
-        $this->set('PMD_name', $name);
-    }
-
-
-    /**
-     * Gets open_by_default
-     *
-     * @return boolean
-     */
-    public function open_by_default()
-    {
-        return $this->get('PMD_open_by_default');
-    }
-
-
-    /**
-     * Sets open_by_default
-     *
-     * @param boolean $open_by_default
-     */
-    public function set_open_by_default($open_by_default)
-    {
-        $this->set('PMD_open_by_default', $open_by_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('PMD_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->set('PMD_order', $order);
-    }
-
-
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('PMD_slug');
-    }
-
-
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     */
-    public function set_slug($slug)
-    {
-        $this->set('PMD_slug', $slug);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('PMD_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     */
-    public function set_type($type)
-    {
-        $this->set('PMD_type', $type);
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PMD_wp_user');
-    }
-
-
-    /**
-     * Sets wp_user
-     *
-     * @param int $wp_user_id
-     */
-    public function set_wp_user($wp_user_id)
-    {
-        $this->set('PMD_wp_user', $wp_user_id);
-    }
-
-    /**
-     * Overrides parent so when PMD_type is changed we refresh the _type_obj
-     *
-     * @param string $field_name
-     * @param mixed $field_value
-     * @param boolean $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'PMD_type') {
-            // the type has probably changed, so forget about its old type object
-            $this->_type_obj = null;
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * Gets admin_name
-     *
-     * @return string
-     */
-    public function admin_name()
-    {
-        return $this->get('PMD_admin_name');
-    }
-
-
-    /**
-     * Sets admin_name
-     *
-     * @param string $admin_name
-     */
-    public function set_admin_name($admin_name)
-    {
-        $this->set('PMD_admin_name', $admin_name);
-    }
-
-
-    /**
-     * Gets admin_desc
-     *
-     * @return string
-     */
-    public function admin_desc()
-    {
-        return $this->get('PMD_admin_desc');
-    }
-
-
-    /**
-     * Sets admin_desc
-     *
-     * @param string $admin_desc
-     */
-    public function set_admin_desc($admin_desc)
-    {
-        $this->set('PMD_admin_desc', $admin_desc);
-    }
-
-
-    /**
-     * Gets scope
-     *
-     * @return array
-     */
-    public function scope()
-    {
-        return $this->get('PMD_scope');
-    }
-
-
-    /**
-     * Sets scope
-     *
-     * @param array $scope
-     */
-    public function set_scope($scope)
-    {
-        $this->set('PMD_scope', $scope);
-    }
-
-
-    /**
-     * Gets the payment method type for this payment method instance
-     *
-     * @return EE_PMT_Base
-     * @throws EE_Error
-     */
-    public function type_obj()
-    {
-        if (! $this->_type_obj) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
-                $class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
-                if (! class_exists($class_name)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
-                                'event_espresso'
-                            ),
-                            $class_name,
-                            '<br />',
-                            '<a href="' . admin_url('plugins.php') . '">',
-                            '</a>'
-                        )
-                    );
-                }
-                $r = new ReflectionClass($class_name);
-                $this->_type_obj = $r->newInstanceArgs(array($this));
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->type(),
-                        implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
-                    )
-                );
-            }
-        }
-        return $this->_type_obj;
-    }
-
-
-    /**
-     * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
-     * and the extra meta. Mostly used for passing off ot gateways.     *
-     *
-     * @return array
-     */
-    public function settings_array()
-    {
-        $fields = $this->model_field_array();
-        $extra_meta = $this->all_extra_meta_array();
-        // remove the model's prefix from the fields
-        $combined_settings_array = array();
-        foreach ($fields as $key => $value) {
-            if (strpos($key, 'PMD_') === 0) {
-                $key_sans_model_prefix = str_replace('PMD_', '', $key);
-                $combined_settings_array [ $key_sans_model_prefix ] = $value;
-            }
-        }
-        $combined_settings_array = array_merge($extra_meta, $combined_settings_array);
-        return $combined_settings_array;
-    }
-
-
-    /**
-     * Gets the HTML for displaying the payment method on a page.
-     *
-     * @param string $url
-     * @param string $css_class
-     * @return string of HTML for displaying the button
-     * @throws \EE_Error
-     */
-    public function button_html($url = '', $css_class = '')
-    {
-        $payment_occurs = $this->type_obj()->payment_occurs();
-        return '
+	/**
+	 * Payment Method type object, which has all the info about this type of payment method,
+	 * including functions for processing payments, to get settings forms, etc.
+	 *
+	 * @var EE_PMT_Base
+	 */
+	protected $_type_obj;
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	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, false);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Payment_Method
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+
+	/**
+	 * Checks if there is a payment method class of the given 'PMD_type', and if so returns the classname.
+	 * Otherwise returns a normal EE_Payment_Method
+	 *
+	 * @param array $props_n_values where 'PMD_type' is a gateway name like 'Paypal_Standard','Invoice',etc (basically
+	 *                              the classname minus 'EEPM_')
+	 * @return string
+	 */
+	// private static function _payment_method_type($props_n_values)
+	// {
+	//     EE_Registry::instance()->load_lib('Payment_Method_Manager');
+	//     $type_string = isset($props_n_values['PMD_type']) ? $props_n_values['PMD_type'] : null;
+	//     if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($type_string)) {
+	//         return 'EEPM_' . $type_string;
+	//     } else {
+	//         return __CLASS__;
+	//     }
+	// }
+
+
+	/**
+	 * Gets whether this payment method can be used anywhere at all (ie frontend cart, admin, etc)
+	 *
+	 * @return boolean
+	 */
+	public function active()
+	{
+		return array_intersect(array_keys(EEM_Payment_Method::instance()->scopes()), $this->scope());
+	}
+
+
+	/**
+	 * Sets this PM as active by making it usable within the CART scope. Offline gateways
+	 * are also usable from the admin-scope as well. DOES NOT SAVE it
+	 *
+	 * @throws \EE_Error
+	 */
+	public function set_active()
+	{
+		$default_scopes = array(EEM_Payment_Method::scope_cart);
+		if (
+			$this->type_obj() &&
+			$this->type_obj()->payment_occurs() === EE_PMT_Base::offline
+		) {
+			$default_scopes[] = EEM_Payment_Method::scope_admin;
+		}
+		$this->set_scope($default_scopes);
+	}
+
+
+	/**
+	 * Makes this payment method apply to NO scopes at all. DOES NOT SAVE it.
+	 */
+	public function deactivate()
+	{
+		$this->set_scope(array());
+	}
+
+
+	/**
+	 * Gets button_url
+	 *
+	 * @return string
+	 */
+	public function button_url()
+	{
+		return $this->get('PMD_button_url');
+	}
+
+
+	/**
+	 * Sets button_url
+	 *
+	 * @param string $button_url
+	 */
+	public function set_button_url($button_url)
+	{
+		$this->set('PMD_button_url', $button_url);
+	}
+
+
+	/**
+	 * Gets debug_mode
+	 *
+	 * @return boolean
+	 */
+	public function debug_mode()
+	{
+		return $this->get('PMD_debug_mode');
+	}
+
+
+	/**
+	 * Sets debug_mode
+	 *
+	 * @param boolean $debug_mode
+	 */
+	public function set_debug_mode($debug_mode)
+	{
+		$this->set('PMD_debug_mode', $debug_mode);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('PMD_desc');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 */
+	public function set_description($description)
+	{
+		$this->set('PMD_desc', $description);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('PMD_name');
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('PMD_name', $name);
+	}
+
+
+	/**
+	 * Gets open_by_default
+	 *
+	 * @return boolean
+	 */
+	public function open_by_default()
+	{
+		return $this->get('PMD_open_by_default');
+	}
+
+
+	/**
+	 * Sets open_by_default
+	 *
+	 * @param boolean $open_by_default
+	 */
+	public function set_open_by_default($open_by_default)
+	{
+		$this->set('PMD_open_by_default', $open_by_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('PMD_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->set('PMD_order', $order);
+	}
+
+
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('PMD_slug');
+	}
+
+
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('PMD_slug', $slug);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('PMD_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 */
+	public function set_type($type)
+	{
+		$this->set('PMD_type', $type);
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PMD_wp_user');
+	}
+
+
+	/**
+	 * Sets wp_user
+	 *
+	 * @param int $wp_user_id
+	 */
+	public function set_wp_user($wp_user_id)
+	{
+		$this->set('PMD_wp_user', $wp_user_id);
+	}
+
+	/**
+	 * Overrides parent so when PMD_type is changed we refresh the _type_obj
+	 *
+	 * @param string $field_name
+	 * @param mixed $field_value
+	 * @param boolean $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'PMD_type') {
+			// the type has probably changed, so forget about its old type object
+			$this->_type_obj = null;
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * Gets admin_name
+	 *
+	 * @return string
+	 */
+	public function admin_name()
+	{
+		return $this->get('PMD_admin_name');
+	}
+
+
+	/**
+	 * Sets admin_name
+	 *
+	 * @param string $admin_name
+	 */
+	public function set_admin_name($admin_name)
+	{
+		$this->set('PMD_admin_name', $admin_name);
+	}
+
+
+	/**
+	 * Gets admin_desc
+	 *
+	 * @return string
+	 */
+	public function admin_desc()
+	{
+		return $this->get('PMD_admin_desc');
+	}
+
+
+	/**
+	 * Sets admin_desc
+	 *
+	 * @param string $admin_desc
+	 */
+	public function set_admin_desc($admin_desc)
+	{
+		$this->set('PMD_admin_desc', $admin_desc);
+	}
+
+
+	/**
+	 * Gets scope
+	 *
+	 * @return array
+	 */
+	public function scope()
+	{
+		return $this->get('PMD_scope');
+	}
+
+
+	/**
+	 * Sets scope
+	 *
+	 * @param array $scope
+	 */
+	public function set_scope($scope)
+	{
+		$this->set('PMD_scope', $scope);
+	}
+
+
+	/**
+	 * Gets the payment method type for this payment method instance
+	 *
+	 * @return EE_PMT_Base
+	 * @throws EE_Error
+	 */
+	public function type_obj()
+	{
+		if (! $this->_type_obj) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($this->type())) {
+				$class_name = EE_Payment_Method_Manager::instance()->payment_method_class_from_type($this->type());
+				if (! class_exists($class_name)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An attempt to use the "%1$s" payment method failed, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated? It can be reactivated on the %3$sPlugins Admin Page%4$s',
+								'event_espresso'
+							),
+							$class_name,
+							'<br />',
+							'<a href="' . admin_url('plugins.php') . '">',
+							'</a>'
+						)
+					);
+				}
+				$r = new ReflectionClass($class_name);
+				$this->_type_obj = $r->newInstanceArgs(array($this));
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'A payment method of type "%1$s" does not exist. Only ones existing are: %2$s',
+							'event_espresso'
+						),
+						$this->type(),
+						implode(',', EE_Payment_Method_Manager::instance()->payment_method_type_names())
+					)
+				);
+			}
+		}
+		return $this->_type_obj;
+	}
+
+
+	/**
+	 * Returns a simple array of key-value pairs combining the payment method's fields (without the 'PMD_' prefix)
+	 * and the extra meta. Mostly used for passing off ot gateways.     *
+	 *
+	 * @return array
+	 */
+	public function settings_array()
+	{
+		$fields = $this->model_field_array();
+		$extra_meta = $this->all_extra_meta_array();
+		// remove the model's prefix from the fields
+		$combined_settings_array = array();
+		foreach ($fields as $key => $value) {
+			if (strpos($key, 'PMD_') === 0) {
+				$key_sans_model_prefix = str_replace('PMD_', '', $key);
+				$combined_settings_array [ $key_sans_model_prefix ] = $value;
+			}
+		}
+		$combined_settings_array = array_merge($extra_meta, $combined_settings_array);
+		return $combined_settings_array;
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the payment method on a page.
+	 *
+	 * @param string $url
+	 * @param string $css_class
+	 * @return string of HTML for displaying the button
+	 * @throws \EE_Error
+	 */
+	public function button_html($url = '', $css_class = '')
+	{
+		$payment_occurs = $this->type_obj()->payment_occurs();
+		return '
 		 <div id="'
-               . $this->slug()
-               . '-payment-option-dv" class="'
-               . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
+			   . $this->slug()
+			   . '-payment-option-dv" class="'
+			   . $payment_occurs . '-payment-gateway reg-page-payment-option-dv' . $css_class . '">
 			<a id="payment-gateway-button-' . $this->slug()
-               . '" class="reg-page-payment-option-lnk" rel="'
-               . $this->slug() . '" href="' . $url . '" >
+			   . '" class="reg-page-payment-option-lnk" rel="'
+			   . $this->slug() . '" href="' . $url . '" >
 				<img src="' . $this->button_url() . '" alt="' . sprintf(
-                   esc_attr__('Pay using %s', 'event_espresso'),
-                   $this->get_pretty('PMD_name', 'form_input')
-               ) . '" />
+				   esc_attr__('Pay using %s', 'event_espresso'),
+				   $this->get_pretty('PMD_name', 'form_input')
+			   ) . '" />
 			</a>
 		</div>
 ';
-    }
-
-
-    /**
-     * Gets all the currencies which are an option for this payment method
-     * (as defined by the gateway and the currently active currencies)
-     *
-     * @return EE_Currency[]
-     * @throws \EE_Error
-     */
-    public function get_all_usable_currencies()
-    {
-        return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
-    }
-
-
-    /**
-     * Reports whether or not this payment method can be used for this payment method
-     *
-     * @param string $currency_code currency ID (code)
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function usable_for_currency($currency_code)
-    {
-        foreach ($this->get_all_usable_currencies() as $currency_obj) {
-            if ($currency_obj->ID() === $currency_code) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_on_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_site()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
-    }
-
-
-    /**
-     * Returns TRUE if this payment method does not utilize a gateway
-     *
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_off_line()
-    {
-        return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
-    }
-
-    /**
-     * Overrides default __sleep so the object type is NOT cached.
-     * This way we can rely on the normal EE_Payment_Method::type_obj() logic
-     * to load the required classes, and don't need them at the time of unserialization
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_type_obj']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Overrides parent to add some logging for when payment methods get deactivated
-     *
-     * @param array $set_cols_n_values
-     * @return int @see EE_Base_Class::save()
-     * @throws \EE_Error
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $results = parent::save($set_cols_n_values);
-        if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
-            /** @var CurrentPage $current_page */
-            $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-            EE_Log::instance()->log(
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
-                    $this->name(),
-                    serialize($this->get_original('PMD_scope')),
-                    serialize($this->get('PMD_scope')),
-                    $current_page->getPermalink()
-                ),
-                'payment_method_change'
-            );
-        }
-        return $results;
-    }
+	}
+
+
+	/**
+	 * Gets all the currencies which are an option for this payment method
+	 * (as defined by the gateway and the currently active currencies)
+	 *
+	 * @return EE_Currency[]
+	 * @throws \EE_Error
+	 */
+	public function get_all_usable_currencies()
+	{
+		return EEM_Currency::instance()->get_all_currencies_usable_by($this->type_obj());
+	}
+
+
+	/**
+	 * Reports whether or not this payment method can be used for this payment method
+	 *
+	 * @param string $currency_code currency ID (code)
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function usable_for_currency($currency_code)
+	{
+		foreach ($this->get_all_usable_currencies() as $currency_obj) {
+			if ($currency_obj->ID() === $currency_code) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Onsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_on_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::onsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method's gateway is an instance of EE_Offsite_Gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_site()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offsite;
+	}
+
+
+	/**
+	 * Returns TRUE if this payment method does not utilize a gateway
+	 *
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_off_line()
+	{
+		return $this->type_obj()->payment_occurs() === EE_PMT_Base::offline;
+	}
+
+	/**
+	 * Overrides default __sleep so the object type is NOT cached.
+	 * This way we can rely on the normal EE_Payment_Method::type_obj() logic
+	 * to load the required classes, and don't need them at the time of unserialization
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_type_obj']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Overrides parent to add some logging for when payment methods get deactivated
+	 *
+	 * @param array $set_cols_n_values
+	 * @return int @see EE_Base_Class::save()
+	 * @throws \EE_Error
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$results = parent::save($set_cols_n_values);
+		if ($this->get_original('PMD_scope') !== $this->get('PMD_scope')) {
+			/** @var CurrentPage $current_page */
+			$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+			EE_Log::instance()->log(
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					esc_html__('Set new scope on payment method %1$s to %2$s from %3$s on URL %4$s', 'event_espresso'),
+					$this->name(),
+					serialize($this->get_original('PMD_scope')),
+					serialize($this->get('PMD_scope')),
+					$current_page->getPermalink()
+				),
+				'payment_method_change'
+			);
+		}
+		return $results;
+	}
 }

core/db_models/EEM_Message.model.php

Spacing +8 added lines, -8 removed lines

@@ -126,7 +126,7 @@ 
             self::priority_low    => esc_html__('low', 'event_espresso'),
         );
 
-        $this->_fields          = array(
+        $this->_fields = array(
             'Message' => array(
                 'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
                 'MSG_token'          => new EE_Plain_Text_Field(
@@ -436,7 +436,7 @@ 
                         );
                         break;
                     default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+                        $query_params[0]['AND**filter_by']['OR**filter_by_'.$request_key][$model_name.'.'.$request_key] = $request_value;
                         break;
                 }
             }
@@ -499,8 +499,8 @@ 
         if ($label_parts) {
             // prepend to the last element of $label_parts an "and".
             if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+                $label_parts_index_to_prepend = count($label_parts) - 1;
+                $label_parts[$label_parts_index_to_prepend] = 'and'.$label_parts[$label_parts_index_to_prepend];
             }
 
             $pretty_label .= sprintf(
@@ -560,7 +560,7 @@ 
             $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
         }
 
-        if (! is_null($set_debug)) {
+        if ( ! is_null($set_debug)) {
             $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
         }
 
@@ -627,13 +627,13 @@ 
             )
         );
 
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+        if ( ! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
             global $wpdb;
             $number_deleted = $wpdb->query('
                 DELETE
-                FROM ' . $this->table() . '
+                FROM ' . $this->table().'
                 WHERE
-                    MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
+                    MSG_ID IN (' . implode(",", $message_ids_to_delete).')
             ');
         }
 

Indentation +640 added lines, -640 removed lines

@@ -13,649 +13,649 @@
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
 
-    // private instance of the Message object
-    protected static $_instance = null;
-
-
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Message', 'event_espresso');
-        $this->plural_item   = esc_html__('Messages', 'event_espresso');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => esc_html__('high', 'event_espresso'),
-            self::priority_medium => esc_html__('medium', 'event_espresso'),
-            self::priority_low    => esc_html__('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    esc_html__(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    esc_html__(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    esc_html__('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    esc_html__('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    esc_html__('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    esc_html__('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    esc_html__('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    esc_html__('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    esc_html__('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    esc_html__('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    esc_html__('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return EE_Message
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     * @throws EE_Error
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = $request->getRequestParam($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_pretty_label_for_results()
-    {
-        /** @var RequestInterface $request */
-        $request = EEM_Base::$loader->getShared(RequestInterface::class);
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
-            $model = EEM_Base::$loader->getShared($model_name);
-            $model_field_value = $request->getRequestParam($request_key);
-            if ($model instanceof EEM_Base && $model_field_value !== '') {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
-     *                              months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                              $wpdb->last_error to find out what the error was.
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	// private instance of the Message object
+	protected static $_instance = null;
+
+
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Message', 'event_espresso');
+		$this->plural_item   = esc_html__('Messages', 'event_espresso');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => esc_html__('high', 'event_espresso'),
+			self::priority_medium => esc_html__('medium', 'event_espresso'),
+			self::priority_low    => esc_html__('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', esc_html__('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					esc_html__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					esc_html__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					esc_html__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', esc_html__('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					esc_html__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					esc_html__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					esc_html__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					esc_html__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					esc_html__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					esc_html__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					esc_html__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					esc_html__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					esc_html__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return EE_Message
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 * @throws EE_Error
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = $request->getRequestParam($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_pretty_label_for_results()
+	{
+		/** @var RequestInterface $request */
+		$request = EEM_Base::$loader->getShared(RequestInterface::class);
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model_name = strpos($model_name, 'EEM_', true) === 0 ? $model_name : "EEM_{$model_name}";
+			$model = EEM_Base::$loader->getShared($model_name);
+			$model_field_value = $request->getRequestParam($request_key);
+			if ($model instanceof EEM_Base && $model_field_value !== '') {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold This integer will be used to set the boundary for what messages are deleted in
+	 *                              months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                              $wpdb->last_error to find out what the error was.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }

core/db_models/fields/EE_WP_Post_Type_Field.php.php

Indentation +8 added lines, -8 removed lines

@@ -5,12 +5,12 @@
  */
 class EE_WP_Post_Type_Field extends EE_DB_Only_Text_Field
 {
-    /**
-     * @param string $post_type the exact string to be used for the post type
-     *                          of all these post type model objects/rows
-     */
-    public function __construct($post_type)
-    {
-        parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
-    }
+	/**
+	 * @param string $post_type the exact string to be used for the post type
+	 *                          of all these post type model objects/rows
+	 */
+	public function __construct($post_type)
+	{
+		parent::__construct('post_type', esc_html__("Post Type", 'event_espresso'), false, $post_type);
+	}
 }

core/db_models/fields/EE_Full_HTML_Field.php

Indentation +48 added lines, -48 removed lines

@@ -14,57 +14,57 @@
 class EE_Full_HTML_Field extends EE_Text_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
-     *
-     * @param type $value_on_field_to_be_outputted
-     * @param type $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema == 'form_input') {
-            return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-        } elseif ($schema == 'no_wpautop') {
-            return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
-        } else {
-            return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
-        }
-    }
+	/**
+	 * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
+	 *
+	 * @param type $value_on_field_to_be_outputted
+	 * @param type $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema == 'form_input') {
+			return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+		} elseif ($schema == 'no_wpautop') {
+			return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
+		} else {
+			return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
+		}
+	}
 
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            ),
-            'rendered' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - transformed for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'readonly' => true
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			),
+			'rendered' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - transformed for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'readonly' => true
+			)
+		);
+	}
 }

core/db_models/fields/EE_Infinite_Integer_Field.php

Indentation +69 added lines, -69 removed lines

@@ -10,78 +10,78 @@
 class EE_Infinite_Integer_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(array('integer', 'null'));
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(array('integer', 'null'));
+	}
 
 
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        if ($value_of_field_on_model_object === EE_INF) {
-            return EE_INF_IN_DB;
-        } else {
-            return intval($value_of_field_on_model_object);
-        }
-    }
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		if ($value_of_field_on_model_object === EE_INF) {
+			return EE_INF_IN_DB;
+		} else {
+			return intval($value_of_field_on_model_object);
+		}
+	}
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if (
-            $value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
-            $value_inputted_for_field_on_model_object === EE_INF ||
-            $value_inputted_for_field_on_model_object === "EE_INF" ||
-            $value_inputted_for_field_on_model_object === ""
-        ) {
-            return EE_INF;
-        } else {
-            return intval($value_inputted_for_field_on_model_object);
-        }
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if (
+			$value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
+			$value_inputted_for_field_on_model_object === EE_INF ||
+			$value_inputted_for_field_on_model_object === "EE_INF" ||
+			$value_inputted_for_field_on_model_object === ""
+		) {
+			return EE_INF;
+		} else {
+			return intval($value_inputted_for_field_on_model_object);
+		}
+	}
 
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        $intval = intval($value_inputted_for_field_on_model_object);
-        if ($intval == EE_INF_IN_DB) {
-            return EE_INF;
-        } else {
-            return $intval;
-        }
-    }
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		$intval = intval($value_inputted_for_field_on_model_object);
+		if ($intval == EE_INF_IN_DB) {
+			return EE_INF;
+		} else {
+			return $intval;
+		}
+	}
 
-    /**
-     * For outputting this field's value. If you want to output it into an input or something,
-     * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
-     * as it will replace EE_INF with i18n Infinite
-     *
-     * @param type   $value_on_field_to_be_outputted
-     * @param string $schema input, symbol, text; or any string you want to show if the value equals EE_INF
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($value_on_field_to_be_outputted === EE_INF) {
-            switch ($schema) {
-                case 'input':
-                case 'form_input':
-                    return '';
-                case 'symbol':
-                    return "∞";
-                case 'text':
-                case null:
-                    return esc_html__("Unlimited", "event_espresso");
-                default:
-                    return $schema;
-            }
-        } else {
-            return $value_on_field_to_be_outputted;
-        }
-    }
+	/**
+	 * For outputting this field's value. If you want to output it into an input or something,
+	 * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
+	 * as it will replace EE_INF with i18n Infinite
+	 *
+	 * @param type   $value_on_field_to_be_outputted
+	 * @param string $schema input, symbol, text; or any string you want to show if the value equals EE_INF
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($value_on_field_to_be_outputted === EE_INF) {
+			switch ($schema) {
+				case 'input':
+				case 'form_input':
+					return '';
+				case 'symbol':
+					return "∞";
+				case 'text':
+				case null:
+					return esc_html__("Unlimited", "event_espresso");
+				default:
+					return $schema;
+			}
+		} else {
+			return $value_on_field_to_be_outputted;
+		}
+	}
 }

core/db_models/fields/EE_Money_Field.php

Indentation +78 added lines, -78 removed lines

@@ -7,92 +7,92 @@
 class EE_Money_Field extends EE_Float_Field
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * Schemas:
-     *    'localized_float': "3,023.00"
-     *    'no_currency_code': "$3,023.00"
-     *    null: "$3,023.00<span>USD</span>"
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	/**
+	 * Schemas:
+	 *    'localized_float': "3,023.00"
+	 *    'no_currency_code': "$3,023.00"
+	 *    null: "$3,023.00<span>USD</span>"
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
 
-        if ($schema == 'localized_float') {
-            return $pretty_float;
-        }
-        if ($schema == 'no_currency_code') {
+		if ($schema == 'localized_float') {
+			return $pretty_float;
+		}
+		if ($schema == 'no_currency_code') {
 //          echo "schema no currency!";
-            $display_code = false;
-        } else {
-            $display_code = true;
-        }
-        // we don't use the $pretty_float because format_currency will take care of it.
-        return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
-    }
+			$display_code = false;
+		} else {
+			$display_code = true;
+		}
+		// we don't use the $pretty_float because format_currency will take care of it.
+		return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
+	}
 
-    /**
-     * If provided with a string, strips out money-related formatting to turn it into a proper float.
-     * Rounds the float to the correct number of decimal places for this country's currency.
-     * Also, interprets periods and commas according to the country's currency settings.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        // remove any currencies etc.
+	/**
+	 * If provided with a string, strips out money-related formatting to turn it into a proper float.
+	 * Rounds the float to the correct number of decimal places for this country's currency.
+	 * Also, interprets periods and commas according to the country's currency settings.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		// remove any currencies etc.
 //      if(is_string($value_inputted_for_field_on_model_object)){
 //          $value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "", $value_inputted_for_field_on_model_object);
 //      }
-        // now it's a float-style string or number
-        $float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        // round to the correctly number of decimal places for this  currency
-        $rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
-        return $rounded_value;
-    }
+		// now it's a float-style string or number
+		$float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		// round to the correctly number of decimal places for this  currency
+		$rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
+		return $rounded_value;
+	}
 
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        $c = EE_Registry::instance()->CFG->currency;
-        return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
-    }
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		$c = EE_Registry::instance()->CFG->currency;
+		return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
+	}
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'number',
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    esc_html__('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'format' => 'money'
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'number',
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					esc_html__('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'format' => 'money'
+			)
+		);
+	}
 }

core/domain/services/admin/events/data/ConfirmDeletion.php

Indentation +76 added lines, -76 removed lines

@@ -30,86 +30,86 @@
  */
 class ConfirmDeletion
 {
-    /**
-     * @var NodeGroupDao
-     */
-    private $dao;
+	/**
+	 * @var NodeGroupDao
+	 */
+	private $dao;
 
-    /**
-     * ConfirmDeletion constructor.
-     * @param NodeGroupDao $dao
-     */
-    public function __construct(
-        NodeGroupDao $dao
-    ) {
+	/**
+	 * ConfirmDeletion constructor.
+	 * @param NodeGroupDao $dao
+	 */
+	public function __construct(
+		NodeGroupDao $dao
+	) {
 
-        $this->dao = $dao;
-    }
+		$this->dao = $dao;
+	}
 
-    /**
-     * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
-     * preview page.
-     * @since 4.10.12.p
-     * @param $request_data
-     * @param $admin_base_url
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    public function handle($request_data, $admin_base_url)
-    {
-        $deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
-        $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
-        $form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
-        // Initialize the form from the request, and check if its valid.
-        $form->receive_form_submission($request_data);
-        if ($form->is_valid()) {
-            // Redirect the user to the deletion batch job.
-            EEH_URL::safeRedirectAndExit(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_batch',
-                        'batch' => EED_Batch::batch_job,
-                        'deletion_job_code' => $deletion_job_code,
-                        'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
-                        'return_url' => urlencode(
-                            add_query_arg(
-                                [
-                                    'status' => 'trash'
-                                ],
-                                EVENTS_ADMIN_URL
-                            )
-                        )
-                    ),
-                    admin_url()
-                )
-            );
-        }
-        // Dont' use $form->submission_error_message() because it adds the form input's label in front
-        // of each validation error which ends up looking quite confusing.
-        $validation_errors = $form->get_validation_errors_accumulated();
-        foreach ($validation_errors as $validation_error) {
-            EE_Error::add_error(
-                $validation_error->getMessage(),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
+	/**
+	 * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
+	 * preview page.
+	 * @since 4.10.12.p
+	 * @param $request_data
+	 * @param $admin_base_url
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	public function handle($request_data, $admin_base_url)
+	{
+		$deletion_job_code = isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
+		$models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
+		$form = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
+		// Initialize the form from the request, and check if its valid.
+		$form->receive_form_submission($request_data);
+		if ($form->is_valid()) {
+			// Redirect the user to the deletion batch job.
+			EEH_URL::safeRedirectAndExit(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_batch',
+						'batch' => EED_Batch::batch_job,
+						'deletion_job_code' => $deletion_job_code,
+						'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\ExecuteBatchDeletion'),
+						'return_url' => urlencode(
+							add_query_arg(
+								[
+									'status' => 'trash'
+								],
+								EVENTS_ADMIN_URL
+							)
+						)
+					),
+					admin_url()
+				)
+			);
+		}
+		// Dont' use $form->submission_error_message() because it adds the form input's label in front
+		// of each validation error which ends up looking quite confusing.
+		$validation_errors = $form->get_validation_errors_accumulated();
+		foreach ($validation_errors as $validation_error) {
+			EE_Error::add_error(
+				$validation_error->getMessage(),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
 
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action' => 'preview_deletion',
-                    'deletion_job_code' => $deletion_job_code
-                ],
-                $admin_base_url
-            )
-        );
-    }
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action' => 'preview_deletion',
+					'deletion_job_code' => $deletion_job_code
+				],
+				$admin_base_url
+			)
+		);
+	}
 }
 // End of file ConfirmDeletion.php
 // Location: EventEspresso\core\domain\services\admin\events\data/ConfirmDeletion.php

core/db_models/helpers/EE_Table_Base.php

Indentation +147 added lines, -147 removed lines

@@ -7,151 +7,151 @@
 abstract class EE_Table_Base
 {
 
-    /**
-     * This holds the table_name without the table prefix.
-     *
-     * @var string
-     */
-    public $_table_name;
-
-
-    /**
-     * This holds what is used as the alias for the table in queries.
-     *
-     * @var string
-     */
-    public $_table_alias;
-
-
-    /**
-     * Table's private key column
-     *
-     * @var string
-     */
-    protected $_pk_column;
-
-
-    /**
-     * Whether this table is a global table (in multisite) or specific to site.
-     *
-     * @var bool
-     */
-    protected $_global;
-
-
-    /**
-     * @param string  $table_name with or without wpdb prefix
-     * @param string  $pk_column
-     * @param boolean $global     whether the table is "global" as in there is only 1 table on an entire multisite
-     *                            install, or whether each site on a multisite install has a copy of this table
-     * @global wpdb   $wpdb
-     */
-    public function __construct($table_name, $pk_column, $global = false)
-    {
-        $this->_global = $global;
-        $prefix        = $this->get_table_prefix();
-        // if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
-        if (strpos($table_name, $prefix) === 0) {
-            $table_name = substr_replace($table_name, '', 0, strlen($prefix));
-        }
-        $this->_table_name = $table_name;
-        $this->_pk_column  = $pk_column;
-    }
-
-
-    /**
-     * This returns the table prefix for the current model state.
-     *
-     * @return string
-     * @global wpdb $wpdb
-     */
-    public function get_table_prefix()
-    {
-        global $wpdb;
-        if ($this->_global) {
-            return $wpdb->base_prefix;
-        }
-        return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
-    }
-
-
-    /**
-     * Used to set the table_alias property
-     *
-     * @param string $table_alias
-     */
-    public function _construct_finalize_with_alias($table_alias)
-    {
-        $this->_table_alias = $table_alias;
-    }
-
-
-    /**
-     * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
-     *
-     * @return string
-     */
-    public function get_table_name()
-    {
-        return $this->get_table_prefix() . $this->_table_name;
-    }
-
-
-    /**
-     * Provides what is currently set as the alias for the table to be used in queries.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_table_alias()
-    {
-        if (! $this->_table_alias) {
-            throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
-        }
-        return $this->_table_alias;
-    }
-
-
-    /**
-     * @return string name of column of PK
-     */
-    public function get_pk_column()
-    {
-        return $this->_pk_column;
-    }
-
-
-    /**
-     * returns a string with the table alias, a period, and the private key's column.
-     *
-     * @return string
-     */
-    public function get_fully_qualified_pk_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
-    }
-
-
-    /**
-     * returns the special sql for a inner select with a limit.
-     *
-     * @return string    SQL select
-     */
-    public function get_select_join_limit($limit)
-    {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
-    }
-
-
-    /**
-     * Returns whether or not htis is a global table (ie, on multisite there's
-     * only one of these tables, on the main blog)
-     *
-     * @return boolean
-     */
-    public function is_global()
-    {
-        return $this->_global;
-    }
+	/**
+	 * This holds the table_name without the table prefix.
+	 *
+	 * @var string
+	 */
+	public $_table_name;
+
+
+	/**
+	 * This holds what is used as the alias for the table in queries.
+	 *
+	 * @var string
+	 */
+	public $_table_alias;
+
+
+	/**
+	 * Table's private key column
+	 *
+	 * @var string
+	 */
+	protected $_pk_column;
+
+
+	/**
+	 * Whether this table is a global table (in multisite) or specific to site.
+	 *
+	 * @var bool
+	 */
+	protected $_global;
+
+
+	/**
+	 * @param string  $table_name with or without wpdb prefix
+	 * @param string  $pk_column
+	 * @param boolean $global     whether the table is "global" as in there is only 1 table on an entire multisite
+	 *                            install, or whether each site on a multisite install has a copy of this table
+	 * @global wpdb   $wpdb
+	 */
+	public function __construct($table_name, $pk_column, $global = false)
+	{
+		$this->_global = $global;
+		$prefix        = $this->get_table_prefix();
+		// if they added the prefix, let's remove it because we delay adding the prefix until right when its needed.
+		if (strpos($table_name, $prefix) === 0) {
+			$table_name = substr_replace($table_name, '', 0, strlen($prefix));
+		}
+		$this->_table_name = $table_name;
+		$this->_pk_column  = $pk_column;
+	}
+
+
+	/**
+	 * This returns the table prefix for the current model state.
+	 *
+	 * @return string
+	 * @global wpdb $wpdb
+	 */
+	public function get_table_prefix()
+	{
+		global $wpdb;
+		if ($this->_global) {
+			return $wpdb->base_prefix;
+		}
+		return $wpdb->get_blog_prefix(EEM_Base::get_model_query_blog_id());
+	}
+
+
+	/**
+	 * Used to set the table_alias property
+	 *
+	 * @param string $table_alias
+	 */
+	public function _construct_finalize_with_alias($table_alias)
+	{
+		$this->_table_alias = $table_alias;
+	}
+
+
+	/**
+	 * Returns the fully qualified table name for the database (includes the table prefix current for the blog).
+	 *
+	 * @return string
+	 */
+	public function get_table_name()
+	{
+		return $this->get_table_prefix() . $this->_table_name;
+	}
+
+
+	/**
+	 * Provides what is currently set as the alias for the table to be used in queries.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_table_alias()
+	{
+		if (! $this->_table_alias) {
+			throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
+		}
+		return $this->_table_alias;
+	}
+
+
+	/**
+	 * @return string name of column of PK
+	 */
+	public function get_pk_column()
+	{
+		return $this->_pk_column;
+	}
+
+
+	/**
+	 * returns a string with the table alias, a period, and the private key's column.
+	 *
+	 * @return string
+	 */
+	public function get_fully_qualified_pk_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_pk_column();
+	}
+
+
+	/**
+	 * returns the special sql for a inner select with a limit.
+	 *
+	 * @return string    SQL select
+	 */
+	public function get_select_join_limit($limit)
+	{
+		$limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
+		return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+	}
+
+
+	/**
+	 * Returns whether or not htis is a global table (ie, on multisite there's
+	 * only one of these tables, on the main blog)
+	 *
+	 * @return boolean
+	 */
+	public function is_global()
+	{
+		return $this->_global;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -93,7 +93,7 @@ 
      */
     public function get_table_name()
     {
-        return $this->get_table_prefix() . $this->_table_name;
+        return $this->get_table_prefix().$this->_table_name;
     }
 
 
@@ -105,7 +105,7 @@ 
      */
     public function get_table_alias()
     {
-        if (! $this->_table_alias) {
+        if ( ! $this->_table_alias) {
             throw new EE_Error("You must call _construct_finalize_with_alias before using the EE_Table_Base. Did you forget to call parent::__construct at the end of your EEMerimental_Base child's __construct?");
         }
         return $this->_table_alias;
@@ -128,7 +128,7 @@ 
      */
     public function get_fully_qualified_pk_column()
     {
-        return $this->get_table_alias() . "." . $this->get_pk_column();
+        return $this->get_table_alias().".".$this->get_pk_column();
     }
 
 
@@ -139,8 +139,8 @@ 
      */
     public function get_select_join_limit($limit)
     {
-        $limit = is_array($limit) ? 'LIMIT ' . implode(',', array_map('intval', $limit)) : 'LIMIT ' . (int) $limit;
-        return SP . '(SELECT * FROM ' . $this->_table_name . SP . $limit . ') AS ' . $this->_table_alias;
+        $limit = is_array($limit) ? 'LIMIT '.implode(',', array_map('intval', $limit)) : 'LIMIT '.(int) $limit;
+        return SP.'(SELECT * FROM '.$this->_table_name.SP.$limit.') AS '.$this->_table_alias;
     }