eventespresso / event-espresso-core

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -1072,7 +1072,7 @@ 
      * Sets deleted
      *
      * @param boolean $deleted
-     * @return boolean
+     * @return boolean|null
      */
     public function set_deleted($deleted)
     {
@@ -1125,6 +1125,7 @@ 
      * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
      * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
      *                                          consider registration status as well as datetime access.
+     * @param integer $DTT_OR_ID
      * @return bool
      */
     public function can_checkin($DTT_OR_ID, $check_approved = true)
@@ -1278,7 +1279,7 @@ 
      * Returns the latest datetime related to this registration (via the ticket attached to the registration).
      * "Latest" is defined by the `DTT_EVT_start` column.
      *
-     * @return EE_Datetime|null
+     * @return null|EE_Base_Class
      * @throws \EE_Error
      */
     public function get_latest_related_datetime()
@@ -1557,7 +1558,7 @@ 
      * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
      * Note: if there are no payments on the registration there will be no payment method returned.
      *
-     * @return EE_Payment_Method|null
+     * @return null|EE_Base_Class
      */
     public function payment_method()
     {

Indentation +1686 added lines, -1686 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -15,1691 +15,1691 @@ 
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @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_Registration
-     */
-    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_Registration
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param        int $EVT_ID Event ID
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code' :
-                if (! empty($field_value) && $this->reg_code() === null) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID' :
-                $this->set_status($field_value, $use_default);
-                break;
-            default :
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string  $new_STS_ID
-     * @param boolean $use_default
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function set_status($new_STS_ID = null, $use_default = false)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if (
-            $old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->_reserve_registration_space();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
-                // OR FROM  approved
-            } else if ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->_release_registration_space();
-                do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-            $this->transaction()->update_status_based_on_total_paid(true);
-            do_action('AHEE__EE_Registration__set_status__after_update', $this);
-            return true;
-        } else {
-            //even though the old value matches the new value, it's still good to
-            //allow the parent set method to have a say
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            return true;
-        }
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string $new_STS_ID
-     * @param string $old_STS_ID
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
-            return;
-        }
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
-        }
-    }
-
-
-    /**
-     *        get Status ID
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _reserve_registration_space()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket();
-        $ticket = $this->ticket();
-        $ticket->increase_sold();
-        $ticket->save();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = array();
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event()
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @since 4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        $event = $this->event();
-        if ($event instanceof EE_Event) {
-            return $event->wp_user();
-        }
-        return 0;
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _release_registration_space()
-    {
-        $ticket = $this->ticket();
-        $ticket->decrease_sold();
-        $ticket->save();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function reserve_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param        int $ATT_ID Attendee ID
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param        int $REG_count Primary Attendee
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                       Date
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @access    public
-     * @param    float $REG_paid
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param        boolean $REG_att_is_going Attendee Is Going
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function receipt_url($messenger = 'html')
-    {
-
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
-        }
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            if ($messenger == 'html') {
-                return $this->invoice_url('launch');
-            }
-            $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
-
-            $query_args = array('ee' => $route, 'id' => $this->reg_url_link());
-            if ($messenger == 'html') {
-                $query_args['html'] = true;
-            }
-            return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
-        }
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @access public
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_url_link()
-    {
-        return (string)$this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo $this->invoice_url($type);
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo $this->payment_overview_url();
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function payment_overview_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'attendee_information',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(array(
-            'page'    => 'espresso_registrations',
-            'action'  => 'view_registration',
-            '_REG_ID' => $this->ID(),
-        ), admin_url('admin.php'));
-    }
-
-
-    /**
-     *    is_primary_registrant?
-     */
-    public function is_primary_registrant()
-    {
-        return $this->get('REG_count') == 1 ? true : false;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        $primary_registrant = EEM_Registration::instance()->get_one(array(
-            array(
-                'TXN_ID'    => $this->transaction_ID(),
-                'REG_count' => 1,
-            ),
-        ));
-        return $primary_registrant;
-    }
-
-
-    /**
-     *        get  Attendee Number
-     *
-     * @access        public
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     *        get Group Size
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     *        get Registration Date
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return    float
-     */
-    public function final_price()
-    {
-        return $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return    float
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return    float
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment
-     * @return bool
-     */
-    public function owes_monies_and_can_pay($requires_payment = array())
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
-        if (
-            in_array($this->status_ID(), $requires_payment) &&
-            $this->final_price() != 0 &&
-            $this->final_price() != $this->paid()
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
-            false, 'sentence');
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Answer[]
-     */
-    public function answers($query_params = null)
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        $question_groups = array();
-        if ($this->event() instanceof EE_Event) {
-            $question_groups = $this->event()->question_groups(
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC'),
-                )
-            );
-        }
-        return $question_groups;
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     */
-    public function count_question_groups()
-    {
-        $qg_count = 0;
-        if ($this->event() instanceof EE_Event) {
-            $qg_count = $this->event()->count_related(
-                'Question_Group',
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                )
-            );
-        }
-        return $qg_count;
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Datetime_Ticket
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Datetime_Ticket
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return boolean
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        //first check registration status
-        if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
-            return false;
-        }
-        //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
-            array(
-                'TKT_ID' => $this->get('TKT_ID'),
-                'DTT_ID' => $DTT_ID,
-            ),
-        )))
-        ) {
-            return false;
-        }
-
-        //final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool   true means can checkin.  false means cannot checkin.
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
-        // or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        //does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        //go ahead and toggle.
-        if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
-            return true;
-        }
-
-        //made it here so the last check is whether the number of checkins per unique datetime on this registration
-        //disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
-            array(
-                'REG_ID' => $this->ID(),
-                'CHK_in' => true,
-            ),
-        ), 'DTT_ID', true);
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        $status_paths = array(
-            EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
-            EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
-            EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
-        );
-        //start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
-        $status_to  = $status_paths[$cur_status];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(array(
-            'REG_ID' => $this->ID(),
-            'DTT_ID' => $DTT_ID,
-            'CHK_in' => $new_status,
-        ));
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    __('Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = __('Registration check in update failed because of an unknown database error',
-                    'event_espresso');
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
-    public function get_latest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int       $DTT_ID  The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
-    public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
-    {
-        $checkin_query_params = array(
-            'order_by' => array('CHK_timestamp' => 'DESC'),
-        );
-
-        if ($DTT_ID > 0) {
-            $checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
-        }
-
-        //get checkin object (if exists)
-        $checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related('Checkin', $checkin_query_params);
-        if ($checkin instanceof EE_Checkin) {
-            if ($checkin->get('CHK_in')) {
-                return EE_Registration::checkin_status_in; //checked in
-            }
-            return EE_Registration::checkin_status_out; //had checked in but is now checked out.
-        }
-        return EE_Registration::checkin_status_never; //never been checked in
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                     then it is assumed Check-in for primary datetime was toggled.
-     * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
-     *                     message can be customized with the attendee name.
-     * @return string         internationalized message
-     */
-    public function get_checkin_msg($DTT_ID, $error = false)
-    {
-        //let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            //what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Registration::checkin_status_never :
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_in :
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_out :
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return __("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *        get Registration Code
-     */
-    public function reg_code()
-    {
-        return $this->get('REG_code');
-    }
-
-
-    /**
-     *        get Transaction ID
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                __('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @since 4.5.0
-     * @return EE_Registration[]  or empty array if this isn't a group registration.
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return array();
-        }
-
-        $query[0] = array(
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => array('!=', $this->ID()),
-            'TKT_ID' => $this->ticket_ID(),
-        );
-
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page' => 'espresso_registrations',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration[]
-     * @throws \EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        return $this->final_price();
-    }
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.7.0
-     * @return string
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'), '4.7.0');
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @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_Registration
+	 */
+	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_Registration
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param        int $EVT_ID Event ID
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code' :
+				if (! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID' :
+				$this->set_status($field_value, $use_default);
+				break;
+			default :
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string  $new_STS_ID
+	 * @param boolean $use_default
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if (
+			$old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->_reserve_registration_space();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
+				// OR FROM  approved
+			} else if ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->_release_registration_space();
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+			$this->transaction()->update_status_based_on_total_paid(true);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this);
+			return true;
+		} else {
+			//even though the old value matches the new value, it's still good to
+			//allow the parent set method to have a say
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			return true;
+		}
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string $new_STS_ID
+	 * @param string $old_STS_ID
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
+			return;
+		}
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
+		}
+	}
+
+
+	/**
+	 *        get Status ID
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _reserve_registration_space()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
+		$ticket = $this->ticket();
+		$ticket->increase_sold();
+		$ticket->save();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = array();
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event()
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof \EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		$event = $this->event();
+		if ($event instanceof EE_Event) {
+			return $event->wp_user();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _release_registration_space()
+	{
+		$ticket = $this->ticket();
+		$ticket->decrease_sold();
+		$ticket->save();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function reserve_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param        int $ATT_ID Attendee ID
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param        int $REG_count Primary Attendee
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                       Date
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @access    public
+	 * @param    float $REG_paid
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param        boolean $REG_att_is_going Attendee Is Going
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
+		}
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
+			}
+			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
+
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
+				$query_args['html'] = true;
+			}
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
+		}
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @access public
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_url_link()
+	{
+		return (string)$this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo $this->invoice_url($type);
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo $this->payment_overview_url();
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function payment_overview_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'attendee_information',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(array(
+			'page'    => 'espresso_registrations',
+			'action'  => 'view_registration',
+			'_REG_ID' => $this->ID(),
+		), admin_url('admin.php'));
+	}
+
+
+	/**
+	 *    is_primary_registrant?
+	 */
+	public function is_primary_registrant()
+	{
+		return $this->get('REG_count') == 1 ? true : false;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		$primary_registrant = EEM_Registration::instance()->get_one(array(
+			array(
+				'TXN_ID'    => $this->transaction_ID(),
+				'REG_count' => 1,
+			),
+		));
+		return $primary_registrant;
+	}
+
+
+	/**
+	 *        get  Attendee Number
+	 *
+	 * @access        public
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 *        get Group Size
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 *        get Registration Date
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return    float
+	 */
+	public function final_price()
+	{
+		return $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return    float
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return    float
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment
+	 * @return bool
+	 */
+	public function owes_monies_and_can_pay($requires_payment = array())
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		if (
+			in_array($this->status_ID(), $requires_payment) &&
+			$this->final_price() != 0 &&
+			$this->final_price() != $this->paid()
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
+			false, 'sentence');
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Answer[]
+	 */
+	public function answers($query_params = null)
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		$question_groups = array();
+		if ($this->event() instanceof EE_Event) {
+			$question_groups = $this->event()->question_groups(
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+					'order_by' => array('QSG_order' => 'ASC'),
+				)
+			);
+		}
+		return $question_groups;
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 */
+	public function count_question_groups()
+	{
+		$qg_count = 0;
+		if ($this->event() instanceof EE_Event) {
+			$qg_count = $this->event()->count_related(
+				'Question_Group',
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+				)
+			);
+		}
+		return $qg_count;
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Datetime_Ticket
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Datetime_Ticket
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return boolean
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		//first check registration status
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
+			return false;
+		}
+		//is there a datetime ticket that matches this dtt_ID?
+		if (! (EEM_Datetime_Ticket::instance()->exists(array(
+			array(
+				'TKT_ID' => $this->get('TKT_ID'),
+				'DTT_ID' => $DTT_ID,
+			),
+		)))
+		) {
+			return false;
+		}
+
+		//final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool   true means can checkin.  false means cannot checkin.
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
+		// or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		//go ahead and toggle.
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
+			return true;
+		}
+
+		//made it here so the last check is whether the number of checkins per unique datetime on this registration
+		//disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
+			array(
+				'REG_ID' => $this->ID(),
+				'CHK_in' => true,
+			),
+		), 'DTT_ID', true);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		$status_paths = array(
+			EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
+			EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
+			EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
+		);
+		//start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
+		$status_to  = $status_paths[$cur_status];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(array(
+			'REG_ID' => $this->ID(),
+			'DTT_ID' => $DTT_ID,
+			'CHK_in' => $new_status,
+		));
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					__('Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = __('Registration check in update failed because of an unknown database error',
+					'event_espresso');
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
+	public function get_latest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int       $DTT_ID  The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
+	{
+		$checkin_query_params = array(
+			'order_by' => array('CHK_timestamp' => 'DESC'),
+		);
+
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
+		}
+
+		//get checkin object (if exists)
+		$checkin = $checkin instanceof EE_Checkin
+			? $checkin
+			: $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
+				return EE_Registration::checkin_status_in; //checked in
+			}
+			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
+		}
+		return EE_Registration::checkin_status_never; //never been checked in
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                     then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                     message can be customized with the attendee name.
+	 * @return string         internationalized message
+	 */
+	public function get_checkin_msg($DTT_ID, $error = false)
+	{
+		//let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			//what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Registration::checkin_status_never :
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_in :
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_out :
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return __("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *        get Registration Code
+	 */
+	public function reg_code()
+	{
+		return $this->get('REG_code');
+	}
+
+
+	/**
+	 *        get Transaction ID
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @since 4.5.0
+	 * @return EE_Registration[]  or empty array if this isn't a group registration.
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return array();
+		}
+
+		$query[0] = array(
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => array('!=', $this->ID()),
+			'TKT_ID' => $this->ticket_ID(),
+		);
+
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page' => 'espresso_registrations',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration[]
+	 * @throws \EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.7.0
+	 * @return string
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'), '4.7.0');
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 }

Spacing +13 added lines, -13 removed lines

@@ -1,6 +1,6 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -106,7 +106,7 @@ 
     {
         switch ($field_name) {
             case 'REG_code' :
-                if (! empty($field_value) && $this->reg_code() === null) {
+                if ( ! empty($field_value) && $this->reg_code() === null) {
                     $this->set_reg_code($field_value, $use_default);
                 }
                 break;
@@ -281,7 +281,7 @@ 
     public function event()
     {
         $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new EntityNotFoundException('Event ID', $this->event_ID());
         }
         return $event;
@@ -673,7 +673,7 @@ 
      */
     public function reg_url_link()
     {
-        return (string)$this->get('REG_url_link');
+        return (string) $this->get('REG_url_link');
     }
 
 
@@ -934,7 +934,7 @@ 
                 $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
                 break;
         }
-        return $icon . $status[$this->status_ID()];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1136,7 +1136,7 @@ 
             return false;
         }
         //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
+        if ( ! (EEM_Datetime_Ticket::instance()->exists(array(
             array(
                 'TKT_ID' => $this->get('TKT_ID'),
                 'DTT_ID' => $DTT_ID,
@@ -1164,7 +1164,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1172,7 +1172,7 @@ 
 
         // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
         // or not.
-        if (! $max_uses || $max_uses === EE_INF) {
+        if ( ! $max_uses || $max_uses === EE_INF) {
             return true;
         }
 
@@ -1221,7 +1221,7 @@ 
             $datetime = $this->get_latest_related_datetime();
             $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
             // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
+        } elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
             EE_Error::add_error(
                 sprintf(
                     __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
@@ -1393,7 +1393,7 @@ 
     public function transaction()
     {
         $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
+        if ( ! $transaction instanceof \EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
         }
         return $transaction;
@@ -1440,11 +1440,11 @@ 
             EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
             return;
         }
-        if (! $this->reg_code()) {
+        if ( ! $this->reg_code()) {
             parent::set('REG_code', $REG_code, $use_default);
         } else {
             EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
+                __CLASS__.'::'.__FUNCTION__,
                 __('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -1590,7 +1590,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

core/libraries/form_sections/strategies/layout/EE_Form_Section_Layout_Base.strategy.php

Indentation +244 added lines, -244 removed lines

@@ -14,248 +14,248 @@
 abstract class EE_Form_Section_Layout_Base
 {
 
-    /**
-     * Form form section to lay out
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_form_section;
-
-
-
-    /**
-     *  __construct
-     */
-    function __construct()
-    {
-    }
-
-
-
-    /**
-     * The form section on which this strategy is to perform
-     *
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        $this->_form_section = $form;
-    }
-
-
-
-    /**
-     * @return \EE_Form_Section_Proper
-     */
-    public function form_section()
-    {
-        return $this->_form_section;
-    }
-
-
-
-    /**
-     * Also has teh side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string HTML for displaying
-     */
-    public function layout_form()
-    {
-        $html = '';
-        // layout_form_begin
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
-            $this->layout_form_begin(),
-            $this->_form_section
-        );
-        // layout_form_loop
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
-            $this->layout_form_loop(),
-            $this->_form_section
-        );
-        // layout_form_end
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
-            $this->layout_form_end(),
-            $this->_form_section
-        );
-        $html = $this->add_form_section_hooks_and_filters($html);
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function layout_form_loop()
-    {
-        $html = '';
-        foreach ($this->_form_section->subsections() as $name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_input($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            } elseif ($subsection instanceof EE_Form_Section_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_subsection($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_begin();
-
-
-
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
-     *
-     * @return string
-     */
-    abstract public function layout_form_end();
-
-
-
-    /**
-     * Should be used internally by layout_form() to layout each input (eg, if this layout
-     * is putting each input in a row of its own, this should probably be called by a
-     *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
-     * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
-     * customize the form's layout, but would like to make use of it for laying out
-     * 'easy-to-layout' inputs
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string html
-     */
-    abstract public function layout_input($input);
-
-
-
-    /**
-     * Similar to layout_input(), should be used internally by layout_form() within a
-     * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
-     * that the proper subsection will layout its container, label, etc on its own.
-     *
-     * @param EE_Form_Section_Base $subsection
-     * @return string html
-     */
-    abstract public function layout_subsection($subsection);
-
-
-
-    /**
-     * Gets the HTML for the label tag and its contents for the input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_label($input)
-    {
-        $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
-        $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
-            : $input->html_label_text();
-        return '<label id="'
-               . $input->html_label_id()
-               . '" class="'
-               . $class
-               . '" style="'
-               . $input->html_label_style()
-               . '" for="' . $input->html_name()
-               . '">'
-               . $label_text
-               . '</label>';
-    }
-
-
-
-    /**
-     * returns the HTML for the server-side validation errors for the specified input
-     * Note that if JS is enabled, it should remove these and instead
-     * populate the form's errors in the jquery validate fashion
-     * using the localized data provided to the JS
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_errors($input)
-    {
-        if ($input->get_validation_errors()) {
-            return "<label  id='"
-                   . $input->html_id()
-                   . "-error' class='error' for='{$input->html_name()}'>"
-                   . $input->get_validation_error_string()
-                   . "</label>";
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Displays the help span for the specified input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_help_text($input)
-    {
-        if ($input->html_help_text() != '') {
-            $tag = is_admin() ? 'p' : 'span';
-            return '<'
-                   . $tag
-                   . ' id="'
-                   . $input->html_id()
-                   . '-help" class="'
-                   . $input->html_help_class()
-                   . '" style="'
-                   . $input->html_help_style()
-                   . '">'
-                   . $input->html_help_text()
-                   . '</'
-                   . $tag
-                   . '>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Does an action and hook onto the end of teh form
-     *
-     * @param string $html
-     * @return string
-     */
-    public function add_form_section_hooks_and_filters($html)
-    {
-        // replace dashes and spaces with underscores
-        $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
-        return $html;
-    }
+	/**
+	 * Form form section to lay out
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_form_section;
+
+
+
+	/**
+	 *  __construct
+	 */
+	function __construct()
+	{
+	}
+
+
+
+	/**
+	 * The form section on which this strategy is to perform
+	 *
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		$this->_form_section = $form;
+	}
+
+
+
+	/**
+	 * @return \EE_Form_Section_Proper
+	 */
+	public function form_section()
+	{
+		return $this->_form_section;
+	}
+
+
+
+	/**
+	 * Also has teh side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string HTML for displaying
+	 */
+	public function layout_form()
+	{
+		$html = '';
+		// layout_form_begin
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+			$this->layout_form_begin(),
+			$this->_form_section
+		);
+		// layout_form_loop
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+			$this->layout_form_loop(),
+			$this->_form_section
+		);
+		// layout_form_end
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+			$this->layout_form_end(),
+			$this->_form_section
+		);
+		$html = $this->add_form_section_hooks_and_filters($html);
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function layout_form_loop()
+	{
+		$html = '';
+		foreach ($this->_form_section->subsections() as $name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
+					$this->layout_input($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			} elseif ($subsection instanceof EE_Form_Section_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
+					$this->layout_subsection($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_begin();
+
+
+
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_end();
+
+
+
+	/**
+	 * Should be used internally by layout_form() to layout each input (eg, if this layout
+	 * is putting each input in a row of its own, this should probably be called by a
+	 *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
+	 * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
+	 * customize the form's layout, but would like to make use of it for laying out
+	 * 'easy-to-layout' inputs
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string html
+	 */
+	abstract public function layout_input($input);
+
+
+
+	/**
+	 * Similar to layout_input(), should be used internally by layout_form() within a
+	 * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
+	 * that the proper subsection will layout its container, label, etc on its own.
+	 *
+	 * @param EE_Form_Section_Base $subsection
+	 * @return string html
+	 */
+	abstract public function layout_subsection($subsection);
+
+
+
+	/**
+	 * Gets the HTML for the label tag and its contents for the input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_label($input)
+	{
+		$class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
+		$label_text = $input->required()
+			? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+			: $input->html_label_text();
+		return '<label id="'
+			   . $input->html_label_id()
+			   . '" class="'
+			   . $class
+			   . '" style="'
+			   . $input->html_label_style()
+			   . '" for="' . $input->html_name()
+			   . '">'
+			   . $label_text
+			   . '</label>';
+	}
+
+
+
+	/**
+	 * returns the HTML for the server-side validation errors for the specified input
+	 * Note that if JS is enabled, it should remove these and instead
+	 * populate the form's errors in the jquery validate fashion
+	 * using the localized data provided to the JS
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_errors($input)
+	{
+		if ($input->get_validation_errors()) {
+			return "<label  id='"
+				   . $input->html_id()
+				   . "-error' class='error' for='{$input->html_name()}'>"
+				   . $input->get_validation_error_string()
+				   . "</label>";
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Displays the help span for the specified input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_help_text($input)
+	{
+		if ($input->html_help_text() != '') {
+			$tag = is_admin() ? 'p' : 'span';
+			return '<'
+				   . $tag
+				   . ' id="'
+				   . $input->html_id()
+				   . '-help" class="'
+				   . $input->html_help_class()
+				   . '" style="'
+				   . $input->html_help_style()
+				   . '">'
+				   . $input->html_help_text()
+				   . '</'
+				   . $tag
+				   . '>';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Does an action and hook onto the end of teh form
+	 *
+	 * @param string $html
+	 * @return string
+	 */
+	public function add_form_section_hooks_and_filters($html)
+	{
+		// replace dashes and spaces with underscores
+		$hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
+		do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+		$html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
+		$html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
+		$html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+		return $html;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -68,19 +68,19 @@ 
         $html = '';
         // layout_form_begin
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(),
             $this->layout_form_begin(),
             $this->_form_section
         );
         // layout_form_loop
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(),
             $this->layout_form_loop(),
             $this->_form_section
         );
         // layout_form_end
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(),
             $this->layout_form_end(),
             $this->_form_section
         );
@@ -99,14 +99,14 @@ 
         foreach ($this->_form_section->subsections() as $name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
                 $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_' . $name . '__in_' . $this->_form_section->name(),
+                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'.$name.'__in_'.$this->_form_section->name(),
                     $this->layout_input($subsection),
                     $this->_form_section,
                     $subsection
                 );
             } elseif ($subsection instanceof EE_Form_Section_Base) {
                 $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_' . $name . '__in_' . $this->_form_section->name(),
+                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'.$name.'__in_'.$this->_form_section->name(),
                     $this->layout_subsection($subsection),
                     $this->_form_section,
                     $subsection
@@ -171,9 +171,9 @@ 
      */
     public function display_label($input)
     {
-        $class = $input->required() ? 'ee-required-label ' . $input->html_label_class() : $input->html_label_class();
+        $class = $input->required() ? 'ee-required-label '.$input->html_label_class() : $input->html_label_class();
         $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+            ? $input->html_label_text().'<span class="ee-asterisk">*</span>'
             : $input->html_label_text();
         return '<label id="'
                . $input->html_label_id()
@@ -181,7 +181,7 @@ 
                . $class
                . '" style="'
                . $input->html_label_style()
-               . '" for="' . $input->html_name()
+               . '" for="'.$input->html_name()
                . '">'
                . $label_text
                . '</label>';
@@ -252,10 +252,10 @@ 
     {
         // replace dashes and spaces with underscores
         $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = apply_filters('AFEE__Form_Section_Layout__' . $hook_name . '__html', $html, $this->_form_section);
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+        do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section);
+        $html = apply_filters('AFEE__Form_Section_Layout__'.$hook_name.'__html', $html, $this->_form_section);
+        $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->';
+        $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->';
         return $html;
     }
 }

core/libraries/form_sections/strategies/layout/EE_Admin_Two_Column_Layout.strategy.php

Indentation +59 added lines, -59 removed lines

@@ -9,69 +9,69 @@
 class EE_Admin_Two_Column_Layout extends EE_Two_Column_Layout
 {
 
-    /**
-     * Overriding the parent table layout to include <tbody> tags
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_begin($additional_args = array())
-    {
-        $this->_form_section->set_html_class('form-table');
-        return parent::layout_form_begin($additional_args);
-    }
+	/**
+	 * Overriding the parent table layout to include <tbody> tags
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_begin($additional_args = array())
+	{
+		$this->_form_section->set_html_class('form-table');
+		return parent::layout_form_begin($additional_args);
+	}
 
 
 
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        if ($form_section instanceof EE_Form_Section_Proper) {
-            return EEH_HTML::no_row($form_section->get_html(), 2);
-        } elseif ($form_section instanceof EE_Form_Section_HTML) {
-            return EEH_HTML::no_row($form_section->get_html(), 2);
-        }
-        return '';
-    }
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		if ($form_section instanceof EE_Form_Section_Proper) {
+			return EEH_HTML::no_row($form_section->get_html(), 2);
+		} elseif ($form_section instanceof EE_Form_Section_HTML) {
+			return EEH_HTML::no_row($form_section->get_html(), 2);
+		}
+		return '';
+	}
 
 
 
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
-            || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
-        ) {
-            $input->set_html_class($input->html_class() . ' large-text');
-        }
-        if ($input instanceof EE_Text_Area_Input) {
-            $input->set_rows(4);
-            $input->set_cols(60);
-        }
-        $input_html = $input->get_html_for_input();
-        // maybe add errors and help text ?
-        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
-        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
-        //overriding parent to add wp admin specific things.
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
-        } else {
-            $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function layout_input($input)
+	{
+		if ($input->get_display_strategy() instanceof EE_Text_Area_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
+			|| $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
+		) {
+			$input->set_html_class($input->html_class() . ' large-text');
+		}
+		if ($input instanceof EE_Text_Area_Input) {
+			$input->set_rows(4);
+			$input->set_cols(60);
+		}
+		$input_html = $input->get_html_for_input();
+		// maybe add errors and help text ?
+		$input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
+		$input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+		//overriding parent to add wp admin specific things.
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
+		} else {
+			$html .= EEH_HTML::tr(
+				EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
+			);
+		}
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -53,7 +53,7 @@ 
             || $input->get_display_strategy() instanceof EE_Text_Input_Display_Strategy
             || $input->get_display_strategy() instanceof EE_Admin_File_Uploader_Display_Strategy
         ) {
-            $input->set_html_class($input->html_class() . ' large-text');
+            $input->set_html_class($input->html_class().' large-text');
         }
         if ($input instanceof EE_Text_Area_Input) {
             $input->set_rows(4);
@@ -61,15 +61,15 @@ 
         }
         $input_html = $input->get_html_for_input();
         // maybe add errors and help text ?
-        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl() . $input->get_html_for_errors() : '';
-        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+        $input_html .= $input->get_html_for_errors() != '' ? EEH_HTML::nl().$input->get_html_for_errors() : '';
+        $input_html .= $input->get_html_for_help() != '' ? EEH_HTML::nl().$input->get_html_for_help() : '';
         //overriding parent to add wp admin specific things.
         $html = '';
         if ($input instanceof EE_Hidden_Input) {
             $html .= EEH_HTML::no_row($input->get_html_for_input(), 2);
         } else {
             $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"') . EEH_HTML::td($input_html)
+                EEH_HTML::th($input->get_html_for_label(), '', '', '', 'scope="row"').EEH_HTML::td($input_html)
             );
         }
         return $html;

core/libraries/form_sections/strategies/layout/EE_Div_Per_Section_Layout.strategy.php

Indentation +119 added lines, -119 removed lines

@@ -14,123 +14,123 @@
 class EE_Div_Per_Section_Layout extends EE_Form_Section_Layout_Base
 {
 
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        return EEH_HTML::div(
-            '',
-            $this->_form_section->html_id(),
-            $this->_form_section->html_class(),
-            $this->_form_section->html_style()
-        );
-    }
-
-
-
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-        } elseif ($input instanceof EE_Submit_Input) {
-            $html .= EEH_HTML::div(
-                $input->get_html_for_input(),
-                $input->html_id() . '-submit-dv',
-                $input->html_class() . '-submit-dv'
-            );
-        } elseif ($input instanceof EE_Select_Input) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
-            );
-        } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
-            );
-        } else {
-            $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
-            );
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * _display_label_for_option_type_question
-     * Gets the HTML for the 'label', which is just text for this (because labels
-     * should be for each input)
-     *
-     * @param EE_Form_Input_With_Options_Base $input
-     * @return string
-     */
-    protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
-    {
-        if ($input->display_html_label_text() != '') {
-            $class = $input->required()
-                ? 'ee-required-label ' . $input->html_label_class()
-                : $input->html_label_class();
-            $label_text = $input->required()
-                ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
-                : $input->html_label_text();
-            $html = '<div id="' . $input->html_label_id() . '"';
-            $html .= ' class="' . $class . '"';
-            $html .= ' style="' . $input->html_label_style() . '">';
-            $html .= $label_text . '</div>';
-            return $html;
-        } else {
-            return '';
-        }
-    }
-
-
-
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
-    }
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		return EEH_HTML::div(
+			'',
+			$this->_form_section->html_id(),
+			$this->_form_section->html_class(),
+			$this->_form_section->html_style()
+		);
+	}
+
+
+
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+		} elseif ($input instanceof EE_Submit_Input) {
+			$html .= EEH_HTML::div(
+				$input->get_html_for_input(),
+				$input->html_id() . '-submit-dv',
+				$input->html_class() . '-submit-dv'
+			);
+		} elseif ($input instanceof EE_Select_Input) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$input->html_id() . '-input-dv',
+				$input->html_class() . '-input-dv'
+			);
+		} elseif ($input instanceof EE_Form_Input_With_Options_Base) {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$input->html_id() . '-input-dv',
+				$input->html_class() . '-input-dv'
+			);
+		} else {
+			$html .= EEH_HTML::div(
+				EEH_HTML::nl(1) . $input->get_html_for_label() .
+				EEH_HTML::nl() . $input->get_html_for_errors() .
+				EEH_HTML::nl() . $input->get_html_for_input() .
+				EEH_HTML::nl() . $input->get_html_for_help(),
+				$input->html_id() . '-input-dv',
+				$input->html_class() . '-input-dv'
+			);
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * _display_label_for_option_type_question
+	 * Gets the HTML for the 'label', which is just text for this (because labels
+	 * should be for each input)
+	 *
+	 * @param EE_Form_Input_With_Options_Base $input
+	 * @return string
+	 */
+	protected function _display_label_for_option_type_question(EE_Form_Input_With_Options_Base $input)
+	{
+		if ($input->display_html_label_text() != '') {
+			$class = $input->required()
+				? 'ee-required-label ' . $input->html_label_class()
+				: $input->html_label_class();
+			$label_text = $input->required()
+				? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+				: $input->html_label_text();
+			$html = '<div id="' . $input->html_label_id() . '"';
+			$html .= ' class="' . $class . '"';
+			$html .= ' style="' . $input->html_label_style() . '">';
+			$html .= $label_text . '</div>';
+			return $html;
+		} else {
+			return '';
+		}
+	}
+
+
+
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		//		d( $form_section );
+		return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::divx($this->_form_section->html_id(), $this->_form_section->html_class());
+	}
 }
\ No newline at end of file

Spacing +28 added lines, -28 removed lines

@@ -41,39 +41,39 @@ 
     {
         $html = '';
         if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
         } elseif ($input instanceof EE_Submit_Input) {
             $html .= EEH_HTML::div(
                 $input->get_html_for_input(),
-                $input->html_id() . '-submit-dv',
-                $input->html_class() . '-submit-dv'
+                $input->html_id().'-submit-dv',
+                $input->html_class().'-submit-dv'
             );
         } elseif ($input instanceof EE_Select_Input) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $input->html_id().'-input-dv',
+                $input->html_class().'-input-dv'
             );
         } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl() . $this->_display_label_for_option_type_question($input) .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
+                EEH_HTML::nl().$this->_display_label_for_option_type_question($input).
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $input->html_id().'-input-dv',
+                $input->html_class().'-input-dv'
             );
         } else {
             $html .= EEH_HTML::div(
-                EEH_HTML::nl(1) . $input->get_html_for_label() .
-                EEH_HTML::nl() . $input->get_html_for_errors() .
-                EEH_HTML::nl() . $input->get_html_for_input() .
-                EEH_HTML::nl() . $input->get_html_for_help(),
-                $input->html_id() . '-input-dv',
-                $input->html_class() . '-input-dv'
+                EEH_HTML::nl(1).$input->get_html_for_label().
+                EEH_HTML::nl().$input->get_html_for_errors().
+                EEH_HTML::nl().$input->get_html_for_input().
+                EEH_HTML::nl().$input->get_html_for_help(),
+                $input->html_id().'-input-dv',
+                $input->html_class().'-input-dv'
             );
         }
         return $html;
@@ -93,15 +93,15 @@ 
     {
         if ($input->display_html_label_text() != '') {
             $class = $input->required()
-                ? 'ee-required-label ' . $input->html_label_class()
+                ? 'ee-required-label '.$input->html_label_class()
                 : $input->html_label_class();
             $label_text = $input->required()
-                ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+                ? $input->html_label_text().'<span class="ee-asterisk">*</span>'
                 : $input->html_label_text();
-            $html = '<div id="' . $input->html_label_id() . '"';
-            $html .= ' class="' . $class . '"';
-            $html .= ' style="' . $input->html_label_style() . '">';
-            $html .= $label_text . '</div>';
+            $html = '<div id="'.$input->html_label_id().'"';
+            $html .= ' class="'.$class.'"';
+            $html .= ' style="'.$input->html_label_style().'">';
+            $html .= $label_text.'</div>';
             return $html;
         } else {
             return '';
@@ -119,7 +119,7 @@ 
     public function layout_subsection($form_section)
     {
         //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+        return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1);
     }
 
 

core/libraries/form_sections/strategies/layout/EE_Fieldset_Section_Layout.strategy.php

Indentation +104 added lines, -104 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,109 +16,109 @@ 
 class EE_Fieldset_Section_Layout extends EE_Div_Per_Section_Layout
 {
 
-    /**
-     * legend_class
-     *
-     * @var string
-     */
-    protected $_legend_class;
-
-    /**
-     * legend_text
-     *
-     * @var string
-     */
-    protected $_legend_text;
-
-
-
-    /**
-     *    construct
-     *
-     * @param array $options
-     */
-    public function __construct($options = array())
-    {
-        foreach ($options as $key => $value) {
-            $key = '_' . $key;
-            if (property_exists($this, $key)) {
-                $this->{$key} = $value;
-            }
-        }
-    }
-
-
-
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        $html = EEH_HTML::nl(1)
-                . '<fieldset id="'
-                . $this->_form_section->html_id()
-                . '" class="'
-                . $this->_form_section->html_class()
-                . '" style="'
-                . $this->_form_section->html_style()
-                . '">';
-        $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
-        return $html;
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::nl(-1) . '</fieldset>';
-    }
-
-
-
-    /**
-     * @param string $legend_class
-     */
-    public function set_legend_class($legend_class)
-    {
-        $this->_legend_class = $legend_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function legend_class()
-    {
-        return $this->_legend_class;
-    }
-
-
-
-    /**
-     * @param string $legend_text
-     */
-    public function set_legend_text($legend_text)
-    {
-        $this->_legend_text = $legend_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function legend_text()
-    {
-        return $this->_legend_text;
-    }
+	/**
+	 * legend_class
+	 *
+	 * @var string
+	 */
+	protected $_legend_class;
+
+	/**
+	 * legend_text
+	 *
+	 * @var string
+	 */
+	protected $_legend_text;
+
+
+
+	/**
+	 *    construct
+	 *
+	 * @param array $options
+	 */
+	public function __construct($options = array())
+	{
+		foreach ($options as $key => $value) {
+			$key = '_' . $key;
+			if (property_exists($this, $key)) {
+				$this->{$key} = $value;
+			}
+		}
+	}
+
+
+
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		$html = EEH_HTML::nl(1)
+				. '<fieldset id="'
+				. $this->_form_section->html_id()
+				. '" class="'
+				. $this->_form_section->html_class()
+				. '" style="'
+				. $this->_form_section->html_style()
+				. '">';
+		$html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
+		return $html;
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::nl(-1) . '</fieldset>';
+	}
+
+
+
+	/**
+	 * @param string $legend_class
+	 */
+	public function set_legend_class($legend_class)
+	{
+		$this->_legend_class = $legend_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function legend_class()
+	{
+		return $this->_legend_class;
+	}
+
+
+
+	/**
+	 * @param string $legend_text
+	 */
+	public function set_legend_text($legend_text)
+	{
+		$this->_legend_text = $legend_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function legend_text()
+	{
+		return $this->_legend_text;
+	}
 
 
 

Spacing +4 added lines, -4 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -40,7 +40,7 @@ 
     public function __construct($options = array())
     {
         foreach ($options as $key => $value) {
-            $key = '_' . $key;
+            $key = '_'.$key;
             if (property_exists($this, $key)) {
                 $this->{$key} = $value;
             }
@@ -64,7 +64,7 @@ 
                 . '" style="'
                 . $this->_form_section->html_style()
                 . '">';
-        $html .= '<legend class="' . $this->legend_class() . '">' . $this->legend_text() . '</legend>';
+        $html .= '<legend class="'.$this->legend_class().'">'.$this->legend_text().'</legend>';
         return $html;
     }
 
@@ -77,7 +77,7 @@ 
      */
     public function layout_form_end()
     {
-        return EEH_HTML::nl(-1) . '</fieldset>';
+        return EEH_HTML::nl(-1).'</fieldset>';
     }
 
 

core/libraries/form_sections/strategies/layout/EE_No_Layout.strategy.php

Indentation +113 added lines, -113 removed lines

@@ -15,117 +15,117 @@
 {
 
 
-    /**
-     * This is a flag indicating whether to use '<br>' tags after each input in the layout
-     * strategy.
-     *
-     * @var bool
-     */
-    protected $_use_break_tags = true;
-
-
-
-    /**
-     * EE_No_Layout constructor.
-     *
-     * @param array $options  Currently if this has a 'use_break_tags' key that is used to set the _use_break_tags
-     *                        property on the class.
-     */
-    public function __construct($options = array())
-    {
-        $this->_use_break_tags = is_array($options) && isset($options['use_break_tags'])
-            ? filter_var($options['use_break_tags'], FILTER_VALIDATE_BOOLEAN)
-            : $this->_use_break_tags;
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Add line break at beginning of form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        return EEH_HTML::nl(1);
-    }
-
-
-
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     * @throws \EE_Error
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-        } elseif ($input instanceof EE_Submit_Input) {
-            $html .= $this->br();
-            $html .= $input->get_html_for_input();
-        } elseif ($input instanceof EE_Select_Input) {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-            $html .= $this->br();
-        } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-        } else {
-            $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
-        }
-        $html .= EEH_HTML::nl(-1);
-        return $html;
-    }
-
-
-
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * Add line break at end of form.
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        return EEH_HTML::nl(-1);
-    }
-
-
-
-    /**
-     * This returns a break tag or an empty string depending on the value of the `_use_break_tags` property.
-     *
-     * @return string
-     */
-    protected function br()
-    {
-        return $this->_use_break_tags ? EEH_HTML::br() : '';
-    }
+	/**
+	 * This is a flag indicating whether to use '<br>' tags after each input in the layout
+	 * strategy.
+	 *
+	 * @var bool
+	 */
+	protected $_use_break_tags = true;
+
+
+
+	/**
+	 * EE_No_Layout constructor.
+	 *
+	 * @param array $options  Currently if this has a 'use_break_tags' key that is used to set the _use_break_tags
+	 *                        property on the class.
+	 */
+	public function __construct($options = array())
+	{
+		$this->_use_break_tags = is_array($options) && isset($options['use_break_tags'])
+			? filter_var($options['use_break_tags'], FILTER_VALIDATE_BOOLEAN)
+			: $this->_use_break_tags;
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Add line break at beginning of form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		return EEH_HTML::nl(1);
+	}
+
+
+
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+		} elseif ($input instanceof EE_Submit_Input) {
+			$html .= $this->br();
+			$html .= $input->get_html_for_input();
+		} elseif ($input instanceof EE_Select_Input) {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl(1) . $input->get_html_for_label();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+			$html .= $this->br();
+		} elseif ($input instanceof EE_Form_Input_With_Options_Base) {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+		} else {
+			$html .= $this->br();
+			$html .= EEH_HTML::nl(1) . $input->get_html_for_label();
+			$html .= EEH_HTML::nl() . $input->get_html_for_errors();
+			$html .= EEH_HTML::nl() . $input->get_html_for_input();
+			$html .= EEH_HTML::nl() . $input->get_html_for_help();
+		}
+		$html .= EEH_HTML::nl(-1);
+		return $html;
+	}
+
+
+
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		//		d( $form_section );
+		return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * Add line break at end of form.
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		return EEH_HTML::nl(-1);
+	}
+
+
+
+	/**
+	 * This returns a break tag or an empty string depending on the value of the `_use_break_tags` property.
+	 *
+	 * @return string
+	 */
+	protected function br()
+	{
+		return $this->_use_break_tags ? EEH_HTML::br() : '';
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -64,28 +64,28 @@ 
     {
         $html = '';
         if ($input instanceof EE_Hidden_Input) {
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
         } elseif ($input instanceof EE_Submit_Input) {
             $html .= $this->br();
             $html .= $input->get_html_for_input();
         } elseif ($input instanceof EE_Select_Input) {
             $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl(1).$input->get_html_for_label();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
             $html .= $this->br();
         } elseif ($input instanceof EE_Form_Input_With_Options_Base) {
             $html .= $this->br();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
         } else {
             $html .= $this->br();
-            $html .= EEH_HTML::nl(1) . $input->get_html_for_label();
-            $html .= EEH_HTML::nl() . $input->get_html_for_errors();
-            $html .= EEH_HTML::nl() . $input->get_html_for_input();
-            $html .= EEH_HTML::nl() . $input->get_html_for_help();
+            $html .= EEH_HTML::nl(1).$input->get_html_for_label();
+            $html .= EEH_HTML::nl().$input->get_html_for_errors();
+            $html .= EEH_HTML::nl().$input->get_html_for_input();
+            $html .= EEH_HTML::nl().$input->get_html_for_help();
         }
         $html .= EEH_HTML::nl(-1);
         return $html;
@@ -102,7 +102,7 @@ 
     public function layout_subsection($form_section)
     {
         //		d( $form_section );
-        return EEH_HTML::nl(1) . $form_section->get_html() . EEH_HTML::nl(-1);
+        return EEH_HTML::nl(1).$form_section->get_html().EEH_HTML::nl(-1);
     }
 
 

core/libraries/form_sections/strategies/layout/EE_Two_Column_Layout.strategy.php

Indentation +67 added lines, -67 removed lines

@@ -5,80 +5,80 @@
 class EE_Two_Column_Layout extends EE_Form_Section_Layout_Base
 {
 
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_begin($additional_args = array())
-    {
-        return EEH_HTML::table(
-            '',
-            $this->_form_section->html_id(),
-            $this->_form_section->html_class(),
-            $this->_form_section->html_style()
-        ) . EEH_HTML::tbody();
-    }
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_begin($additional_args = array())
+	{
+		return EEH_HTML::table(
+			'',
+			$this->_form_section->html_id(),
+			$this->_form_section->html_class(),
+			$this->_form_section->html_style()
+		) . EEH_HTML::tbody();
+	}
 
 
 
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
-     *
-     * @param array $additional_args
-     * @return string
-     */
-    public function layout_form_end($additional_args = array())
-    {
-        return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id());
-    }
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
+	 *
+	 * @param array $additional_args
+	 * @return string
+	 */
+	public function layout_form_end($additional_args = array())
+	{
+		return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id());
+	}
 
 
 
-    /**
-     * Lays out the row for the input, including label and errors
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        $html = '';
-        if ($input instanceof EE_Hidden_Input) {
-            $html .= $input->get_html_for_input();
-        } else {
-            $html_for_input = $input->get_html_for_input();
-            $html_for_input .= $input->get_html_for_errors() != ''
-                ? EEH_HTML::nl() . $input->get_html_for_errors()
-                : '';
-            $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
-            $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label()) .
-                EEH_HTML::td($html_for_input)
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out the row for the input, including label and errors
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function layout_input($input)
+	{
+		$html = '';
+		if ($input instanceof EE_Hidden_Input) {
+			$html .= $input->get_html_for_input();
+		} else {
+			$html_for_input = $input->get_html_for_input();
+			$html_for_input .= $input->get_html_for_errors() != ''
+				? EEH_HTML::nl() . $input->get_html_for_errors()
+				: '';
+			$html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+			$html .= EEH_HTML::tr(
+				EEH_HTML::th($input->get_html_for_label()) .
+				EEH_HTML::td($html_for_input)
+			);
+		}
+		return $html;
+	}
 
 
 
-    /**
-     * Lays out a row for the subsection
-     *
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        $html = '';
-        if ($form_section instanceof EE_Form_Section_HTML) {
-            $html .= $form_section->get_html();
-        } else {
-            $html .= EEH_HTML::tr(
-                EEH_HTML::td($form_section->get_html(), '', '', '', 'colspan="2"')
-            );
-        }
-        return $html;
-    }
+	/**
+	 * Lays out a row for the subsection
+	 *
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		$html = '';
+		if ($form_section instanceof EE_Form_Section_HTML) {
+			$html .= $form_section->get_html();
+		} else {
+			$html .= EEH_HTML::tr(
+				EEH_HTML::td($form_section->get_html(), '', '', '', 'colspan="2"')
+			);
+		}
+		return $html;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
             $this->_form_section->html_id(),
             $this->_form_section->html_class(),
             $this->_form_section->html_style()
-        ) . EEH_HTML::tbody();
+        ).EEH_HTML::tbody();
     }
 
 
@@ -31,7 +31,7 @@ 
      */
     public function layout_form_end($additional_args = array())
     {
-        return EEH_HTML::tbodyx() . EEH_HTML::tablex($this->_form_section->html_id());
+        return EEH_HTML::tbodyx().EEH_HTML::tablex($this->_form_section->html_id());
     }
 
 
@@ -50,11 +50,11 @@ 
         } else {
             $html_for_input = $input->get_html_for_input();
             $html_for_input .= $input->get_html_for_errors() != ''
-                ? EEH_HTML::nl() . $input->get_html_for_errors()
+                ? EEH_HTML::nl().$input->get_html_for_errors()
                 : '';
-            $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl() . $input->get_html_for_help() : '';
+            $html_for_input .= $input->get_html_for_help() != '' ? EEH_HTML::nl().$input->get_html_for_help() : '';
             $html .= EEH_HTML::tr(
-                EEH_HTML::th($input->get_html_for_label()) .
+                EEH_HTML::th($input->get_html_for_label()).
                 EEH_HTML::td($html_for_input)
             );
         }

core/libraries/form_sections/strategies/layout/EE_Template_Layout.strategy.php

Indentation +197 added lines, -197 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,201 +27,201 @@ 
 class EE_Template_Layout extends EE_Div_Per_Section_Layout
 {
 
-    protected $_layout_template_file       = null;
-
-    protected $_layout_begin_template_file = null;
-
-    protected $_input_template_file        = null;
-
-    protected $_subsection_template_file   = null;
-
-    protected $_layout_end_template_file   = null;
-
-    protected $_template_args              = array();
-
-
-
-    /**
-     * @param array $template_options {
-     * @type string $_layout_template_file
-     * @type string $_begin_template_file
-     * @type string $_input_template_file
-     * @type string $_subsection_template_file
-     * @type string $_end_template_file
-     * @type array  $_template_args
-     *                                }
-     */
-    public function __construct($template_options = array())
-    {
-        // loop through incoming options
-        foreach ($template_options as $key => $value) {
-            // add underscore to $key to match property names
-            $_key = '_' . $key;
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-            }
-        }
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Also has the side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string
-     */
-    public function layout_form()
-    {
-        if ($this->_layout_template_file) {
-            return EEH_Template::locate_template($this->_layout_template_file, $this->template_args(), true, true);
-        } else {
-            return parent::layout_form();
-        }
-    }
-
-
-
-    /**
-     * opening div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_begin()
-    {
-        if ($this->_layout_begin_template_file) {
-            return EEH_Template::locate_template(
-                $this->_layout_begin_template_file,
-                $this->template_args(),
-                true,
-                true
-            );
-        } else {
-            return parent::layout_form_begin();
-        }
-    }
-
-
-
-    /**
-     * If an input_template_file was provided upon construction, uses that to layout the input. Otherwise uses parent.
-     *
-     * @see EE_DIv_Per_Section_Layout::layout_input() for documentation
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function layout_input($input)
-    {
-        if ($this->_input_template_file) {
-            return EEH_Template::locate_template($this->_input_template_file, array('input' => $input), true, true);
-        }
-        return parent::layout_input($input);
-    }
-
-
-
-    /**
-     * If a subsection_template_file was provided upon construction, uses that to layout the subsection. Otherwise uses parent.
-     *
-     * @see EE_Div_Per_Section_Layout::layout_subsection() for documentation
-     * @param EE_Form_Section_Proper $form_section
-     * @return string
-     */
-    public function layout_subsection($form_section)
-    {
-        if ($this->_subsection_template_file) {
-            return EEH_Template::locate_template($this->_subsection_template_file, $this->template_args(), true, true);
-        }
-        return parent::layout_subsection($form_section);
-    }
-
-
-
-    /**
-     * closing div tag for a form
-     *
-     * @return string
-     */
-    public function layout_form_end()
-    {
-        if ($this->_layout_end_template_file) {
-            return EEH_Template::locate_template($this->_layout_end_template_file, $this->template_args(), true, true);
-        } else {
-            return parent::layout_form_end();
-        }
-    }
-
-
-
-    /**
-     * @param array $template_args
-     */
-    public function set_template_args($template_args = array())
-    {
-        $this->_template_args = $template_args;
-    }
-
-
-
-    /**
-     * @param array $template_args
-     */
-    public function add_template_args($template_args = array())
-    {
-        $this->_template_args = array_merge_recursive($this->_template_args, $template_args);
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function template_args()
-    {
-        foreach ($this->form_section()->subsections() as $subsection_name => $subsection) {
-            $subsection_name = self::prep_form_subsection_key_name($subsection_name);
-            if (strpos($subsection_name, '[') !== false) {
-                $sub_name = explode('[', $subsection_name);
-                $this->_template_args[$sub_name[0]][rtrim($sub_name[1], ']')] = $this->layout_subsection($subsection);
-            } else {
-                $this->_template_args[$subsection_name] = $this->layout_subsection($subsection);
-            }
-        }
-        //		d( $this->_template_args );
-        return $this->_template_args;
-    }
-
-
-
-    /**
-     * prep_form_section_key_name
-     *
-     * @access public
-     * @param string $subsection_name
-     * @return string
-     */
-    public static function prep_form_subsection_key_name($subsection_name = '')
-    {
-        $subsection_name = str_replace(array('-', ' '), array('', '_'), $subsection_name);
-        return is_numeric(substr($subsection_name, 0, 1)) ? 'form_' . $subsection_name : $subsection_name;
-    }
-
-
-
-    /**
-     * get_subform - just a wrapper for the above method
-     *
-     * @access public
-     * @param string $subsection_name
-     * @return string
-     */
-    public static function get_subform_name($subsection_name = '')
-    {
-        return EE_Template_Layout::prep_form_subsection_key_name($subsection_name);
-    }
+	protected $_layout_template_file       = null;
+
+	protected $_layout_begin_template_file = null;
+
+	protected $_input_template_file        = null;
+
+	protected $_subsection_template_file   = null;
+
+	protected $_layout_end_template_file   = null;
+
+	protected $_template_args              = array();
+
+
+
+	/**
+	 * @param array $template_options {
+	 * @type string $_layout_template_file
+	 * @type string $_begin_template_file
+	 * @type string $_input_template_file
+	 * @type string $_subsection_template_file
+	 * @type string $_end_template_file
+	 * @type array  $_template_args
+	 *                                }
+	 */
+	public function __construct($template_options = array())
+	{
+		// loop through incoming options
+		foreach ($template_options as $key => $value) {
+			// add underscore to $key to match property names
+			$_key = '_' . $key;
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+			}
+		}
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Also has the side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string
+	 */
+	public function layout_form()
+	{
+		if ($this->_layout_template_file) {
+			return EEH_Template::locate_template($this->_layout_template_file, $this->template_args(), true, true);
+		} else {
+			return parent::layout_form();
+		}
+	}
+
+
+
+	/**
+	 * opening div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_begin()
+	{
+		if ($this->_layout_begin_template_file) {
+			return EEH_Template::locate_template(
+				$this->_layout_begin_template_file,
+				$this->template_args(),
+				true,
+				true
+			);
+		} else {
+			return parent::layout_form_begin();
+		}
+	}
+
+
+
+	/**
+	 * If an input_template_file was provided upon construction, uses that to layout the input. Otherwise uses parent.
+	 *
+	 * @see EE_DIv_Per_Section_Layout::layout_input() for documentation
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function layout_input($input)
+	{
+		if ($this->_input_template_file) {
+			return EEH_Template::locate_template($this->_input_template_file, array('input' => $input), true, true);
+		}
+		return parent::layout_input($input);
+	}
+
+
+
+	/**
+	 * If a subsection_template_file was provided upon construction, uses that to layout the subsection. Otherwise uses parent.
+	 *
+	 * @see EE_Div_Per_Section_Layout::layout_subsection() for documentation
+	 * @param EE_Form_Section_Proper $form_section
+	 * @return string
+	 */
+	public function layout_subsection($form_section)
+	{
+		if ($this->_subsection_template_file) {
+			return EEH_Template::locate_template($this->_subsection_template_file, $this->template_args(), true, true);
+		}
+		return parent::layout_subsection($form_section);
+	}
+
+
+
+	/**
+	 * closing div tag for a form
+	 *
+	 * @return string
+	 */
+	public function layout_form_end()
+	{
+		if ($this->_layout_end_template_file) {
+			return EEH_Template::locate_template($this->_layout_end_template_file, $this->template_args(), true, true);
+		} else {
+			return parent::layout_form_end();
+		}
+	}
+
+
+
+	/**
+	 * @param array $template_args
+	 */
+	public function set_template_args($template_args = array())
+	{
+		$this->_template_args = $template_args;
+	}
+
+
+
+	/**
+	 * @param array $template_args
+	 */
+	public function add_template_args($template_args = array())
+	{
+		$this->_template_args = array_merge_recursive($this->_template_args, $template_args);
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function template_args()
+	{
+		foreach ($this->form_section()->subsections() as $subsection_name => $subsection) {
+			$subsection_name = self::prep_form_subsection_key_name($subsection_name);
+			if (strpos($subsection_name, '[') !== false) {
+				$sub_name = explode('[', $subsection_name);
+				$this->_template_args[$sub_name[0]][rtrim($sub_name[1], ']')] = $this->layout_subsection($subsection);
+			} else {
+				$this->_template_args[$subsection_name] = $this->layout_subsection($subsection);
+			}
+		}
+		//		d( $this->_template_args );
+		return $this->_template_args;
+	}
+
+
+
+	/**
+	 * prep_form_section_key_name
+	 *
+	 * @access public
+	 * @param string $subsection_name
+	 * @return string
+	 */
+	public static function prep_form_subsection_key_name($subsection_name = '')
+	{
+		$subsection_name = str_replace(array('-', ' '), array('', '_'), $subsection_name);
+		return is_numeric(substr($subsection_name, 0, 1)) ? 'form_' . $subsection_name : $subsection_name;
+	}
+
+
+
+	/**
+	 * get_subform - just a wrapper for the above method
+	 *
+	 * @access public
+	 * @param string $subsection_name
+	 * @return string
+	 */
+	public static function get_subform_name($subsection_name = '')
+	{
+		return EE_Template_Layout::prep_form_subsection_key_name($subsection_name);
+	}
 }
 // End of file EE_Template_Layout.strategy.php

Spacing +3 added lines, -3 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -56,7 +56,7 @@ 
         // loop through incoming options
         foreach ($template_options as $key => $value) {
             // add underscore to $key to match property names
-            $_key = '_' . $key;
+            $_key = '_'.$key;
             if (property_exists($this, $_key)) {
                 $this->{$_key} = $value;
             }
@@ -207,7 +207,7 @@ 
     public static function prep_form_subsection_key_name($subsection_name = '')
     {
         $subsection_name = str_replace(array('-', ' '), array('', '_'), $subsection_name);
-        return is_numeric(substr($subsection_name, 0, 1)) ? 'form_' . $subsection_name : $subsection_name;
+        return is_numeric(substr($subsection_name, 0, 1)) ? 'form_'.$subsection_name : $subsection_name;
     }
 
 

admin_pages/transactions/EE_Admin_Transactions_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
      *
      * @abstract
      * @access protected
-     * @return array
+     * @return string[]
      */
     protected function _get_table_filters()
     {

Indentation +427 added lines, -427 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,106 +22,106 @@ 
 class EE_Admin_Transactions_List_Table extends EE_Admin_List_Table
 {
 
-    private $_status;
-
-
-    /**
-     * @param \Transactions_Admin_Page $admin_page
-     */
-    public function __construct(\Transactions_Admin_Page $admin_page)
-    {
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_transaction_status_array();
-    }
-
-
-    /**
-     *_setup_data
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_admin_page->get_transactions($this->_per_page);
-        $status                = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
-        $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
-    }
-
-
-    /**
-     *_set_properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('transaction', 'event_espresso'),
-            'plural'   => __('transactions', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $ID_column_name      = __('ID', 'event_espresso');
-        $ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
-        $ID_column_name      .= __('Transaction Date', 'event_espresso');
-        $ID_column_name      .= '</span> ';
-        $this->_columns      = array(
-            'TXN_ID'        => $ID_column_name,
-            'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
-            'TXN_total'     => __('Total', 'event_espresso'),
-            'TXN_paid'      => __('Paid', 'event_espresso'),
-            'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
-            'event_name'    => __('Event', 'event_espresso'),
-            'actions'       => __('Actions', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'TXN_ID'        => array('TXN_ID' => false),
-            'event_name'    => array('event_name' => false),
-            'ATT_fname'     => array('ATT_fname' => false),
-            'TXN_timestamp' => array('TXN_timestamp' => true) //true means its already sorted
-        );
-
-        $this->_primary_column = 'TXN_ID';
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Transaction $item the current item
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= ' ee-status-strip txn-status-' . $item->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters    = array();
-        $start_date = isset($this->_req_data['txn-filter-start-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) : date('m/d/Y',
-            strtotime('-10 year'));
-        $end_date   = isset($this->_req_data['txn-filter-end-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) : date('m/d/Y',
-            current_time('timestamp'));
-        ob_start();
-        ?>
+	private $_status;
+
+
+	/**
+	 * @param \Transactions_Admin_Page $admin_page
+	 */
+	public function __construct(\Transactions_Admin_Page $admin_page)
+	{
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_transaction_status_array();
+	}
+
+
+	/**
+	 *_setup_data
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_admin_page->get_transactions($this->_per_page);
+		$status                = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
+		$this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
+	}
+
+
+	/**
+	 *_set_properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('transaction', 'event_espresso'),
+			'plural'   => __('transactions', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$ID_column_name      = __('ID', 'event_espresso');
+		$ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
+		$ID_column_name      .= __('Transaction Date', 'event_espresso');
+		$ID_column_name      .= '</span> ';
+		$this->_columns      = array(
+			'TXN_ID'        => $ID_column_name,
+			'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
+			'TXN_total'     => __('Total', 'event_espresso'),
+			'TXN_paid'      => __('Paid', 'event_espresso'),
+			'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
+			'event_name'    => __('Event', 'event_espresso'),
+			'actions'       => __('Actions', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'TXN_ID'        => array('TXN_ID' => false),
+			'event_name'    => array('event_name' => false),
+			'ATT_fname'     => array('ATT_fname' => false),
+			'TXN_timestamp' => array('TXN_timestamp' => true) //true means its already sorted
+		);
+
+		$this->_primary_column = 'TXN_ID';
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Transaction $item the current item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= ' ee-status-strip txn-status-' . $item->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters    = array();
+		$start_date = isset($this->_req_data['txn-filter-start-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-start-date']) : date('m/d/Y',
+			strtotime('-10 year'));
+		$end_date   = isset($this->_req_data['txn-filter-end-date']) ? wp_strip_all_tags($this->_req_data['txn-filter-end-date']) : date('m/d/Y',
+			current_time('timestamp'));
+		ob_start();
+		?>
         <label for="txn-filter-start-date">Display Transactions from </label>
         <input id="txn-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>"
                name="txn-filter-start-date" size="15"/>
@@ -129,361 +129,361 @@ 
         <input id="txn-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>"
                name="txn-filter-end-date" size="15"/>
         <?php
-        $filters[] = ob_get_contents();
-        ob_end_clean();
-        return $filters;
-    }
-
-
-    /**
-     *_add_view_counts
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count']       = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
-        $this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
-        $this->_views['failed']['count']    = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
-    }
-
-
-    /**
-     *    column TXN_ID
-     *
-     * @param \EE_Transaction $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_ID(EE_Transaction $item)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $item->ID(),
-        ), TXN_ADMIN_URL);
-        $content      = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('Go to Transaction Details',
-                'event_espresso') . '">' . $item->ID() . '</a>';
-
-        //txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($item) . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param \EE_Transaction $item
-     * @return mixed|string|void
-     * @throws \EE_Error
-     */
-    protected function _get_txn_timestamp(EE_Transaction $item)
-    {
-        //txn timestamp
-        // is TXN less than 2 hours old ?
-        if (
-            ($item->failed() || $item->is_abandoned())
-            && (
-                (time() - EE_Registry::instance()->SSN->lifespan()) < $item->datetime(false, true)
-            )
-        ) {
-            $timestamp = __('TXN in progress...', 'event_espresso');
-        } else {
-            $timestamp = $item->get_i18n_datetime('TXN_timestamp');
-        }
-        return $timestamp;
-    }
-
-
-    /**
-     *    column_cb
-     *
-     * @param \EE_Transaction $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="%1$s[]" value="%2$s" />', $this->_wp_list_args['singular'],
-            $item->ID());
-    }
-
-
-    /**
-     *    column_TXN_timestamp
-     *
-     * @param \EE_Transaction $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_timestamp(EE_Transaction $item)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $item->ID(),
-        ), TXN_ADMIN_URL);
-        $txn_date     = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Transaction Details for TXN #',
-                'event_espresso') . $item->ID() . '">' . $this->_get_txn_timestamp($item) . '</a>';
-        //status
-        $txn_date .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
-                'sentence') . '</span>';
-        return $txn_date;
-    }
-
-
-    /**
-     *    column_TXN_total
-     *
-     * @param \EE_Transaction $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Transaction $item)
-    {
-        if ($item->get('TXN_total') > 0) {
-            return '<span class="txn-pad-rght">' . apply_filters('FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
-                    $item->get_pretty('TXN_total'), $item) . '</span>';
-        } else {
-            return '<span class="txn-overview-free-event-spn">' . __('free', 'event_espresso') . '</span>';
-        }
-    }
-
-
-    /**
-     *    column_TXN_paid
-     *
-     * @param \EE_Transaction $item
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Transaction $item)
-    {
-        $transaction_total = $item->get('TXN_total');
-        $transaction_paid  = $item->get('TXN_paid');
-
-        if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
-            // monies owing
-            $span_class = 'txn-overview-part-payment-spn';
-            if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
-                // paid in full
-                $span_class = 'txn-overview-full-payment-spn';
-            } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
-                // no payments made
-                $span_class = 'txn-overview-no-payment-spn';
-            }
-        } else {
-            $span_class       = 'txn-overview-free-event-spn';
-            $transaction_paid = 0;
-        }
-
-        $payment_method      = $item->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name() : __('Unknown',
-            'event_espresso');
-
-        $content = '<span class="' . $span_class . ' txn-pad-rght">' . $transaction_paid !== 0 ? $item->get_pretty('TXN_paid') : $transaction_paid . '</span>';
-        if ($transaction_paid > 0) {
-            $content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
-                    $payment_method_name) . '</span>';
-        }
-        return $content;
-    }
-
-
-    /**
-     *    column_ATT_fname
-     *
-     * @param \EE_Transaction $item
-     * @return string|void
-     * @throws \EE_Error
-     */
-    public function column_ATT_fname(EE_Transaction $item)
-    {
-        $primary_reg = $item->primary_registration();
-        $attendee    = $primary_reg->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'view_registration',
-                '_REG_ID' => $primary_reg->ID(),
-            ), REG_ADMIN_URL);
-            $content      = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
-                'espresso_registrations_view_registration',
-                $primary_reg->ID()) ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details',
-                    'event_espresso') . '">' . $attendee->full_name() . '</a>' : $attendee->full_name();
-            $content      .= '<br>' . $attendee->email();
-            return $content;
-        }
-        return $item->failed() || $item->is_abandoned() ? __('no contact record.',
-            'event_espresso') : __('No contact record, because the transaction was abandoned or the registration process failed.',
-            'event_espresso');
-    }
-
-
-    /**
-     *    column_ATT_email
-     *
-     * @param \EE_Transaction $item
-     * @return string|void
-     * @throws \EE_Error
-     */
-    public function column_ATT_email(EE_Transaction $item)
-    {
-        $attendee = $item->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">' . $attendee->get('ATT_email') . '</a>';
-        } else {
-            return $item->failed() || $item->is_abandoned()
-                ? __('no contact record.', 'event_espresso')
-                : __(
-                    'No contact record, because the transaction was abandoned or the registration process failed.',
-                    'event_espresso'
-                );
-        }
-    }
-
-
-    /**
-     *    column_event_name
-     *
-     * @param \EE_Transaction $item
-     * @return string|void
-     * @throws \EE_Error
-     */
-    public function column_event_name(EE_Transaction $item)
-    {
-        $actions = array();
-        $event   = $item->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL);
-            $event_name     = $event->get('EVT_name');
-
-            //filter this view by transactions for this event
-            $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'default',
-                'EVT_ID' => $event->ID(),
-            ));
-            if (EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit', $event->ID())) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '" title="' . esc_attr__('Filter transactions by this event',
-                        'event_espresso') . '">' . __('View Transactions for this event', 'event_espresso') . '</a>';
-            }
-
-            return sprintf('%1$s %2$s',
-                EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit',
-                    $event->ID()) ? '<a href="' . $edit_event_url . '" title="' . sprintf(esc_attr__('Edit Event: %s',
-                        'event_espresso'), $event->get('EVT_name')) . '">' . wp_trim_words($event_name, 30,
-                        '...') . '</a>' : wp_trim_words($event_name, 30, '...'), $this->row_actions($actions));
-        } else {
-            return __('The event associated with this transaction via the primary registration cannot be retrieved.',
-                'event_espresso');
-        }
-    }
-
-
-    /**
-     *    column_actions
-     *
-     * @param \EE_Transaction $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_actions(EE_Transaction $item)
-    {
-
-        $registration = $item->primary_registration();
-        $attendee     = $registration->attendee();
-
-        //Build row actions
-        $view_lnk_url          = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $item->ID(),
-        ), TXN_ADMIN_URL);
-        $dl_invoice_lnk_url    = $registration->invoice_url();
-        $dl_receipt_lnk_url    = $registration->receipt_url();
-        $view_reg_lnk_url      = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'  => 'view_registration',
-            '_REG_ID' => $registration->ID(),
-        ), REG_ADMIN_URL);
-        $send_pay_lnk_url      = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'send_payment_reminder',
-            'TXN_ID' => $item->ID(),
-        ), TXN_ADMIN_URL);
-        $related_messages_link = EEH_MSG_Template::get_message_action_link('see_notifications_for', null, array(
-            'TXN_ID' => $item->ID(),
-        ));
-
-        //Build row actions
-        $view_lnk = '
+		$filters[] = ob_get_contents();
+		ob_end_clean();
+		return $filters;
+	}
+
+
+	/**
+	 *_add_view_counts
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count']       = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
+		$this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
+		$this->_views['failed']['count']    = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
+	}
+
+
+	/**
+	 *    column TXN_ID
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_ID(EE_Transaction $item)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $item->ID(),
+		), TXN_ADMIN_URL);
+		$content      = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('Go to Transaction Details',
+				'event_espresso') . '">' . $item->ID() . '</a>';
+
+		//txn timestamp
+		$content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($item) . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $item
+	 * @return mixed|string|void
+	 * @throws \EE_Error
+	 */
+	protected function _get_txn_timestamp(EE_Transaction $item)
+	{
+		//txn timestamp
+		// is TXN less than 2 hours old ?
+		if (
+			($item->failed() || $item->is_abandoned())
+			&& (
+				(time() - EE_Registry::instance()->SSN->lifespan()) < $item->datetime(false, true)
+			)
+		) {
+			$timestamp = __('TXN in progress...', 'event_espresso');
+		} else {
+			$timestamp = $item->get_i18n_datetime('TXN_timestamp');
+		}
+		return $timestamp;
+	}
+
+
+	/**
+	 *    column_cb
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="%1$s[]" value="%2$s" />', $this->_wp_list_args['singular'],
+			$item->ID());
+	}
+
+
+	/**
+	 *    column_TXN_timestamp
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_timestamp(EE_Transaction $item)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $item->ID(),
+		), TXN_ADMIN_URL);
+		$txn_date     = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Transaction Details for TXN #',
+				'event_espresso') . $item->ID() . '">' . $this->_get_txn_timestamp($item) . '</a>';
+		//status
+		$txn_date .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
+				'sentence') . '</span>';
+		return $txn_date;
+	}
+
+
+	/**
+	 *    column_TXN_total
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Transaction $item)
+	{
+		if ($item->get('TXN_total') > 0) {
+			return '<span class="txn-pad-rght">' . apply_filters('FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
+					$item->get_pretty('TXN_total'), $item) . '</span>';
+		} else {
+			return '<span class="txn-overview-free-event-spn">' . __('free', 'event_espresso') . '</span>';
+		}
+	}
+
+
+	/**
+	 *    column_TXN_paid
+	 *
+	 * @param \EE_Transaction $item
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Transaction $item)
+	{
+		$transaction_total = $item->get('TXN_total');
+		$transaction_paid  = $item->get('TXN_paid');
+
+		if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
+			// monies owing
+			$span_class = 'txn-overview-part-payment-spn';
+			if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
+				// paid in full
+				$span_class = 'txn-overview-full-payment-spn';
+			} elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
+				// no payments made
+				$span_class = 'txn-overview-no-payment-spn';
+			}
+		} else {
+			$span_class       = 'txn-overview-free-event-spn';
+			$transaction_paid = 0;
+		}
+
+		$payment_method      = $item->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name() : __('Unknown',
+			'event_espresso');
+
+		$content = '<span class="' . $span_class . ' txn-pad-rght">' . $transaction_paid !== 0 ? $item->get_pretty('TXN_paid') : $transaction_paid . '</span>';
+		if ($transaction_paid > 0) {
+			$content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
+					$payment_method_name) . '</span>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    column_ATT_fname
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string|void
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_fname(EE_Transaction $item)
+	{
+		$primary_reg = $item->primary_registration();
+		$attendee    = $primary_reg->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'view_registration',
+				'_REG_ID' => $primary_reg->ID(),
+			), REG_ADMIN_URL);
+			$content      = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
+				'espresso_registrations_view_registration',
+				$primary_reg->ID()) ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details',
+					'event_espresso') . '">' . $attendee->full_name() . '</a>' : $attendee->full_name();
+			$content      .= '<br>' . $attendee->email();
+			return $content;
+		}
+		return $item->failed() || $item->is_abandoned() ? __('no contact record.',
+			'event_espresso') : __('No contact record, because the transaction was abandoned or the registration process failed.',
+			'event_espresso');
+	}
+
+
+	/**
+	 *    column_ATT_email
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string|void
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_email(EE_Transaction $item)
+	{
+		$attendee = $item->primary_registration()->get_first_related('Attendee');
+		if (! empty($attendee)) {
+			return '<a href="mailto:' . $attendee->get('ATT_email') . '">' . $attendee->get('ATT_email') . '</a>';
+		} else {
+			return $item->failed() || $item->is_abandoned()
+				? __('no contact record.', 'event_espresso')
+				: __(
+					'No contact record, because the transaction was abandoned or the registration process failed.',
+					'event_espresso'
+				);
+		}
+	}
+
+
+	/**
+	 *    column_event_name
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string|void
+	 * @throws \EE_Error
+	 */
+	public function column_event_name(EE_Transaction $item)
+	{
+		$actions = array();
+		$event   = $item->primary_registration()->get_first_related('Event');
+		if (! empty($event)) {
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
+				EVENTS_ADMIN_URL);
+			$event_name     = $event->get('EVT_name');
+
+			//filter this view by transactions for this event
+			$txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'default',
+				'EVT_ID' => $event->ID(),
+			));
+			if (EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit', $event->ID())) {
+				$actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '" title="' . esc_attr__('Filter transactions by this event',
+						'event_espresso') . '">' . __('View Transactions for this event', 'event_espresso') . '</a>';
+			}
+
+			return sprintf('%1$s %2$s',
+				EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit',
+					$event->ID()) ? '<a href="' . $edit_event_url . '" title="' . sprintf(esc_attr__('Edit Event: %s',
+						'event_espresso'), $event->get('EVT_name')) . '">' . wp_trim_words($event_name, 30,
+						'...') . '</a>' : wp_trim_words($event_name, 30, '...'), $this->row_actions($actions));
+		} else {
+			return __('The event associated with this transaction via the primary registration cannot be retrieved.',
+				'event_espresso');
+		}
+	}
+
+
+	/**
+	 *    column_actions
+	 *
+	 * @param \EE_Transaction $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_actions(EE_Transaction $item)
+	{
+
+		$registration = $item->primary_registration();
+		$attendee     = $registration->attendee();
+
+		//Build row actions
+		$view_lnk_url          = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $item->ID(),
+		), TXN_ADMIN_URL);
+		$dl_invoice_lnk_url    = $registration->invoice_url();
+		$dl_receipt_lnk_url    = $registration->receipt_url();
+		$view_reg_lnk_url      = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'  => 'view_registration',
+			'_REG_ID' => $registration->ID(),
+		), REG_ADMIN_URL);
+		$send_pay_lnk_url      = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'send_payment_reminder',
+			'TXN_ID' => $item->ID(),
+		), TXN_ADMIN_URL);
+		$related_messages_link = EEH_MSG_Template::get_message_action_link('see_notifications_for', null, array(
+			'TXN_ID' => $item->ID(),
+		));
+
+		//Build row actions
+		$view_lnk = '
 			<li>
 				<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
 
-        $dl_invoice_lnk = '';
-        //only show invoice link if message type is active.
-        if ($attendee instanceof EE_Attendee && EEH_MSG_Template::is_mt_active('invoice')) {
-            $dl_invoice_lnk = '
+		$dl_invoice_lnk = '';
+		//only show invoice link if message type is active.
+		if ($attendee instanceof EE_Attendee && EEH_MSG_Template::is_mt_active('invoice')) {
+			$dl_invoice_lnk = '
 			<li>
 				<a title="' . esc_attr__('View Transaction Invoice',
-                    'event_espresso') . '" target="_blank" href="' . $dl_invoice_lnk_url . '" class="tiny-text">
+					'event_espresso') . '" target="_blank" href="' . $dl_invoice_lnk_url . '" class="tiny-text">
 					<span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
 				</a>
 			</li>';
-        }
+		}
 
-        $dl_receipt_lnk = '';
-        //only show receipt link if message type is active.
-        if ($attendee instanceof EE_Attendee && EEH_MSG_Template::is_mt_active('receipt')) {
-            $dl_receipt_lnk = '
+		$dl_receipt_lnk = '';
+		//only show receipt link if message type is active.
+		if ($attendee instanceof EE_Attendee && EEH_MSG_Template::is_mt_active('receipt')) {
+			$dl_receipt_lnk = '
 			<li>
 				<a title="' . esc_attr__('View Transaction Receipt',
-                    'event_espresso') . '" target="_blank" href="' . $dl_receipt_lnk_url . '" class="tiny-text">
+					'event_espresso') . '" target="_blank" href="' . $dl_receipt_lnk_url . '" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
-        }
-
-        //only show payment reminder link if the message type is active.
-        if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
-            $send_pay_lnk = $attendee instanceof EE_Attendee
-                            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-                ? '
+		}
+
+		//only show payment reminder link if the message type is active.
+		if (EEH_MSG_Template::is_mt_active('payment_reminder')) {
+			$send_pay_lnk = $attendee instanceof EE_Attendee
+							&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+				? '
 				<li>
 					<a href="' . $send_pay_lnk_url . '" title="' . esc_attr__('Send Payment Reminder',
-                    'event_espresso') . '" class="tiny-text">
+					'event_espresso') . '" class="tiny-text">
 						<span class="dashicons dashicons-email-alt"></span>
 					</a>
 				</li>'
-                : '';
-            $send_pay_lnk = $item->get('STS_ID') !== EEM_Transaction::complete_status_code
-                            && $item->get('STS_ID') !== EEM_Transaction::overpaid_status_code
-                ? $send_pay_lnk
-                : '';
-        } else {
-            $send_pay_lnk = '';
-        }
-
-        $view_reg_lnk = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'espresso_registrations_view_registration',
-            $registration->ID()
-        )
-            ? '
+				: '';
+			$send_pay_lnk = $item->get('STS_ID') !== EEM_Transaction::complete_status_code
+							&& $item->get('STS_ID') !== EEM_Transaction::overpaid_status_code
+				? $send_pay_lnk
+				: '';
+		} else {
+			$send_pay_lnk = '';
+		}
+
+		$view_reg_lnk = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'espresso_registrations_view_registration',
+			$registration->ID()
+		)
+			? '
 				<li>
 					<a href="' . $view_reg_lnk_url . '" title="' . esc_attr__('View Registration Details',
-                'event_espresso') . '" class="tiny-text">
+				'event_espresso') . '" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
-            : '';
+			: '';
 
-        $view_related_messages_lnk = '';
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $view_related_messages_lnk = '<li>' . $related_messages_link . '</li>';
-        }
+		$view_related_messages_lnk = '';
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$view_related_messages_lnk = '<li>' . $related_messages_link . '</li>';
+		}
 
-        return $this->_action_string($view_lnk . $dl_invoice_lnk . $dl_receipt_lnk . $view_reg_lnk . $send_pay_lnk . $view_related_messages_lnk,
-            $item, 'ul', 'txn-overview-actions-ul');
-    }
+		return $this->_action_string($view_lnk . $dl_invoice_lnk . $dl_receipt_lnk . $view_reg_lnk . $send_pay_lnk . $view_related_messages_lnk,
+			$item, 'ul', 'txn-overview-actions-ul');
+	}
 
 
 }

Spacing +40 added lines, -40 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -57,11 +57,11 @@ 
             'ajax'     => true,
             'screen'   => $this->_admin_page->get_current_screen()->id,
         );
-        $ID_column_name      = __('ID', 'event_espresso');
+        $ID_column_name = __('ID', 'event_espresso');
         $ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
         $ID_column_name      .= __('Transaction Date', 'event_espresso');
         $ID_column_name      .= '</span> ';
-        $this->_columns      = array(
+        $this->_columns = array(
             'TXN_ID'        => $ID_column_name,
             'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
             'TXN_total'     => __('Total', 'event_espresso'),
@@ -96,7 +96,7 @@ 
     {
         $class = parent::_get_row_class($item);
         //add status class
-        $class .= ' ee-status-strip txn-status-' . $item->status_ID();
+        $class .= ' ee-status-strip txn-status-'.$item->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -159,11 +159,11 @@ 
             'action' => 'view_transaction',
             'TXN_ID' => $item->ID(),
         ), TXN_ADMIN_URL);
-        $content      = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('Go to Transaction Details',
-                'event_espresso') . '">' . $item->ID() . '</a>';
+        $content = '<a href="'.$view_lnk_url.'" title="'.esc_attr__('Go to Transaction Details',
+                'event_espresso').'">'.$item->ID().'</a>';
 
         //txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($item) . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$this->_get_txn_timestamp($item).'</span>';
         return $content;
     }
 
@@ -218,11 +218,11 @@ 
             'action' => 'view_transaction',
             'TXN_ID' => $item->ID(),
         ), TXN_ADMIN_URL);
-        $txn_date     = '<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Transaction Details for TXN #',
-                'event_espresso') . $item->ID() . '">' . $this->_get_txn_timestamp($item) . '</a>';
+        $txn_date = '<a href="'.$view_lnk_url.'" title="'.esc_attr__('View Transaction Details for TXN #',
+                'event_espresso').$item->ID().'">'.$this->_get_txn_timestamp($item).'</a>';
         //status
-        $txn_date .= '<br><span class="ee-status-text-small">' . EEH_Template::pretty_status($item->status_ID(), false,
-                'sentence') . '</span>';
+        $txn_date .= '<br><span class="ee-status-text-small">'.EEH_Template::pretty_status($item->status_ID(), false,
+                'sentence').'</span>';
         return $txn_date;
     }
 
@@ -237,10 +237,10 @@ 
     public function column_TXN_total(EE_Transaction $item)
     {
         if ($item->get('TXN_total') > 0) {
-            return '<span class="txn-pad-rght">' . apply_filters('FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
-                    $item->get_pretty('TXN_total'), $item) . '</span>';
+            return '<span class="txn-pad-rght">'.apply_filters('FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
+                    $item->get_pretty('TXN_total'), $item).'</span>';
         } else {
-            return '<span class="txn-overview-free-event-spn">' . __('free', 'event_espresso') . '</span>';
+            return '<span class="txn-overview-free-event-spn">'.__('free', 'event_espresso').'</span>';
         }
     }
 
@@ -276,10 +276,10 @@ 
         $payment_method_name = $payment_method instanceof EE_Payment_Method ? $payment_method->admin_name() : __('Unknown',
             'event_espresso');
 
-        $content = '<span class="' . $span_class . ' txn-pad-rght">' . $transaction_paid !== 0 ? $item->get_pretty('TXN_paid') : $transaction_paid . '</span>';
+        $content = '<span class="'.$span_class.' txn-pad-rght">'.$transaction_paid !== 0 ? $item->get_pretty('TXN_paid') : $transaction_paid.'</span>';
         if ($transaction_paid > 0) {
-            $content .= '<br><span class="ee-status-text-small">' . sprintf(__('...via %s', 'event_espresso'),
-                    $payment_method_name) . '</span>';
+            $content .= '<br><span class="ee-status-text-small">'.sprintf(__('...via %s', 'event_espresso'),
+                    $payment_method_name).'</span>';
         }
         return $content;
     }
@@ -301,11 +301,11 @@ 
                 'action'  => 'view_registration',
                 '_REG_ID' => $primary_reg->ID(),
             ), REG_ADMIN_URL);
-            $content      = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
+            $content = EE_Registry::instance()->CAP->current_user_can('ee_read_registration',
                 'espresso_registrations_view_registration',
-                $primary_reg->ID()) ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details',
-                    'event_espresso') . '">' . $attendee->full_name() . '</a>' : $attendee->full_name();
-            $content      .= '<br>' . $attendee->email();
+                $primary_reg->ID()) ? '<a href="'.$edit_lnk_url.'" title="'.esc_attr__('View Registration Details',
+                    'event_espresso').'">'.$attendee->full_name().'</a>' : $attendee->full_name();
+            $content .= '<br>'.$attendee->email();
             return $content;
         }
         return $item->failed() || $item->is_abandoned() ? __('no contact record.',
@@ -324,8 +324,8 @@ 
     public function column_ATT_email(EE_Transaction $item)
     {
         $attendee = $item->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">' . $attendee->get('ATT_email') . '</a>';
+        if ( ! empty($attendee)) {
+            return '<a href="mailto:'.$attendee->get('ATT_email').'">'.$attendee->get('ATT_email').'</a>';
         } else {
             return $item->failed() || $item->is_abandoned()
                 ? __('no contact record.', 'event_espresso')
@@ -348,7 +348,7 @@ 
     {
         $actions = array();
         $event   = $item->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
+        if ( ! empty($event)) {
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'edit', 'post' => $event->ID()),
                 EVENTS_ADMIN_URL);
             $event_name     = $event->get('EVT_name');
@@ -359,15 +359,15 @@ 
                 'EVT_ID' => $event->ID(),
             ));
             if (EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit', $event->ID())) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '" title="' . esc_attr__('Filter transactions by this event',
-                        'event_espresso') . '">' . __('View Transactions for this event', 'event_espresso') . '</a>';
+                $actions['filter_by_event'] = '<a href="'.$txn_by_event_lnk.'" title="'.esc_attr__('Filter transactions by this event',
+                        'event_espresso').'">'.__('View Transactions for this event', 'event_espresso').'</a>';
             }
 
             return sprintf('%1$s %2$s',
                 EE_Registry::instance()->CAP->current_user_can('ee_edit_event', 'espresso_events_edit',
-                    $event->ID()) ? '<a href="' . $edit_event_url . '" title="' . sprintf(esc_attr__('Edit Event: %s',
-                        'event_espresso'), $event->get('EVT_name')) . '">' . wp_trim_words($event_name, 30,
-                        '...') . '</a>' : wp_trim_words($event_name, 30, '...'), $this->row_actions($actions));
+                    $event->ID()) ? '<a href="'.$edit_event_url.'" title="'.sprintf(esc_attr__('Edit Event: %s',
+                        'event_espresso'), $event->get('EVT_name')).'">'.wp_trim_words($event_name, 30,
+                        '...').'</a>' : wp_trim_words($event_name, 30, '...'), $this->row_actions($actions));
         } else {
             return __('The event associated with this transaction via the primary registration cannot be retrieved.',
                 'event_espresso');
@@ -389,7 +389,7 @@ 
         $attendee     = $registration->attendee();
 
         //Build row actions
-        $view_lnk_url          = EE_Admin_Page::add_query_args_and_nonce(array(
+        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
             'action' => 'view_transaction',
             'TXN_ID' => $item->ID(),
         ), TXN_ADMIN_URL);
@@ -399,7 +399,7 @@ 
             'action'  => 'view_registration',
             '_REG_ID' => $registration->ID(),
         ), REG_ADMIN_URL);
-        $send_pay_lnk_url      = EE_Admin_Page::add_query_args_and_nonce(array(
+        $send_pay_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
             'action' => 'send_payment_reminder',
             'TXN_ID' => $item->ID(),
         ), TXN_ADMIN_URL);
@@ -410,7 +410,7 @@ 
         //Build row actions
         $view_lnk = '
 			<li>
-				<a href="' . $view_lnk_url . '" title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+				<a href="' . $view_lnk_url.'" title="'.esc_attr__('View Transaction Details', 'event_espresso').'" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
@@ -421,7 +421,7 @@ 
             $dl_invoice_lnk = '
 			<li>
 				<a title="' . esc_attr__('View Transaction Invoice',
-                    'event_espresso') . '" target="_blank" href="' . $dl_invoice_lnk_url . '" class="tiny-text">
+                    'event_espresso').'" target="_blank" href="'.$dl_invoice_lnk_url.'" class="tiny-text">
 					<span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
 				</a>
 			</li>';
@@ -433,7 +433,7 @@ 
             $dl_receipt_lnk = '
 			<li>
 				<a title="' . esc_attr__('View Transaction Receipt',
-                    'event_espresso') . '" target="_blank" href="' . $dl_receipt_lnk_url . '" class="tiny-text">
+                    'event_espresso').'" target="_blank" href="'.$dl_receipt_lnk_url.'" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
@@ -448,8 +448,8 @@ 
             )
                 ? '
 				<li>
-					<a href="' . $send_pay_lnk_url . '" title="' . esc_attr__('Send Payment Reminder',
-                    'event_espresso') . '" class="tiny-text">
+					<a href="' . $send_pay_lnk_url.'" title="'.esc_attr__('Send Payment Reminder',
+                    'event_espresso').'" class="tiny-text">
 						<span class="dashicons dashicons-email-alt"></span>
 					</a>
 				</li>'
@@ -469,8 +469,8 @@ 
         )
             ? '
 				<li>
-					<a href="' . $view_reg_lnk_url . '" title="' . esc_attr__('View Registration Details',
-                'event_espresso') . '" class="tiny-text">
+					<a href="' . $view_reg_lnk_url.'" title="'.esc_attr__('View Registration Details',
+                'event_espresso').'" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
@@ -478,10 +478,10 @@ 
 
         $view_related_messages_lnk = '';
         if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $view_related_messages_lnk = '<li>' . $related_messages_link . '</li>';
+            $view_related_messages_lnk = '<li>'.$related_messages_link.'</li>';
         }
 
-        return $this->_action_string($view_lnk . $dl_invoice_lnk . $dl_receipt_lnk . $view_reg_lnk . $send_pay_lnk . $view_related_messages_lnk,
+        return $this->_action_string($view_lnk.$dl_invoice_lnk.$dl_receipt_lnk.$view_reg_lnk.$send_pay_lnk.$view_related_messages_lnk,
             $item, 'ul', 'txn-overview-actions-ul');
     }