eventespresso / event-espresso-core

core/db_classes/EE_Transaction.class.php

Indentation +1749 added lines, -1749 removed lines

@@ -13,1753 +13,1753 @@
  */
 class EE_Transaction extends EE_Base_Class implements EEI_Transaction
 {
-    /**
-     * The length of time in seconds that a lock is applied before being considered expired.
-     * It is not long because a transaction should only be locked for the duration of the request that locked it
-     */
-    const LOCK_EXPIRATION = 2;
-
-    /**
-     * txn status upon initial construction.
-     *
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    private ?EE_Registration $_primary_registrant = null;
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone
-     *                                        (if not set the timezone set for the website will be used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        $txn        = $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
-            $txn->set_old_txn_status($txn->status_ID());
-        }
-        return $txn;
-    }
-
-
-    /**
-     * @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_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        $txn = new self($props_n_values, true, $timezone);
-        $txn->set_old_txn_status($txn->status_ID());
-        return $txn;
-    }
-
-
-    /**
-     * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
-     * If a lock has already been set, then we will attempt to remove it in case it has expired.
-     * If that also fails, then an exception is thrown.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function lock()
-    {
-        // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
-            // then attempt to remove the lock in case it is expired
-            if ($this->_remove_expired_lock()) {
-                // if removal was successful, then try setting lock again
-                $this->lock();
-            } else {
-                // but if the lock can not be removed, then throw an exception
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
-                            'event_espresso'
-                        ),
-                        $this->ID()
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * removes transaction lock applied in EE_Transaction::lock()
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unlock()
-    {
-        return $this->delete_extra_meta('lock');
-    }
-
-
-    /**
-     * Decides whether or not now is the right time to update the transaction.
-     * This is useful because we don't always know if it is safe to update the transaction
-     * and its related data. why?
-     * because it's possible that the transaction is being used in another
-     * request and could overwrite anything we save.
-     * So we want to only update the txn once we know that won't happen.
-     * We also check that the lock isn't expired, and remove it if it is
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_locked()
-    {
-        // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
-            return false;
-        }
-        // if not, then let's try and remove the lock in case it's expired...
-        // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
-        // and a positive number if the lock was removed (ie: number of locks deleted),
-        // so we need to return the opposite
-        return ! $this->_remove_expired_lock();
-    }
-
-
-    /**
-     * Gets the meta field indicating that this TXN is locked
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_lock()
-    {
-        return (int) $this->get_extra_meta('lock', true, 0);
-    }
-
-
-    /**
-     * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _remove_expired_lock()
-    {
-        $locked = $this->_get_lock();
-        if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
-            return $this->unlock();
-        }
-        return 0;
-    }
-
-
-    /**
-     * Set transaction total
-     *
-     * @param float $total total value of transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total = 0.00)
-    {
-        $this->set('TXN_total', (float) $total);
-    }
-
-
-    /**
-     * Set Total Amount Paid to Date
-     *
-     * @param float $total_paid total amount paid to date (sum of all payments)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_paid($total_paid = 0.00)
-    {
-        $this->set('TXN_paid', (float) $total_paid);
-    }
-
-
-    /**
-     * Set transaction status
-     *
-     * @param string $status        whether the transaction is open, declined, accepted,
-     *                              or any number of custom values that can be set
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_status($status = '')
-    {
-        $this->set('STS_ID', $status);
-    }
-
-
-    /**
-     * Set hash salt
-     *
-     * @param string $hash_salt required for some payment gateways
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_hash_salt($hash_salt = '')
-    {
-        $this->set('TXN_hash_salt', $hash_salt);
-    }
-
-
-    /**
-     * Sets TXN_reg_steps array
-     *
-     * @param array $txn_reg_steps
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_steps(array $txn_reg_steps)
-    {
-        $this->set('TXN_reg_steps', $txn_reg_steps);
-    }
-
-
-    /**
-     * Gets TXN_reg_steps
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_steps()
-    {
-        $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps)
-            ? $TXN_reg_steps
-            : [];
-    }
-
-
-    /**
-     * @param string|null $schema
-     *     Schemas:
-     *     'localized_float': "3,023.00"
-     *     'no_currency_code': "$3,023.00"
-     *     null: "$3,023.00<span>USD</span>"
-     * @return string of transaction's total cost, with currency symbol and decimal
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_total(?string $schema = null)
-    {
-        return $this->get_pretty('TXN_total', $schema);
-    }
-
-
-    /**
-     * Gets the amount paid in a pretty string (formatted and with currency symbol)
-     *
-     * @param string|null $schema
-     *     Schemas:
-     *     'localized_float': "3,023.00"
-     *     'no_currency_code': "$3,023.00"
-     *     null: "$3,023.00<span>USD</span>"
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid(?string $schema = null)
-    {
-        return $this->get_pretty('TXN_paid', $schema);
-    }
-
-
-    /**
-     * calculate the amount remaining for this transaction and return;
-     *
-     * @return float amount remaining
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remaining()
-    {
-        return $this->total() - $this->paid();
-    }
-
-
-    /**
-     * get Transaction Total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return (float) $this->get('TXN_total');
-    }
-
-
-    /**
-     * get Total Amount Paid to Date
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid()
-    {
-        return (float) $this->get('TXN_paid');
-    }
-
-
-    /**
-     * @return mixed|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_cart_session()
-    {
-        $session_data = (array) $this->get('TXN_session_data');
-        return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
-            ? $session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * get Transaction session data
-     *
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function session_data()
-    {
-        $session_data = $this->get('TXN_session_data');
-        if (empty($session_data)) {
-            $session_data = [
-                'id'            => null,
-                'user_id'       => null,
-                'ip_address'    => null,
-                'user_agent'    => null,
-                'init_access'   => null,
-                'last_access'   => null,
-                'pages_visited' => [],
-            ];
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * Set session data within the TXN object
-     *
-     * @param EE_Session|array|null $session_data
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_txn_session_data($session_data)
-    {
-        if ($session_data instanceof EE_Session) {
-            $this->set('TXN_session_data', $session_data->get_session_data(null, true));
-        } else {
-            $this->set('TXN_session_data', $session_data);
-        }
-    }
-
-
-    /**
-     * get Transaction hash salt
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function hash_salt_()
-    {
-        return $this->get('TXN_hash_salt');
-    }
-
-
-    /**
-     * Returns the transaction datetime as either:
-     *            - unix timestamp format ($format = false, $gmt = true)
-     *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
-     *              has no affect with this option)), this also may include a timezone abbreviation if the
-     *              set timezone in this class differs from what the timezone is on the blog.
-     *            - formatted date string including the UTC (timezone) offset (default).
-     *
-     * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
-     * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
-     *                          or no UTC offset applied
-     * @return string | int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime($format = false, $gmt = false)
-    {
-        if ($format) {
-            return $this->get_pretty('TXN_timestamp');
-        }
-        if ($gmt) {
-            return $this->get_raw('TXN_timestamp');
-        }
-        return $this->get('TXN_timestamp');
-    }
-
-
-    /**
-     * Gets registrations on this transaction
-     *
-     * @param array   $query_params array of query parameters
-     * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registrations($query_params = [], $get_cached = false)
-    {
-        $query_params = (empty($query_params) || ! is_array($query_params))
-            ? [
-                'order_by' => [
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                    'REG_ID'             => 'ASC',
-                ],
-            ]
-            : $query_params;
-        $query_params = $get_cached
-            ? []
-            : $query_params;
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
-     * function for getting attendees and how many registrations they each have for an event)
-     *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendees()
-    {
-        return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
-    }
-
-
-    /**
-     * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = [])
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * gets only approved payments for this transaction
-     *
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function approved_payments()
-    {
-        EE_Registry::instance()->load_model('Payment');
-        return $this->get_many_related(
-            'Payment',
-            [
-                ['STS_ID' => EEM_Payment::status_id_approved],
-                'order_by' => ['PAY_timestamp' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all payments which have not been approved
-     *
-     * @return EE_Base_Class[]|EEI_Payment[]
-     * @throws EE_Error if a model is misconfigured somehow
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pending_payments()
-    {
-        return $this->get_many_related(
-            'Payment',
-            [
-                [
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                ],
-                'order_by' => [
-                    'PAY_timestamp' => 'DESC',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$this->status_ID() => esc_html__('unknown', 'event_espresso')],
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Transaction::complete_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::incomplete_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::abandoned_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::failed_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::overpaid_status_code:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     * get Transaction Status
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Returns TRUE or FALSE for whether or not this transaction cost any money
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_free()
-    {
-        return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
-    }
-
-
-    /**
-     * Returns whether this transaction is complete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_completed()
-    {
-        return $this->status_ID() === EEM_Transaction::complete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is incomplete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Transaction::incomplete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is overpaid
-     * Useful in templates and other logic for deciding if monies need to be refunded
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_overpaid()
-    {
-        return $this->status_ID() === EEM_Transaction::overpaid_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction was abandoned
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * but that contact information exists for at least one registrant
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_abandoned()
-    {
-        return $this->status_ID() === EEM_Transaction::abandoned_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction failed
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * and that NO contact information exists for any registrants
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function failed()
-    {
-        return $this->status_ID() === EEM_Transaction::failed_status_code;
-    }
-
-
-    /**
-     * This returns the url for the invoice of this transaction
-     *
-     * @param string $type 'html' or 'pdf' (default is pdf)
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function invoice_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->invoice_url($type);
-    }
-
-
-    /**
-     * Gets the primary registration only
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function primary_registration()
-    {
-        if ($this->_primary_registrant instanceof EE_Registration) {
-            return $this->_primary_registrant;
-        }
-
-        $registrations = (array) $this->get_many_related(
-            'Registration',
-            [['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
-        );
-        foreach ($registrations as $registration) {
-            // valid registration that is NOT cancelled or declined ?
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
-            ) {
-                $this->_primary_registrant = $registration;
-                return $registration;
-            }
-        }
-        // nothing valid found, so just return first thing from array of results
-        $primary_registrant = reset($registrations);
-        $this->_primary_registrant = $primary_registrant instanceof EE_Registration ? $primary_registrant : null;
-        return $this->_primary_registrant;
-    }
-
-
-    /**
-     * Gets the URL for viewing the receipt
-     *
-     * @param string $type 'pdf' or 'html' (default is 'html')
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function receipt_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->receipt_url($type);
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url()
-    {
-        $primary_registration = $this->primary_registration();
-        return $primary_registration instanceof EE_Registration
-            ? $primary_registration->payment_overview_url()
-            : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function gateway_response_on_transaction()
-    {
-        $payment = $this->get_first_related('Payment');
-        return $payment instanceof EE_Payment
-            ? $payment->gateway_response()
-            : '';
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function extra_meta($query_params = [])
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_registration(EE_Registration $registration)
-    {
-        return $this->_add_relation_to($registration, 'Registration');
-    }
-
-
-    /**
-     * Removes the given registration from being related (even before saving this transaction).
-     * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
-     *
-     * @param int $registration_or_id
-     * @return EE_Base_Class that was removed from being related
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_registration_with_id($registration_or_id)
-    {
-        return $this->_remove_relation_to($registration_or_id, 'Registration');
-    }
-
-
-    /**
-     * Gets all the line items which are for ACTUAL items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function items_purchased()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_line_item(EE_Line_Item $line_item)
-    {
-        return $this->_add_relation_to($line_item, 'Line_Item');
-    }
-
-
-    /**
-     * Gets ALL the line items related to this transaction (unstructured)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function line_items($query_params = [])
-    {
-        return $this->get_many_related('Line_Item', $query_params);
-    }
-
-
-    /**
-     * Gets all the line items which are taxes on the total
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_items()
-    {
-        return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other related line items,
-     * meaning it takes them all into account on its total)
-     *
-     * @param bool $create_if_not_found
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
-    {
-        $item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
-        if ($item instanceof EE_Line_Item) {
-            return $item;
-        }
-        return $create_if_not_found
-            ? EEH_Line_Item::create_total_line_item($this)
-            : null;
-    }
-
-
-    /**
-     * Returns the total amount of tax on this transaction
-     * (assumes there's only one tax subtotal line item)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total()
-    {
-        $tax_line_item = $this->tax_total_line_item();
-        if ($tax_line_item) {
-            return (float) $tax_line_item->total();
-        }
-        return (float) 0;
-    }
-
-
-    /**
-     * Gets the tax subtotal line item (assumes there's only one)
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total_line_item()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
-    }
-
-
-    /**
-     * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
-     *
-     * @return EE_Form_Section_Proper|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function billing_info(): ?EE_Form_Section_Proper
-    {
-        $payment_method = $this->payment_method();
-        if (! $payment_method) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Could not find billing info for transaction because no gateway has been used for it yet',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because no primary registration exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $attendee->billing_info_for_payment_method($payment_method);
-    }
-
-
-    /**
-     * Gets PMD_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method_ID()
-    {
-        return $this->get('PMD_ID');
-    }
-
-
-    /**
-     * Sets PMD_ID
-     *
-     * @param int $PMD_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_payment_method_ID($PMD_ID)
-    {
-        $this->set('PMD_ID', $PMD_ID);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method()
-    {
-        $PMD_ID = $this->payment_method_ID();
-        if($PMD_ID) {
-            $pm = EEM_Payment_Method::instance()->get_one_by_ID($this->payment_method_ID());
-            if ($pm instanceof EE_Payment_Method) {
-                return $pm;
-            }
-        }
-        $last_payment = $this->last_payment();
-        if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
-            return $last_payment->payment_method();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the last payment made
-     *
-     * @return EE_Base_Class|EE_Payment|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function last_payment(): ?EE_Payment
-    {
-        return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
-    }
-
-
-    /**
-     * Gets all the line items which are unrelated to tickets on this transaction
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function non_ticket_line_items()
-    {
-        return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
-    }
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @param boolean $update whether to save the TXN
-     * @return bool whether the TXN was saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_status_based_on_total_paid($update = true)
-    {
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
-            $new_txn_status = EEM_Transaction::overpaid_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
-            $new_txn_status = EEM_Transaction::complete_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
-            $new_txn_status = EEM_Transaction::incomplete_status_code;
-        } else {
-            throw new RuntimeException(
-                esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
-            );
-        }
-        if ($new_txn_status !== $this->status_ID()) {
-            $this->set_status($new_txn_status);
-            if ($update) {
-                return (bool) $this->save();
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the transaction's status and total_paid based on all the payments
-     * that apply to it
-     *
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated
-     */
-    public function update_based_on_payments()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_status_updated()
-    {
-        return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
-    }
-
-
-    /**
-     * _reg_steps_completed
-     * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
-     * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
-     * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
-     *
-     * @param string $reg_step_slug
-     * @param bool   $check_all
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
-    {
-        $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
-            return false;
-        }
-        // loop thru reg steps array)
-        foreach ($reg_steps as $slug => $reg_step_completed) {
-            // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
-                // and this is the one
-                if ($slug === $reg_step_slug) {
-                    return $reg_step_completed;
-                }
-                // skip to next reg step in loop
-                continue;
-            }
-            // $check_all must be true, else we would never have gotten to this point
-            if ($slug === $reg_step_slug) {
-                // if we reach this point, then we are testing either:
-                // all_reg_steps_completed_except() or
-                // all_reg_steps_completed_except_final_step(),
-                // and since this is the reg step EXCEPTION being tested
-                // we want to return true (yes true) if this reg step is NOT completed
-                // ie: "is everything completed except the final step?"
-                // "that is correct... the final step is not completed, but all others are."
-                return $reg_step_completed !== true;
-            }
-            if ($reg_step_completed !== true) {
-                // if any reg step is NOT completed, then ALL steps are not completed
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed()
-    {
-        return $this->_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param string $exception
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except($exception = '')
-    {
-        return $this->_reg_steps_completed($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except_final_step()
-    {
-        return $this->_reg_steps_completed('finalize_registration');
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param string $reg_step_slug
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_step_completed($reg_step_slug)
-    {
-        return $this->_reg_steps_completed($reg_step_slug, false);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_reg_step_completed()
-    {
-        return $this->_reg_steps_completed('finalize_registration', false);
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_initiated($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, time());
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, true);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_not_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, false);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
-     *
-     * @param string      $reg_step_slug
-     * @param boolean|int $status
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_reg_step_completed_status($reg_step_slug, $status)
-    {
-        // validate status
-        $status = is_bool($status) || is_int($status)
-            ? $status
-            : false;
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
-            return false;
-        }
-        // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
-            return true;
-        }
-        // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
-            return false;
-        }
-        // if current status value matches the incoming value (no change)
-        // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
-            // this will happen in cases where multiple AJAX requests occur during the same step
-            return true;
-        }
-        // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
-            // skip the update below, but don't return FALSE so that errors won't be displayed
-            return true;
-        }
-        // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
-        $this->set_reg_steps($txn_reg_steps);
-        $this->save();
-        return true;
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param string $reg_step_slug
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_reg_step($reg_step_slug)
-    {
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
-        $this->set_reg_steps($txn_reg_steps);
-    }
-
-
-    /**
-     * toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param bool $save
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_failed_transaction_status($save = true)
-    {
-        // if TXN status is still set as "failed"...
-        if ($this->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->set_status(EEM_Transaction::abandoned_status_code);
-            if ($save) {
-                $this->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_abandoned_transaction_status()
-    {
-        // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-        $txn_status = $this->status_ID();
-        if (
-            $txn_status === EEM_Transaction::failed_status_code
-            || $txn_status === EEM_Transaction::abandoned_status_code
-        ) {
-            // if a contact record for the primary registrant has been created
-            if (
-                $this->primary_registration() instanceof EE_Registration
-                && $this->primary_registration()->attendee() instanceof EE_Attendee
-            ) {
-                $this->set_status(EEM_Transaction::incomplete_status_code);
-            } else {
-                // no contact record? yer abandoned!
-                $this->set_status(EEM_Transaction::abandoned_status_code);
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * checks if an Abandoned TXN has any related payments, and if so,
-     * updates the TXN status based on the amount paid
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function verify_abandoned_transaction_status()
-    {
-        if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
-            return;
-        }
-        $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Payment) {
-                    // kk this TXN should NOT be abandoned
-                    $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-                        EE_Error::add_attention(
-                            sprintf(
-                                esc_html__(
-                                    'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
-                                    'event_espresso'
-                                ),
-                                $this->ID(),
-                                $this->pretty_status()
-                            )
-                        );
-                    }
-                    // get final reg step status
-                    $finalized = $this->final_reg_step_completed();
-                    // if the 'finalize_registration' step has been initiated (has a timestamp)
-                    // but has not yet been fully completed (TRUE)
-                    if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-                        $this->set_reg_step_completed('finalize_registration');
-                        $this->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @since 4.10.4.p
-     */
-    public function recalculateLineItems()
-    {
-        $total_line_item = $this->total_line_item(false);
-        if ($total_line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
-            return EEH_Line_Item::apply_taxes($total_line_item, true);
-        }
-        return false;
-    }
+	/**
+	 * The length of time in seconds that a lock is applied before being considered expired.
+	 * It is not long because a transaction should only be locked for the duration of the request that locked it
+	 */
+	const LOCK_EXPIRATION = 2;
+
+	/**
+	 * txn status upon initial construction.
+	 *
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	private ?EE_Registration $_primary_registrant = null;
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone
+	 *                                        (if not set the timezone set for the website will be used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		$txn        = $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+		if (! $has_object) {
+			$txn->set_old_txn_status($txn->status_ID());
+		}
+		return $txn;
+	}
+
+
+	/**
+	 * @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_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		$txn = new self($props_n_values, true, $timezone);
+		$txn->set_old_txn_status($txn->status_ID());
+		return $txn;
+	}
+
+
+	/**
+	 * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
+	 * If a lock has already been set, then we will attempt to remove it in case it has expired.
+	 * If that also fails, then an exception is thrown.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function lock()
+	{
+		// attempt to set lock, but if that fails...
+		if (! $this->add_extra_meta('lock', time(), true)) {
+			// then attempt to remove the lock in case it is expired
+			if ($this->_remove_expired_lock()) {
+				// if removal was successful, then try setting lock again
+				$this->lock();
+			} else {
+				// but if the lock can not be removed, then throw an exception
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
+							'event_espresso'
+						),
+						$this->ID()
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * removes transaction lock applied in EE_Transaction::lock()
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unlock()
+	{
+		return $this->delete_extra_meta('lock');
+	}
+
+
+	/**
+	 * Decides whether or not now is the right time to update the transaction.
+	 * This is useful because we don't always know if it is safe to update the transaction
+	 * and its related data. why?
+	 * because it's possible that the transaction is being used in another
+	 * request and could overwrite anything we save.
+	 * So we want to only update the txn once we know that won't happen.
+	 * We also check that the lock isn't expired, and remove it if it is
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_locked()
+	{
+		// if TXN is not locked, then return false immediately
+		if (! $this->_get_lock()) {
+			return false;
+		}
+		// if not, then let's try and remove the lock in case it's expired...
+		// _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
+		// and a positive number if the lock was removed (ie: number of locks deleted),
+		// so we need to return the opposite
+		return ! $this->_remove_expired_lock();
+	}
+
+
+	/**
+	 * Gets the meta field indicating that this TXN is locked
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_lock()
+	{
+		return (int) $this->get_extra_meta('lock', true, 0);
+	}
+
+
+	/**
+	 * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _remove_expired_lock()
+	{
+		$locked = $this->_get_lock();
+		if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
+			return $this->unlock();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * Set transaction total
+	 *
+	 * @param float $total total value of transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total = 0.00)
+	{
+		$this->set('TXN_total', (float) $total);
+	}
+
+
+	/**
+	 * Set Total Amount Paid to Date
+	 *
+	 * @param float $total_paid total amount paid to date (sum of all payments)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_paid($total_paid = 0.00)
+	{
+		$this->set('TXN_paid', (float) $total_paid);
+	}
+
+
+	/**
+	 * Set transaction status
+	 *
+	 * @param string $status        whether the transaction is open, declined, accepted,
+	 *                              or any number of custom values that can be set
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_status($status = '')
+	{
+		$this->set('STS_ID', $status);
+	}
+
+
+	/**
+	 * Set hash salt
+	 *
+	 * @param string $hash_salt required for some payment gateways
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_hash_salt($hash_salt = '')
+	{
+		$this->set('TXN_hash_salt', $hash_salt);
+	}
+
+
+	/**
+	 * Sets TXN_reg_steps array
+	 *
+	 * @param array $txn_reg_steps
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_steps(array $txn_reg_steps)
+	{
+		$this->set('TXN_reg_steps', $txn_reg_steps);
+	}
+
+
+	/**
+	 * Gets TXN_reg_steps
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_steps()
+	{
+		$TXN_reg_steps = $this->get('TXN_reg_steps');
+		return is_array($TXN_reg_steps)
+			? $TXN_reg_steps
+			: [];
+	}
+
+
+	/**
+	 * @param string|null $schema
+	 *     Schemas:
+	 *     'localized_float': "3,023.00"
+	 *     'no_currency_code': "$3,023.00"
+	 *     null: "$3,023.00<span>USD</span>"
+	 * @return string of transaction's total cost, with currency symbol and decimal
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_total(?string $schema = null)
+	{
+		return $this->get_pretty('TXN_total', $schema);
+	}
+
+
+	/**
+	 * Gets the amount paid in a pretty string (formatted and with currency symbol)
+	 *
+	 * @param string|null $schema
+	 *     Schemas:
+	 *     'localized_float': "3,023.00"
+	 *     'no_currency_code': "$3,023.00"
+	 *     null: "$3,023.00<span>USD</span>"
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid(?string $schema = null)
+	{
+		return $this->get_pretty('TXN_paid', $schema);
+	}
+
+
+	/**
+	 * calculate the amount remaining for this transaction and return;
+	 *
+	 * @return float amount remaining
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remaining()
+	{
+		return $this->total() - $this->paid();
+	}
+
+
+	/**
+	 * get Transaction Total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return (float) $this->get('TXN_total');
+	}
+
+
+	/**
+	 * get Total Amount Paid to Date
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid()
+	{
+		return (float) $this->get('TXN_paid');
+	}
+
+
+	/**
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_cart_session()
+	{
+		$session_data = (array) $this->get('TXN_session_data');
+		return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
+			? $session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * get Transaction session data
+	 *
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function session_data()
+	{
+		$session_data = $this->get('TXN_session_data');
+		if (empty($session_data)) {
+			$session_data = [
+				'id'            => null,
+				'user_id'       => null,
+				'ip_address'    => null,
+				'user_agent'    => null,
+				'init_access'   => null,
+				'last_access'   => null,
+				'pages_visited' => [],
+			];
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * Set session data within the TXN object
+	 *
+	 * @param EE_Session|array|null $session_data
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_txn_session_data($session_data)
+	{
+		if ($session_data instanceof EE_Session) {
+			$this->set('TXN_session_data', $session_data->get_session_data(null, true));
+		} else {
+			$this->set('TXN_session_data', $session_data);
+		}
+	}
+
+
+	/**
+	 * get Transaction hash salt
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function hash_salt_()
+	{
+		return $this->get('TXN_hash_salt');
+	}
+
+
+	/**
+	 * Returns the transaction datetime as either:
+	 *            - unix timestamp format ($format = false, $gmt = true)
+	 *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
+	 *              has no affect with this option)), this also may include a timezone abbreviation if the
+	 *              set timezone in this class differs from what the timezone is on the blog.
+	 *            - formatted date string including the UTC (timezone) offset (default).
+	 *
+	 * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
+	 * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
+	 *                          or no UTC offset applied
+	 * @return string | int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime($format = false, $gmt = false)
+	{
+		if ($format) {
+			return $this->get_pretty('TXN_timestamp');
+		}
+		if ($gmt) {
+			return $this->get_raw('TXN_timestamp');
+		}
+		return $this->get('TXN_timestamp');
+	}
+
+
+	/**
+	 * Gets registrations on this transaction
+	 *
+	 * @param array   $query_params array of query parameters
+	 * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registrations($query_params = [], $get_cached = false)
+	{
+		$query_params = (empty($query_params) || ! is_array($query_params))
+			? [
+				'order_by' => [
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+					'REG_ID'             => 'ASC',
+				],
+			]
+			: $query_params;
+		$query_params = $get_cached
+			? []
+			: $query_params;
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
+	 * function for getting attendees and how many registrations they each have for an event)
+	 *
+	 * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendees()
+	{
+		return $this->get_many_related('Attendee', [['Registration.Transaction.TXN_ID' => $this->ID()]]);
+	}
+
+
+	/**
+	 * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = [])
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * gets only approved payments for this transaction
+	 *
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function approved_payments()
+	{
+		EE_Registry::instance()->load_model('Payment');
+		return $this->get_many_related(
+			'Payment',
+			[
+				['STS_ID' => EEM_Payment::status_id_approved],
+				'order_by' => ['PAY_timestamp' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all payments which have not been approved
+	 *
+	 * @return EE_Base_Class[]|EEI_Payment[]
+	 * @throws EE_Error if a model is misconfigured somehow
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pending_payments()
+	{
+		return $this->get_many_related(
+			'Payment',
+			[
+				[
+					'STS_ID' => EEM_Payment::status_id_pending,
+				],
+				'order_by' => [
+					'PAY_timestamp' => 'DESC',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$this->status_ID() => esc_html__('unknown', 'event_espresso')],
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Transaction::complete_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::incomplete_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::abandoned_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::failed_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::overpaid_status_code:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 * get Transaction Status
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Returns TRUE or FALSE for whether or not this transaction cost any money
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_free()
+	{
+		return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
+	}
+
+
+	/**
+	 * Returns whether this transaction is complete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_completed()
+	{
+		return $this->status_ID() === EEM_Transaction::complete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is incomplete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Transaction::incomplete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is overpaid
+	 * Useful in templates and other logic for deciding if monies need to be refunded
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_overpaid()
+	{
+		return $this->status_ID() === EEM_Transaction::overpaid_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction was abandoned
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * but that contact information exists for at least one registrant
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_abandoned()
+	{
+		return $this->status_ID() === EEM_Transaction::abandoned_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction failed
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * and that NO contact information exists for any registrants
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function failed()
+	{
+		return $this->status_ID() === EEM_Transaction::failed_status_code;
+	}
+
+
+	/**
+	 * This returns the url for the invoice of this transaction
+	 *
+	 * @param string $type 'html' or 'pdf' (default is pdf)
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function invoice_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->invoice_url($type);
+	}
+
+
+	/**
+	 * Gets the primary registration only
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function primary_registration()
+	{
+		if ($this->_primary_registrant instanceof EE_Registration) {
+			return $this->_primary_registrant;
+		}
+
+		$registrations = (array) $this->get_many_related(
+			'Registration',
+			[['REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT]]
+		);
+		foreach ($registrations as $registration) {
+			// valid registration that is NOT cancelled or declined ?
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
+			) {
+				$this->_primary_registrant = $registration;
+				return $registration;
+			}
+		}
+		// nothing valid found, so just return first thing from array of results
+		$primary_registrant = reset($registrations);
+		$this->_primary_registrant = $primary_registrant instanceof EE_Registration ? $primary_registrant : null;
+		return $this->_primary_registrant;
+	}
+
+
+	/**
+	 * Gets the URL for viewing the receipt
+	 *
+	 * @param string $type 'pdf' or 'html' (default is 'html')
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function receipt_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->receipt_url($type);
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url()
+	{
+		$primary_registration = $this->primary_registration();
+		return $primary_registration instanceof EE_Registration
+			? $primary_registration->payment_overview_url()
+			: false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function gateway_response_on_transaction()
+	{
+		$payment = $this->get_first_related('Payment');
+		return $payment instanceof EE_Payment
+			? $payment->gateway_response()
+			: '';
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function extra_meta($query_params = [])
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_registration(EE_Registration $registration)
+	{
+		return $this->_add_relation_to($registration, 'Registration');
+	}
+
+
+	/**
+	 * Removes the given registration from being related (even before saving this transaction).
+	 * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
+	 *
+	 * @param int $registration_or_id
+	 * @return EE_Base_Class that was removed from being related
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_registration_with_id($registration_or_id)
+	{
+		return $this->_remove_relation_to($registration_or_id, 'Registration');
+	}
+
+
+	/**
+	 * Gets all the line items which are for ACTUAL items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function items_purchased()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_line_item]]);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_line_item(EE_Line_Item $line_item)
+	{
+		return $this->_add_relation_to($line_item, 'Line_Item');
+	}
+
+
+	/**
+	 * Gets ALL the line items related to this transaction (unstructured)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function line_items($query_params = [])
+	{
+		return $this->get_many_related('Line_Item', $query_params);
+	}
+
+
+	/**
+	 * Gets all the line items which are taxes on the total
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_items()
+	{
+		return $this->line_items([['LIN_type' => EEM_Line_Item::type_tax]]);
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other related line items,
+	 * meaning it takes them all into account on its total)
+	 *
+	 * @param bool $create_if_not_found
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_line_item(bool $create_if_not_found = true): ?EE_Line_Item
+	{
+		$item = $this->get_first_related('Line_Item', [['LIN_type' => EEM_Line_Item::type_total]]);
+		if ($item instanceof EE_Line_Item) {
+			return $item;
+		}
+		return $create_if_not_found
+			? EEH_Line_Item::create_total_line_item($this)
+			: null;
+	}
+
+
+	/**
+	 * Returns the total amount of tax on this transaction
+	 * (assumes there's only one tax subtotal line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total()
+	{
+		$tax_line_item = $this->tax_total_line_item();
+		if ($tax_line_item) {
+			return (float) $tax_line_item->total();
+		}
+		return (float) 0;
+	}
+
+
+	/**
+	 * Gets the tax subtotal line item (assumes there's only one)
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total_line_item()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
+	}
+
+
+	/**
+	 * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
+	 *
+	 * @return EE_Form_Section_Proper|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function billing_info(): ?EE_Form_Section_Proper
+	{
+		$payment_method = $this->payment_method();
+		if (! $payment_method) {
+			EE_Error::add_error(
+				esc_html__(
+					'Could not find billing info for transaction because no gateway has been used for it yet',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$primary_reg = $this->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because no primary registration exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $attendee->billing_info_for_payment_method($payment_method);
+	}
+
+
+	/**
+	 * Gets PMD_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method_ID()
+	{
+		return $this->get('PMD_ID');
+	}
+
+
+	/**
+	 * Sets PMD_ID
+	 *
+	 * @param int $PMD_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_payment_method_ID($PMD_ID)
+	{
+		$this->set('PMD_ID', $PMD_ID);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method()
+	{
+		$PMD_ID = $this->payment_method_ID();
+		if($PMD_ID) {
+			$pm = EEM_Payment_Method::instance()->get_one_by_ID($this->payment_method_ID());
+			if ($pm instanceof EE_Payment_Method) {
+				return $pm;
+			}
+		}
+		$last_payment = $this->last_payment();
+		if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
+			return $last_payment->payment_method();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the last payment made
+	 *
+	 * @return EE_Base_Class|EE_Payment|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function last_payment(): ?EE_Payment
+	{
+		return $this->get_first_related('Payment', ['order_by' => ['PAY_ID' => 'desc']]);
+	}
+
+
+	/**
+	 * Gets all the line items which are unrelated to tickets on this transaction
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function non_ticket_line_items()
+	{
+		return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
+	}
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @param boolean $update whether to save the TXN
+	 * @return bool whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_status_based_on_total_paid($update = true)
+	{
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
+			$new_txn_status = EEM_Transaction::overpaid_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
+			$new_txn_status = EEM_Transaction::complete_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
+			$new_txn_status = EEM_Transaction::incomplete_status_code;
+		} else {
+			throw new RuntimeException(
+				esc_html__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
+			);
+		}
+		if ($new_txn_status !== $this->status_ID()) {
+			$this->set_status($new_txn_status);
+			if ($update) {
+				return (bool) $this->save();
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the transaction's status and total_paid based on all the payments
+	 * that apply to it
+	 *
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated
+	 */
+	public function update_based_on_payments()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_status_updated()
+	{
+		return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
+	}
+
+
+	/**
+	 * _reg_steps_completed
+	 * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
+	 * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
+	 * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
+	 *
+	 * @param string $reg_step_slug
+	 * @param bool   $check_all
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
+	{
+		$reg_steps = $this->reg_steps();
+		if (! is_array($reg_steps) || empty($reg_steps)) {
+			return false;
+		}
+		// loop thru reg steps array)
+		foreach ($reg_steps as $slug => $reg_step_completed) {
+			// if NOT checking ALL steps (only checking one step)
+			if (! $check_all) {
+				// and this is the one
+				if ($slug === $reg_step_slug) {
+					return $reg_step_completed;
+				}
+				// skip to next reg step in loop
+				continue;
+			}
+			// $check_all must be true, else we would never have gotten to this point
+			if ($slug === $reg_step_slug) {
+				// if we reach this point, then we are testing either:
+				// all_reg_steps_completed_except() or
+				// all_reg_steps_completed_except_final_step(),
+				// and since this is the reg step EXCEPTION being tested
+				// we want to return true (yes true) if this reg step is NOT completed
+				// ie: "is everything completed except the final step?"
+				// "that is correct... the final step is not completed, but all others are."
+				return $reg_step_completed !== true;
+			}
+			if ($reg_step_completed !== true) {
+				// if any reg step is NOT completed, then ALL steps are not completed
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed()
+	{
+		return $this->_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param string $exception
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except($exception = '')
+	{
+		return $this->_reg_steps_completed($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except_final_step()
+	{
+		return $this->_reg_steps_completed('finalize_registration');
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param string $reg_step_slug
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_step_completed($reg_step_slug)
+	{
+		return $this->_reg_steps_completed($reg_step_slug, false);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_reg_step_completed()
+	{
+		return $this->_reg_steps_completed('finalize_registration', false);
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_initiated($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, time());
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, true);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_not_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, false);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
+	 *
+	 * @param string      $reg_step_slug
+	 * @param boolean|int $status
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_reg_step_completed_status($reg_step_slug, $status)
+	{
+		// validate status
+		$status = is_bool($status) || is_int($status)
+			? $status
+			: false;
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		// if reg step does NOT exist
+		if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+			return false;
+		}
+		// if  we're trying to complete a step that is already completed
+		if ($txn_reg_steps[ $reg_step_slug ] === true) {
+			return true;
+		}
+		// if  we're trying to complete a step that hasn't even started
+		if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+			return false;
+		}
+		// if current status value matches the incoming value (no change)
+		// type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
+		if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+			// this will happen in cases where multiple AJAX requests occur during the same step
+			return true;
+		}
+		// if we're trying to set a start time, but it has already been set...
+		if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+			// skip the update below, but don't return FALSE so that errors won't be displayed
+			return true;
+		}
+		// update completed status
+		$txn_reg_steps[ $reg_step_slug ] = $status;
+		$this->set_reg_steps($txn_reg_steps);
+		$this->save();
+		return true;
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param string $reg_step_slug
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_reg_step($reg_step_slug)
+	{
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		unset($txn_reg_steps[ $reg_step_slug ]);
+		$this->set_reg_steps($txn_reg_steps);
+	}
+
+
+	/**
+	 * toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param bool $save
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_failed_transaction_status($save = true)
+	{
+		// if TXN status is still set as "failed"...
+		if ($this->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->set_status(EEM_Transaction::abandoned_status_code);
+			if ($save) {
+				$this->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_abandoned_transaction_status()
+	{
+		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
+		$txn_status = $this->status_ID();
+		if (
+			$txn_status === EEM_Transaction::failed_status_code
+			|| $txn_status === EEM_Transaction::abandoned_status_code
+		) {
+			// if a contact record for the primary registrant has been created
+			if (
+				$this->primary_registration() instanceof EE_Registration
+				&& $this->primary_registration()->attendee() instanceof EE_Attendee
+			) {
+				$this->set_status(EEM_Transaction::incomplete_status_code);
+			} else {
+				// no contact record? yer abandoned!
+				$this->set_status(EEM_Transaction::abandoned_status_code);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * checks if an Abandoned TXN has any related payments, and if so,
+	 * updates the TXN status based on the amount paid
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function verify_abandoned_transaction_status()
+	{
+		if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
+			return;
+		}
+		$payments = $this->get_many_related('Payment');
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Payment) {
+					// kk this TXN should NOT be abandoned
+					$this->update_status_based_on_total_paid();
+					if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+						EE_Error::add_attention(
+							sprintf(
+								esc_html__(
+									'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
+									'event_espresso'
+								),
+								$this->ID(),
+								$this->pretty_status()
+							)
+						);
+					}
+					// get final reg step status
+					$finalized = $this->final_reg_step_completed();
+					// if the 'finalize_registration' step has been initiated (has a timestamp)
+					// but has not yet been fully completed (TRUE)
+					if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+						$this->set_reg_step_completed('finalize_registration');
+						$this->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @since 4.10.4.p
+	 */
+	public function recalculateLineItems()
+	{
+		$total_line_item = $this->total_line_item(false);
+		if ($total_line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
+			return EEH_Line_Item::apply_taxes($total_line_item, true);
+		}
+		return false;
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -47,7 +47,7 @@ 
         $txn        = $has_object
             ? $has_object
             : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
+        if ( ! $has_object) {
             $txn->set_old_txn_status($txn->status_ID());
         }
         return $txn;
@@ -87,7 +87,7 @@ 
     public function lock()
     {
         // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
+        if ( ! $this->add_extra_meta('lock', time(), true)) {
             // then attempt to remove the lock in case it is expired
             if ($this->_remove_expired_lock()) {
                 // if removal was successful, then try setting lock again
@@ -143,7 +143,7 @@ 
     public function is_locked()
     {
         // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
+        if ( ! $this->_get_lock()) {
             return false;
         }
         // if not, then let's try and remove the lock in case it's expired...
@@ -638,7 +638,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case EEM_Transaction::complete_status_code:
                 $icon = $show_icons
@@ -666,7 +666,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -804,7 +804,7 @@ 
     public function invoice_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->invoice_url($type);
@@ -863,7 +863,7 @@ 
     public function receipt_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->receipt_url($type);
@@ -1116,7 +1116,7 @@ 
     public function billing_info(): ?EE_Form_Section_Proper
     {
         $payment_method = $this->payment_method();
-        if (! $payment_method) {
+        if ( ! $payment_method) {
             EE_Error::add_error(
                 esc_html__(
                     'Could not find billing info for transaction because no gateway has been used for it yet',
@@ -1129,7 +1129,7 @@ 
             return null;
         }
         $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot get billing info for gateway %s on transaction because no primary registration exists',
@@ -1142,7 +1142,7 @@ 
             return null;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
@@ -1205,7 +1205,7 @@ 
     public function payment_method()
     {
         $PMD_ID = $this->payment_method_ID();
-        if($PMD_ID) {
+        if ($PMD_ID) {
             $pm = EEM_Payment_Method::instance()->get_one_by_ID($this->payment_method_ID());
             if ($pm instanceof EE_Payment_Method) {
                 return $pm;
@@ -1302,7 +1302,7 @@ 
     public function update_based_on_payments()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -1370,13 +1370,13 @@ 
     private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
     {
         $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
+        if ( ! is_array($reg_steps) || empty($reg_steps)) {
             return false;
         }
         // loop thru reg steps array)
         foreach ($reg_steps as $slug => $reg_step_completed) {
             // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
+            if ( ! $check_all) {
                 // and this is the one
                 if ($slug === $reg_step_slug) {
                     return $reg_step_completed;
@@ -1581,30 +1581,30 @@ 
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
         // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+        if ( ! isset($txn_reg_steps[$reg_step_slug])) {
             return false;
         }
         // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
+        if ($txn_reg_steps[$reg_step_slug] === true) {
             return true;
         }
         // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+        if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
             return false;
         }
         // if current status value matches the incoming value (no change)
         // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+        if ((int) $txn_reg_steps[$reg_step_slug] === (int) $status) {
             // this will happen in cases where multiple AJAX requests occur during the same step
             return true;
         }
         // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+        if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
             // skip the update below, but don't return FALSE so that errors won't be displayed
             return true;
         }
         // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
+        $txn_reg_steps[$reg_step_slug] = $status;
         $this->set_reg_steps($txn_reg_steps);
         $this->save();
         return true;
@@ -1628,7 +1628,7 @@ 
     {
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
+        unset($txn_reg_steps[$reg_step_slug]);
         $this->set_reg_steps($txn_reg_steps);
     }
 
@@ -1713,12 +1713,12 @@ 
             return;
         }
         $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Payment) {
                     // kk this TXN should NOT be abandoned
                     $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+                    if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
                         EE_Error::add_attention(
                             sprintf(
                                 esc_html__(

core/db_classes/EE_Payment.class.php

Indentation +873 added lines, -873 removed lines

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

core/data_migration_scripts/4_7_0_stages/EE_DMS_4_7_0_Registration_Payments.dmsstage.php

Indentation +214 added lines, -214 removed lines

@@ -10,218 +10,218 @@
 class EE_DMS_4_7_0_Registration_Payments extends EE_Data_Migration_Script_Stage_Table
 {
 
-    protected string $_payment_table;
-
-    protected string $_registration_table;
-
-    protected string $_registration_payment_table;
-
-
-    public function __construct()
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $this->_pretty_name = esc_html__('Registration Payment Record Generation', 'event_espresso');
-        // define tables
-        $this->_old_table                  = $wpdb->prefix . 'esp_transaction';
-        $this->_payment_table              = $wpdb->prefix . 'esp_payment';
-        $this->_registration_table         = $wpdb->prefix . 'esp_registration';
-        $this->_registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        // build SQL WHERE clauses
-        $this->_extra_where_sql = "WHERE STS_ID IN ( 'TIN', 'TCM' ) AND TXN_Total != '0.000'";
-        parent::__construct();
-    }
-
-
-    /**
-     * @param array $old_row
-     * @return void
-     */
-    protected function _migrate_old_row($old_row)
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $TXN_ID = absint($old_row['TXN_ID']);
-        if (! $TXN_ID) {
-            $this->add_error(
-                sprintf(
-                    esc_html__('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
-                    $TXN_ID,
-                    $wpdb->last_error
-                )
-            );
-            return;
-        }
-        // get all payments for the TXN
-        $payments = $this->_get_payments($TXN_ID);
-        if (empty($payments)) {
-            return;
-        }
-        // then the registrants
-        $registrations = $this->_get_registrations($TXN_ID);
-        if (empty($registrations)) {
-            return;
-        }
-        // now loop thru each payment and apply it to each of the registrations
-        foreach ($payments as $payment) {
-            if ($payment->STS_ID === 'PAP' && $payment->PAY_amount > 0) {
-                $this->_process_registration_payments($payment, $registrations);
-            }
-        }
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @param int $TXN_ID
-     * @return array
-     */
-    protected function _get_registrations(int $TXN_ID): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $SQL = "SELECT * FROM $this->_registration_table WHERE TXN_ID = %d AND STS_ID IN ( 'RPP', 'RAP' )";
-        return $wpdb->get_results($wpdb->prepare($SQL, $TXN_ID), OBJECT_K);
-    }
-
-
-    /**
-     * _get_payments
-     *
-     * @param int $TXN_ID
-     * @return array
-     */
-    protected function _get_payments(int $TXN_ID): array
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        return $wpdb->get_results(
-            $wpdb->prepare("SELECT * FROM $this->_payment_table WHERE TXN_ID = %d", $TXN_ID),
-            OBJECT_K
-        );
-    }
-
-
-    /**
-     * _get_possibly_updated_REG_paid
-     *
-     * @param int $REG_ID
-     * @return float
-     */
-    protected function _get_possibly_updated_REG_paid(int $REG_ID): float
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        return (float) $wpdb->get_var(
-            $wpdb->prepare("SELECT REG_paid FROM $this->_registration_table WHERE REG_ID = %d", $REG_ID)
-        );
-    }
-
-
-    /**
-     * _process_registration_payments
-     * basically a copy of the "Sequential Registration Payment Application Strategy"  logic
-     * currently in EventEspresso\core\services\payments\RegistrationPayments::processRegistrationPayments()
-     *
-     * @param stdClass $payment
-     * @param array    $registrations
-     * @return void
-     */
-    protected function _process_registration_payments(stdClass $payment, array $registrations = [])
-    {
-        // how much is available to apply to registrations?
-        $available_payment_amount = $payment->PAY_amount;
-        foreach ($registrations as $REG_ID => $registration) {
-            // nothing left, then we are done here?
-            if (! $available_payment_amount > 0) {
-                break;
-            }
-            // ensure REG_final_price has a valid value, and skip if it turns out to be zero
-            $registration->REG_final_price =
-                ! empty($registration->REG_final_price) ? (float) $registration->REG_final_price : 0.00;
-            if (! $registration->REG_final_price > 0) {
-                continue;
-            }
-            // because REG_paid may have been updated by a previous payment, we need to retrieve the value from the db
-            $registration->REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
-            // calculate amount owing, and skip if it turns out to be zero
-            $owing = $registration->REG_final_price - $registration->REG_paid;
-            if (! $owing > 0) {
-                continue;
-            }
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount = $available_payment_amount - $payment_amount;
-            // add relation between registration and payment and set amount
-            if ($this->_insert_registration_payment($registration->REG_ID, $payment->PAY_ID, (float) $payment_amount)) {
-                // calculate and set new REG_paid
-                $registration->REG_paid = $registration->REG_paid + $payment_amount;
-                $this->_update_registration_paid($registration->REG_ID, (float) $registration->REG_paid);
-            }
-        }
-    }
-
-
-    /**
-     * _insert_registration_payment
-     *
-     * @param int   $REG_ID
-     * @param int   $PAY_ID
-     * @param float $PAY_amount
-     * @return bool
-     */
-    protected function _insert_registration_payment(int $REG_ID = 0, int $PAY_ID = 0, float $PAY_amount = 0.00): bool
-    {
-        global $wpdb;
-        $success = $wpdb->insert(
-            $this->_registration_payment_table,
-            ['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,],  // data
-            ['%f']                                                                     // data format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not update registration paid value for registration ID=%1$d because "%2$s"',
-                        'event_espresso'
-                    ),
-                    $REG_ID,
-                    $wpdb->last_error
-                )
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _update_registration_paid
-     *
-     * @param int   $REG_ID
-     * @param float $REG_paid
-     * @return bool
-     */
-    protected function _update_registration_paid(int $REG_ID = 0, float $REG_paid = 0.00): bool
-    {
-        /** @type WPDB $wpdb */ global $wpdb;
-        $success = $wpdb->update(
-            $this->_registration_table,
-            ['REG_paid' => $REG_paid],  // data
-            ['REG_ID' => $REG_ID],      // where
-            ['%f'],                     // data format
-            ['%d']                      // where format
-        );
-        if ($success === false) {
-            $this->add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not update registration paid value for registration ID=%1$d because "%2$s"',
-                        'event_espresso'
-                    ),
-                    $REG_ID,
-                    $wpdb->last_error
-                )
-            );
-            return false;
-        }
-        return true;
-    }
+	protected string $_payment_table;
+
+	protected string $_registration_table;
+
+	protected string $_registration_payment_table;
+
+
+	public function __construct()
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$this->_pretty_name = esc_html__('Registration Payment Record Generation', 'event_espresso');
+		// define tables
+		$this->_old_table                  = $wpdb->prefix . 'esp_transaction';
+		$this->_payment_table              = $wpdb->prefix . 'esp_payment';
+		$this->_registration_table         = $wpdb->prefix . 'esp_registration';
+		$this->_registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		// build SQL WHERE clauses
+		$this->_extra_where_sql = "WHERE STS_ID IN ( 'TIN', 'TCM' ) AND TXN_Total != '0.000'";
+		parent::__construct();
+	}
+
+
+	/**
+	 * @param array $old_row
+	 * @return void
+	 */
+	protected function _migrate_old_row($old_row)
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$TXN_ID = absint($old_row['TXN_ID']);
+		if (! $TXN_ID) {
+			$this->add_error(
+				sprintf(
+					esc_html__('Invalid transaction with ID=%1$d. Error: "%2$s"', 'event_espresso'),
+					$TXN_ID,
+					$wpdb->last_error
+				)
+			);
+			return;
+		}
+		// get all payments for the TXN
+		$payments = $this->_get_payments($TXN_ID);
+		if (empty($payments)) {
+			return;
+		}
+		// then the registrants
+		$registrations = $this->_get_registrations($TXN_ID);
+		if (empty($registrations)) {
+			return;
+		}
+		// now loop thru each payment and apply it to each of the registrations
+		foreach ($payments as $payment) {
+			if ($payment->STS_ID === 'PAP' && $payment->PAY_amount > 0) {
+				$this->_process_registration_payments($payment, $registrations);
+			}
+		}
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @param int $TXN_ID
+	 * @return array
+	 */
+	protected function _get_registrations(int $TXN_ID): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$SQL = "SELECT * FROM $this->_registration_table WHERE TXN_ID = %d AND STS_ID IN ( 'RPP', 'RAP' )";
+		return $wpdb->get_results($wpdb->prepare($SQL, $TXN_ID), OBJECT_K);
+	}
+
+
+	/**
+	 * _get_payments
+	 *
+	 * @param int $TXN_ID
+	 * @return array
+	 */
+	protected function _get_payments(int $TXN_ID): array
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		return $wpdb->get_results(
+			$wpdb->prepare("SELECT * FROM $this->_payment_table WHERE TXN_ID = %d", $TXN_ID),
+			OBJECT_K
+		);
+	}
+
+
+	/**
+	 * _get_possibly_updated_REG_paid
+	 *
+	 * @param int $REG_ID
+	 * @return float
+	 */
+	protected function _get_possibly_updated_REG_paid(int $REG_ID): float
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		return (float) $wpdb->get_var(
+			$wpdb->prepare("SELECT REG_paid FROM $this->_registration_table WHERE REG_ID = %d", $REG_ID)
+		);
+	}
+
+
+	/**
+	 * _process_registration_payments
+	 * basically a copy of the "Sequential Registration Payment Application Strategy"  logic
+	 * currently in EventEspresso\core\services\payments\RegistrationPayments::processRegistrationPayments()
+	 *
+	 * @param stdClass $payment
+	 * @param array    $registrations
+	 * @return void
+	 */
+	protected function _process_registration_payments(stdClass $payment, array $registrations = [])
+	{
+		// how much is available to apply to registrations?
+		$available_payment_amount = $payment->PAY_amount;
+		foreach ($registrations as $REG_ID => $registration) {
+			// nothing left, then we are done here?
+			if (! $available_payment_amount > 0) {
+				break;
+			}
+			// ensure REG_final_price has a valid value, and skip if it turns out to be zero
+			$registration->REG_final_price =
+				! empty($registration->REG_final_price) ? (float) $registration->REG_final_price : 0.00;
+			if (! $registration->REG_final_price > 0) {
+				continue;
+			}
+			// because REG_paid may have been updated by a previous payment, we need to retrieve the value from the db
+			$registration->REG_paid = $this->_get_possibly_updated_REG_paid($REG_ID);
+			// calculate amount owing, and skip if it turns out to be zero
+			$owing = $registration->REG_final_price - $registration->REG_paid;
+			if (! $owing > 0) {
+				continue;
+			}
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount = $available_payment_amount - $payment_amount;
+			// add relation between registration and payment and set amount
+			if ($this->_insert_registration_payment($registration->REG_ID, $payment->PAY_ID, (float) $payment_amount)) {
+				// calculate and set new REG_paid
+				$registration->REG_paid = $registration->REG_paid + $payment_amount;
+				$this->_update_registration_paid($registration->REG_ID, (float) $registration->REG_paid);
+			}
+		}
+	}
+
+
+	/**
+	 * _insert_registration_payment
+	 *
+	 * @param int   $REG_ID
+	 * @param int   $PAY_ID
+	 * @param float $PAY_amount
+	 * @return bool
+	 */
+	protected function _insert_registration_payment(int $REG_ID = 0, int $PAY_ID = 0, float $PAY_amount = 0.00): bool
+	{
+		global $wpdb;
+		$success = $wpdb->insert(
+			$this->_registration_payment_table,
+			['REG_ID' => $REG_ID, 'PAY_ID' => $PAY_ID, 'RPY_amount' => $PAY_amount,],  // data
+			['%f']                                                                     // data format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not update registration paid value for registration ID=%1$d because "%2$s"',
+						'event_espresso'
+					),
+					$REG_ID,
+					$wpdb->last_error
+				)
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _update_registration_paid
+	 *
+	 * @param int   $REG_ID
+	 * @param float $REG_paid
+	 * @return bool
+	 */
+	protected function _update_registration_paid(int $REG_ID = 0, float $REG_paid = 0.00): bool
+	{
+		/** @type WPDB $wpdb */ global $wpdb;
+		$success = $wpdb->update(
+			$this->_registration_table,
+			['REG_paid' => $REG_paid],  // data
+			['REG_ID' => $REG_ID],      // where
+			['%f'],                     // data format
+			['%d']                      // where format
+		);
+		if ($success === false) {
+			$this->add_error(
+				sprintf(
+					esc_html__(
+						'Could not update registration paid value for registration ID=%1$d because "%2$s"',
+						'event_espresso'
+					),
+					$REG_ID,
+					$wpdb->last_error
+				)
+			);
+			return false;
+		}
+		return true;
+	}
 }

core/EE_Dependency_Map.core.php

Indentation +1194 added lines, -1194 removed lines

@@ -20,1198 +20,1198 @@
  */
 class EE_Dependency_Map
 {
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * When registering a dependency,
-     * this indicates to keep any existing dependencies that already exist,
-     * and simply discard any new dependencies declared in the incoming data
-     */
-    const KEEP_EXISTING_DEPENDENCIES = 0;
-
-    /**
-     * When registering a dependency,
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
-     */
-    const OVERWRITE_DEPENDENCIES = 1;
-
-    protected static ?EE_Dependency_Map $_instance = null;
-
-    private ClassInterfaceCache $class_cache;
-
-    protected ?RequestInterface $request = null;
-
-    protected ?LegacyRequestInterface $legacy_request = null;
-
-    protected ?ResponseInterface $response = null;
-
-    protected ?LoaderInterface $loader = null;
-
-    protected array $_dependency_map = [];
-
-    protected array $_class_loaders = [];
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    protected function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-        do_action('EE_Dependency_Map____construct', $this);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidAliasException
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param ClassInterfaceCache|null $class_cache
-     * @return EE_Dependency_Map
-     */
-    public static function instance(ClassInterfaceCache $class_cache = null): EE_Dependency_Map
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (
-            ! EE_Dependency_Map::$_instance instanceof EE_Dependency_Map
-            && $class_cache instanceof ClassInterfaceCache
-        ) {
-            EE_Dependency_Map::$_instance = new EE_Dependency_Map($class_cache);
-        }
-        return EE_Dependency_Map::$_instance;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param LegacyRequestInterface $legacy_request
-     */
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
-    {
-        $this->legacy_request = $legacy_request;
-    }
-
-
-    /**
-     * @param ResponseInterface $response
-     */
-    public function setResponse(ResponseInterface $response)
-    {
-        $this->response = $response;
-    }
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public static function register_dependencies(
-        string $class,
-        array $dependencies,
-        int $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ): bool {
-        return EE_Dependency_Map::$_instance->registerDependencies($class, $dependencies, $overwrite);
-    }
-
-
-    /**
-     * Assigns an array of class names and corresponding load sources (new or cached)
-     * to the class specified by the first parameter.
-     * IMPORTANT !!!
-     * The order of elements in the incoming $dependencies array MUST match
-     * the order of the constructor parameters for the class in question.
-     * This is especially important when overriding any existing dependencies that are registered.
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
-     *
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public function registerDependencies(
-        string $class,
-        array $dependencies,
-        int $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ): bool {
-        if (empty($dependencies)) {
-            return false;
-        }
-        $class      = trim($class, '\\');
-        $registered = false;
-        if (empty(EE_Dependency_Map::$_instance->_dependency_map[ $class ])) {
-            EE_Dependency_Map::$_instance->_dependency_map[ $class ] = [];
-        }
-        // we need to make sure that any aliases used when registering a dependency
-        // get resolved to the correct class name
-        foreach ($dependencies as $dependency => $load_source) {
-            $alias = EE_Dependency_Map::$_instance->getFqnForAlias($dependency);
-            if (
-                $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(
-                    EE_Dependency_Map::$_instance->_dependency_map[ $class ][ $dependency ],
-                    EE_Dependency_Map::$_instance->_dependency_map[ $class ][ $alias ]
-                )
-            ) {
-                unset($dependencies[ $dependency ]);
-                $dependencies[ $alias ] = $load_source;
-                $registered             = true;
-            }
-        }
-        // now add our two lists of dependencies together.
-        // using Union (+=) favours the arrays in precedence from left to right,
-        // so $dependencies is NOT overwritten because it is listed first
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
-        // Union is way faster than array_merge() but should be used with caution...
-        // especially with numerically indexed arrays
-        $dependencies += EE_Dependency_Map::$_instance->_dependency_map[ $class ];
-        // now we need to ensure that the resulting dependencies
-        // array only has the entries that are required for the class
-        // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(EE_Dependency_Map::$_instance->_dependency_map[ $class ]);
-        // if that count is non-zero (meaning dependencies were already registered)
-        EE_Dependency_Map::$_instance->_dependency_map[ $class ] = $dependency_count
-            // then truncate the  final array to match that count
-            ? array_slice($dependencies, 0, $dependency_count)
-            // otherwise just take the incoming array because nothing previously existed
-            : $dependencies;
-        return $registered
-            || count(EE_Dependency_Map::$_instance->_dependency_map[ $class ]) === count($dependencies);
-    }
-
-
-    /**
-     * @param string          $class_name
-     * @param callable|string $loader
-     * @param bool            $overwrite
-     * @return bool
-     * @throws DomainException
-     */
-    public static function register_class_loader(
-        string $class_name,
-        $loader = 'load_core',
-        bool $overwrite = false
-    ): bool {
-        return EE_Dependency_Map::$_instance->registerClassLoader($class_name, $loader, $overwrite);
-    }
-
-
-    /**
-     * @param string         $class_name
-     * @param Closure|string $loader
-     * @param bool           $overwrite
-     * @return bool
-     * @throws DomainException
-     */
-    public function registerClassLoader(string $class_name, $loader = 'load_core', bool $overwrite = false): bool
-    {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
-            throw new DomainException(
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
-            );
-        }
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (
-            ! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid loader method on EE_Registry.',
-                        'event_espresso'
-                    ),
-                    $loader
-                )
-            );
-        }
-        $class_name = EE_Dependency_Map::$_instance->getFqnForAlias($class_name);
-        if ($overwrite || ! isset(EE_Dependency_Map::$_instance->_class_loaders[ $class_name ])) {
-            EE_Dependency_Map::$_instance->_class_loaders[ $class_name ] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map(): array
-    {
-        return $this->_dependency_map;
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has(string $class_name = ''): bool
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        return isset($this->_dependency_map[ $class_name ]);
-    }
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class(string $class_name = '', string $dependency = ''): bool
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency, $class_name);
-        return isset($this->_dependency_map[ $class_name ][ $dependency ]);
-    }
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency(string $class_name = '', string $dependency = ''): int
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->getFqnForAlias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[ $class_name ][ $dependency ]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader(string $class_name)
-    {
-        // all legacy models use load_model()
-        if (strpos($class_name, 'EEM_') === 0) {
-            return 'load_model';
-        }
-        // EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
-        // perform strpos() first to avoid loading regex every time we load a class
-        if (
-            strpos($class_name, 'EE_CPT_') === 0
-            && preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
-        ) {
-            return 'load_core';
-        }
-        $class_name = $this->getFqnForAlias($class_name);
-        return $this->_class_loaders[ $class_name ] ?? '';
-    }
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders(): array
-    {
-        return $this->_class_loaders;
-    }
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $fqcn      the class name that should be used (concrete class to replace interface)
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
-     * @throws InvalidAliasException
-     */
-    public function add_alias(string $fqcn, string $alias, string $for_class = '')
-    {
-        $this->class_cache->addAlias($fqcn, $alias, $for_class);
-    }
-
-
-    /**
-     * Returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function isAlias(string $fqn = '', string $for_class = ''): bool
-    {
-        return $this->class_cache->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function getFqnForAlias(string $alias = '', string $for_class = ''): string
-    {
-        return $this->class_cache->getFqnForAlias($alias, $for_class);
-    }
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = [
-            'EE_Admin'                                                                                                           => [
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Maintenance_Mode'                                                                                                => [
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Request_Handler'                                                                                                 => [
-                'EventEspresso\core\services\request\Request'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Response' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_System'                                                                                                   => [
-                'EventEspresso\core\services\loaders\Loader'                   => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                                          => EE_Dependency_Map::load_from_cache,
-                'EE_Registry'                                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\Router'                   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Session'                                                                                                         => [
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\encryption\Base64Encoder'     => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\session\SessionStartHandler'                                                            => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Cart'                                                                                                            => [
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Messenger_Collection_Loader'                                                                                     => [
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ],
-            'EE_Message_Type_Collection_Loader'                                                                                  => [
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ],
-            'EE_Message_Resource_Manager'                                                                                        => [
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Message_Factory'                                                                                                 => [
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_messages'                                                                                                        => [
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Messages_Generator'                                                                                              => [
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Messages_Processor'                                                                                              => [
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Messages_Queue'                                                                                                  => [
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ],
-            'EE_Messages_Template_Defaults'                                                                                      => [
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Message_To_Generate_From_Request'                                                                                => [
-                'EE_Message_Resource_Manager'                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\commands\CommandBus'                                                                    => [
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\services\commands\CommandHandler'                                                                     => [
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                         => [
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                       => [
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\commands\CommandFactory'                                                                => [
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                         => [
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                                => [
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                            => [
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\registration\CreateRegistrationCommandHandler'                          => [
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => [
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => [
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => [
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => [
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => [
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => [
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                          => [
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler'                                  => [
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\values\session\SessionLifespan'                                                           => [
-                'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\admin\extend\registration_form\forms\SessionLifespanForm'                                 => [
-                'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
-                'EE_Registration_Config'                                         => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\admin\extend\registration_form\forms\SessionLifespanFormHandler'                          => [
-                'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
-                'EE_Config'                                                      => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\database\TableManager'                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Data_Migration_Class_Base'                                                                                       => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_1_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_2_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_3_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_4_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_5_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_6_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_7_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_8_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_9_0'                                                                                                  => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_4_10_0'                                                                                                 => [
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-                'EE_DMS_Core_4_9_0'                                  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_DMS_Core_5_0_0'                                                                                                  => [
-                'EE_DMS_Core_4_10_0'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\assets\I18nRegistry'                                                                    => [
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\assets\Registry'                                                                        => [
-                'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\AssetManifest'   => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                                    => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                                     => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                               => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                       => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                                     => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                               => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                                      => [
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\cache\BasicCacheManager'                                                                => [
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                          => [
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                         => [
-                'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\values\EmailAddress'                                                                      => [
-                null,
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\orm\ModelFieldFactory'                                                                  => [
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'LEGACY_MODELS'                                                                                                      => [
-                null,
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Module_Request_Router'                                                                                           => [
-                'EventEspresso\core\services\request\Request'             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\modules\ModuleRoutesManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Registration_Processor'                                                                                          => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                             => [
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                           => [
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Session'             => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\modules\ticket_selector\DisplayTicketSelector'                                                        => [
-                'EventEspresso\core\domain\entities\users\CurrentUser' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'          => EE_Dependency_Map::load_from_cache,
-                'EE_Ticket_Selector_Config'                            => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                        => [
-                'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
-                'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\modules\ticket_selector\ProcessTicketSelectorPostData'                                                => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                            => [
-                'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                                     => [
-                'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                       => [
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                                      => [
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_CPT_Strategy'                                                                                                    => [
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\loaders\ObjectIdentifier'                                                               => [
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\CPTs\CptQueryModifier'                                                                           => [
-                null,
-                null,
-                null,
-                'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'      => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\dependencies\DependencyResolver'                                                        => [
-                'EventEspresso\core\services\container\Mirror'            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-                'EE_Dependency_Map'                                       => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\routing\RouteMatchSpecificationDependencyResolver'                                      => [
-                'EventEspresso\core\services\container\Mirror'            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
-                'EE_Dependency_Map'                                       => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\routing\RouteMatchSpecificationFactory'                                                 => [
-                'EventEspresso\core\services\routing\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'                                    => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\routing\RouteMatchSpecificationManager'                                                 => [
-                'EventEspresso\core\services\routing\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\RouteMatchSpecificationFactory'    => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\request\files\FilesDataHandler'                                                         => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\libraries\batch\BatchRequestProcessor'                                                           => [
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\converters\RestApiSpoofer'                                                       => [
-                'WP_REST_Server'                                               => EE_Dependency_Map::load_from_cache,
-                'EED_Core_Rest_Api'                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\libraries\rest_api\controllers\model\Read' => EE_Dependency_Map::load_from_cache,
-                null,
-            ],
-            'EventEspresso\core\services\routing\RouteHandler'                                                                   => [
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeHandler'                => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'                          => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\RouteCollection'                 => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\json\JsonDataNodeHandler'                                                               => [
-                'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\routing\Router'                                                                         => [
-                'EE_Dependency_Map'                                => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\RouteHandler' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\assets\AssetManifest'                                                                   => [
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\assets\AssetManifestFactory'                                                            => [
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\assets\BaristaFactory'                                                                  => [
-                'EventEspresso\core\services\assets\AssetManifestFactory' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\capabilities\FeatureFlagsConfig' => [
-                'EventEspresso\core\domain\Domain'                                    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataHandler'                    => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\capabilities\FeatureFlags'       => [
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\capabilities\FeatureFlagsConfig'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\addon\AddonManager'                                                                     => [
-                'EventEspresso\core\services\addon\AddonCollection'              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\Psr4Autoloader'                              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\v1\RegisterAddon'         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\IncompatibleAddonHandler' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\ThirdPartyPluginHandler'  => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\addon\api\ThirdPartyPluginHandler'                                                      => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\libraries\batch\JobHandlers\ExecuteBatchDeletion'                                                => [
-                'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\libraries\batch\JobHandlers\PreviewEventDeletion'                                                => [
-                'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\events\data\PreviewDeletion'                                               => [
-                'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'                                                   => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'                                                => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'                                            => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion'                                               => [
-                'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\request\CurrentPage'                                                                    => [
-                'EE_CPT_Strategy'                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\shortcodes\LegacyShortcodesManager'                                                     => [
-                'EE_Registry'                                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\shortcodes\ShortcodesManager'                                                           => [
-                'EventEspresso\core\services\shortcodes\LegacyShortcodesManager' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\CurrentPage'                => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\entities\users\CurrentUser'                                                               => [
-                'EventEspresso\core\domain\entities\users\EventManagers' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\form\meta\InputTypes'                                                                   => [
-                'EventEspresso\core\services\form\meta\inputs\Block'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Button'   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\DateTime' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Input'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Number'   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Phone'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Select'   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\form\meta\inputs\Text'     => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormDependencyHandler'                                   => [
-                'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\calculators\LineItemCalculator'                                                         => [
-                'EventEspresso\core\services\helpers\DecimalValues' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\helpers\DecimalValues'                                                                  => [
-                'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_Brewing_Regular'                                                                                                 => [
-                'EE_Dependency_Map'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\routing\RouteHandler'   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\messages\MessageTemplateRequestData'                                             => [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\messages\MessageTemplateValidator'                                               => [
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\messages\MessageTemplateManager'                                                 => [
-                'EEM_Message_Template'                                                   => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template_Group'                                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\messages\MessageTemplateRequestData' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\messages\MessageTemplateValidator'   => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'                            => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\request\sanitizers\RequestSanitizer'                                                    => [
-                'EventEspresso\core\domain\services\validation\email\strategies\Basic' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EE_CPT_Event_Strategy'                                                    => [
-                null,
-                null,
-                'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\licensing\LicenseKeyFormInput'                                                    => [
-                'EventEspresso\core\services\licensing\PluginLicense'  => EE_Dependency_Map::not_registered,
-                'EventEspresso\core\services\licensing\LicenseManager' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\payments\IpnHandler' => [
-                'EEM_Payment_Method'                                    => EE_Dependency_Map::not_registered,
-                'EEM_Transaction'                                       => EE_Dependency_Map::load_from_cache,
-                'EE_Core_Config'                                        => EE_Dependency_Map::load_from_cache,
-                'EE_Organization_Config'                                => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\payments\PaymentProcessor' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\payments\PaymentProcessor' => [
-                'EEM_Payment_Method'                                           => EE_Dependency_Map::not_registered,
-                'EEM_Transaction'                                              => EE_Dependency_Map::load_from_cache,
-                'EE_Organization_Config'                                       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\payments\PaymentProcessorFees'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\payments\PostPaymentProcessor'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\payments\RegistrationPayments'    => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\payments\PostPaymentProcessor' => [
-                'EE_Transaction_Processor' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\services\payments\PaymentProcessorFees' => [
-                'EventEspresso\core\domain\values\gateways\GracePeriod'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\licensing\LicenseData' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\licensing\LicenseData'  => [
-                'EventEspresso\core\domain\Domain'                             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\licensing\LicenseDataEDD' => [
-                'EventEspresso\core\services\licensing\LicenseKeyData' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\licensing\LicenseDataPue' => [
-                'EE_Network_Core_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-        ];
-    }
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     */
-    protected function _register_core_class_loaders()
-    {
-        $this->_class_loaders = [
-            // load_core
-            'EE_Dependency_Map'                            => function () {
-                return $this;
-            },
-            'EE_Capabilities'                              => 'load_core',
-            'EE_Encryption'                                => 'load_core',
-            'EE_Front_Controller'                          => 'load_core',
-            'EE_Module_Request_Router'                     => 'load_core',
-            'EE_Registry'                                  => 'load_core',
-            'EE_Request'                                   => function () {
-                return $this->legacy_request;
-            },
-            'EventEspresso\core\services\request\Request'  => function () {
-                return $this->request;
-            },
-            'EventEspresso\core\services\request\Response' => function () {
-                return $this->response;
-            },
-            'EE_Base'                                      => 'load_core',
-            'EE_Request_Handler'                           => 'load_core',
-            'EE_Session'                                   => 'load_core',
-            'EE_Cron_Tasks'                                => 'load_core',
-            'EE_System'                                    => 'load_core',
-            'EE_Maintenance_Mode'                          => 'load_core',
-            'EE_Register_CPTs'                             => 'load_core',
-            'EE_Admin'                                     => 'load_core',
-            'EE_CPT_Strategy'                              => 'load_core',
-            // load_class
-            'EE_Registration_Processor'                    => 'load_class',
-            'EE_Transaction_Payments'                      => 'load_class',
-            'EE_Transaction_Processor'                     => 'load_class',
-            // load_lib
-            'EE_Message_Resource_Manager'                  => 'load_lib',
-            'EE_Message_Type_Collection'                   => 'load_lib',
-            'EE_Message_Type_Collection_Loader'            => 'load_lib',
-            'EE_Messenger_Collection'                      => 'load_lib',
-            'EE_Messenger_Collection_Loader'               => 'load_lib',
-            'EE_Messages_Processor'                        => 'load_lib',
-            'EE_Message_Repository'                        => 'load_lib',
-            'EE_Messages_Queue'                            => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'          => 'load_lib',
-            'EE_Message_Template_Group_Collection'         => 'load_lib',
-            'EE_Payment_Method_Manager'                    => 'load_lib',
-            'EE_Payment_Processor'                         => 'load_core',
-            'EE_DMS_Core_4_1_0'                            => 'load_dms',
-            'EE_DMS_Core_4_2_0'                            => 'load_dms',
-            'EE_DMS_Core_4_3_0'                            => 'load_dms',
-            'EE_DMS_Core_4_5_0'                            => 'load_dms',
-            'EE_DMS_Core_4_6_0'                            => 'load_dms',
-            'EE_DMS_Core_4_7_0'                            => 'load_dms',
-            'EE_DMS_Core_4_8_0'                            => 'load_dms',
-            'EE_DMS_Core_4_9_0'                            => 'load_dms',
-            'EE_DMS_Core_4_10_0'                           => 'load_dms',
-            'EE_DMS_Core_5_0_0'                            => 'load_dms',
-            'EE_Messages_Generator'                        => static function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    [],
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'                => static function ($arguments = []) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            // load_helper
-            'EEH_Parse_Shortcodes'                         => static function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                           => static function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                           => static function () {
-                return EE_Currency_Config::getCurrencyConfig();
-            },
-            'EE_Registration_Config'                       => static function () {
-                return EE_Config::instance()->registration;
-            },
-            'EE_Core_Config'                               => static function () {
-                return EE_Config::instance()->core;
-            },
-            'EventEspresso\core\services\loaders\Loader'   => static function () {
-                return LoaderFactory::getLoader();
-            },
-            'EE_Network_Config'                            => static function () {
-                return EE_Network_Config::instance();
-            },
-            'EE_Config'                                    => static function () {
-                return EE_Config::instance();
-            },
-            'EventEspresso\core\domain\Domain'             => static function () {
-                return DomainFactory::getEventEspressoCoreDomain();
-            },
-            'EE_Admin_Config'                              => static function () {
-                return EE_Config::instance()->admin;
-            },
-            'EE_Organization_Config'                       => static function () {
-                return EE_Config::instance()->organization;
-            },
-            'EE_Network_Core_Config'                       => static function () {
-                return EE_Network_Config::instance()->core;
-            },
-            'EE_Environment_Config'                        => static function () {
-                return EE_Config::instance()->environment;
-            },
-            'EED_Core_Rest_Api'                            => static function () {
-                return EED_Core_Rest_Api::instance();
-            },
-            'WP_REST_Server'                               => static function () {
-                return rest_get_server();
-            },
-            'EventEspresso\core\Psr4Autoloader'            => static function () {
-                return EE_Psr4AutoloaderInit::psr4_loader();
-            },
-            'EE_Ticket_Selector_Config'                    => function () {
-                return EE_Config::instance()->template_settings->EED_Ticket_Selector;
-            },
-        ];
-    }
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     *
-     * @throws InvalidAliasException
-     */
-    protected function _register_core_aliases()
-    {
-        $aliases = [
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\domain\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\domain\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\domain\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\domain\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\domain\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\domain\services\commands\ticket\CreateTicketLineItemCommand',
-            'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\domain\services\commands\transaction\CreateTransactionCommandHandler',
-            'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler',
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
-            'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
-            'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
-            'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
-            'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
-            'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
-            'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
-            'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
-            'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
-            'Registration_Processor'                                                       => 'EE_Registration_Processor',
-            'EventEspresso\core\services\assets\AssetManifestInterface'                    => 'EventEspresso\core\services\assets\AssetManifest',
-        ];
-        foreach ($aliases as $alias => $fqn) {
-            if (is_array($fqn)) {
-                foreach ($fqn as $class => $for_class) {
-                    $this->class_cache->addAlias($class, $alias, $for_class);
-                }
-                continue;
-            }
-            $this->class_cache->addAlias($fqn, $alias);
-        }
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            $this->class_cache->addAlias(
-                'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
-                'EventEspresso\core\services\notices\NoticeConverterInterface'
-            );
-        }
-    }
-
-
-    public function debug($for_class = '')
-    {
-        if (method_exists($this->class_cache, 'debug')) {
-            $this->class_cache->debug($for_class);
-        }
-    }
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be is_alias()
-     * because it returns TRUE if the provided fully qualified name IS an alias
-     * WHY?
-     * Because if a class is type hinting for a concretion,
-     * then why would we need to find another class to supply it?
-     * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
-     * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
-     * Don't go looking for some substitute.
-     * Whereas if a class is type hinting for an interface...
-     * then we need to find an actual class to use.
-     * So the interface IS the alias for some other FQN,
-     * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
-     * represents some other class.
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     * @deprecated 4.9.62.p
-     */
-    public function has_alias(string $fqn = '', string $for_class = ''): bool
-    {
-        return $this->isAlias($fqn, $for_class);
-    }
-
-
-    /**
-     * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
-     * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     * @deprecated 4.9.62.p
-     */
-    public function get_alias(string $alias = '', string $for_class = ''): string
-    {
-        return $this->getFqnForAlias($alias, $for_class);
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to keep any existing dependencies that already exist,
+	 * and simply discard any new dependencies declared in the incoming data
+	 */
+	const KEEP_EXISTING_DEPENDENCIES = 0;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
+	 */
+	const OVERWRITE_DEPENDENCIES = 1;
+
+	protected static ?EE_Dependency_Map $_instance = null;
+
+	private ClassInterfaceCache $class_cache;
+
+	protected ?RequestInterface $request = null;
+
+	protected ?LegacyRequestInterface $legacy_request = null;
+
+	protected ?ResponseInterface $response = null;
+
+	protected ?LoaderInterface $loader = null;
+
+	protected array $_dependency_map = [];
+
+	protected array $_class_loaders = [];
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	protected function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+		do_action('EE_Dependency_Map____construct', $this);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidAliasException
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance(ClassInterfaceCache $class_cache = null): EE_Dependency_Map
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (
+			! EE_Dependency_Map::$_instance instanceof EE_Dependency_Map
+			&& $class_cache instanceof ClassInterfaceCache
+		) {
+			EE_Dependency_Map::$_instance = new EE_Dependency_Map($class_cache);
+		}
+		return EE_Dependency_Map::$_instance;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param LegacyRequestInterface $legacy_request
+	 */
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
+	{
+		$this->legacy_request = $legacy_request;
+	}
+
+
+	/**
+	 * @param ResponseInterface $response
+	 */
+	public function setResponse(ResponseInterface $response)
+	{
+		$this->response = $response;
+	}
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public static function register_dependencies(
+		string $class,
+		array $dependencies,
+		int $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	): bool {
+		return EE_Dependency_Map::$_instance->registerDependencies($class, $dependencies, $overwrite);
+	}
+
+
+	/**
+	 * Assigns an array of class names and corresponding load sources (new or cached)
+	 * to the class specified by the first parameter.
+	 * IMPORTANT !!!
+	 * The order of elements in the incoming $dependencies array MUST match
+	 * the order of the constructor parameters for the class in question.
+	 * This is especially important when overriding any existing dependencies that are registered.
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
+	 *
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public function registerDependencies(
+		string $class,
+		array $dependencies,
+		int $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	): bool {
+		if (empty($dependencies)) {
+			return false;
+		}
+		$class      = trim($class, '\\');
+		$registered = false;
+		if (empty(EE_Dependency_Map::$_instance->_dependency_map[ $class ])) {
+			EE_Dependency_Map::$_instance->_dependency_map[ $class ] = [];
+		}
+		// we need to make sure that any aliases used when registering a dependency
+		// get resolved to the correct class name
+		foreach ($dependencies as $dependency => $load_source) {
+			$alias = EE_Dependency_Map::$_instance->getFqnForAlias($dependency);
+			if (
+				$overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
+				|| ! isset(
+					EE_Dependency_Map::$_instance->_dependency_map[ $class ][ $dependency ],
+					EE_Dependency_Map::$_instance->_dependency_map[ $class ][ $alias ]
+				)
+			) {
+				unset($dependencies[ $dependency ]);
+				$dependencies[ $alias ] = $load_source;
+				$registered             = true;
+			}
+		}
+		// now add our two lists of dependencies together.
+		// using Union (+=) favours the arrays in precedence from left to right,
+		// so $dependencies is NOT overwritten because it is listed first
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
+		// Union is way faster than array_merge() but should be used with caution...
+		// especially with numerically indexed arrays
+		$dependencies += EE_Dependency_Map::$_instance->_dependency_map[ $class ];
+		// now we need to ensure that the resulting dependencies
+		// array only has the entries that are required for the class
+		// so first count how many dependencies were originally registered for the class
+		$dependency_count = count(EE_Dependency_Map::$_instance->_dependency_map[ $class ]);
+		// if that count is non-zero (meaning dependencies were already registered)
+		EE_Dependency_Map::$_instance->_dependency_map[ $class ] = $dependency_count
+			// then truncate the  final array to match that count
+			? array_slice($dependencies, 0, $dependency_count)
+			// otherwise just take the incoming array because nothing previously existed
+			: $dependencies;
+		return $registered
+			|| count(EE_Dependency_Map::$_instance->_dependency_map[ $class ]) === count($dependencies);
+	}
+
+
+	/**
+	 * @param string          $class_name
+	 * @param callable|string $loader
+	 * @param bool            $overwrite
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function register_class_loader(
+		string $class_name,
+		$loader = 'load_core',
+		bool $overwrite = false
+	): bool {
+		return EE_Dependency_Map::$_instance->registerClassLoader($class_name, $loader, $overwrite);
+	}
+
+
+	/**
+	 * @param string         $class_name
+	 * @param Closure|string $loader
+	 * @param bool           $overwrite
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function registerClassLoader(string $class_name, $loader = 'load_core', bool $overwrite = false): bool
+	{
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+			throw new DomainException(
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
+			);
+		}
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (
+			! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid loader method on EE_Registry.',
+						'event_espresso'
+					),
+					$loader
+				)
+			);
+		}
+		$class_name = EE_Dependency_Map::$_instance->getFqnForAlias($class_name);
+		if ($overwrite || ! isset(EE_Dependency_Map::$_instance->_class_loaders[ $class_name ])) {
+			EE_Dependency_Map::$_instance->_class_loaders[ $class_name ] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map(): array
+	{
+		return $this->_dependency_map;
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has(string $class_name = ''): bool
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		return isset($this->_dependency_map[ $class_name ]);
+	}
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class(string $class_name = '', string $dependency = ''): bool
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency, $class_name);
+		return isset($this->_dependency_map[ $class_name ][ $dependency ]);
+	}
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency(string $class_name = '', string $dependency = ''): int
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->getFqnForAlias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[ $class_name ][ $dependency ]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader(string $class_name)
+	{
+		// all legacy models use load_model()
+		if (strpos($class_name, 'EEM_') === 0) {
+			return 'load_model';
+		}
+		// EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc
+		// perform strpos() first to avoid loading regex every time we load a class
+		if (
+			strpos($class_name, 'EE_CPT_') === 0
+			&& preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name)
+		) {
+			return 'load_core';
+		}
+		$class_name = $this->getFqnForAlias($class_name);
+		return $this->_class_loaders[ $class_name ] ?? '';
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders(): array
+	{
+		return $this->_class_loaders;
+	}
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $fqcn      the class name that should be used (concrete class to replace interface)
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
+	 * @throws InvalidAliasException
+	 */
+	public function add_alias(string $fqcn, string $alias, string $for_class = '')
+	{
+		$this->class_cache->addAlias($fqcn, $alias, $for_class);
+	}
+
+
+	/**
+	 * Returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function isAlias(string $fqn = '', string $for_class = ''): bool
+	{
+		return $this->class_cache->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * Returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function getFqnForAlias(string $alias = '', string $for_class = ''): string
+	{
+		return $this->class_cache->getFqnForAlias($alias, $for_class);
+	}
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = [
+			'EE_Admin'                                                                                                           => [
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Maintenance_Mode'                                                                                                => [
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Request_Handler'                                                                                                 => [
+				'EventEspresso\core\services\request\Request'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Response' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_System'                                                                                                   => [
+				'EventEspresso\core\services\loaders\Loader'                   => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                                          => EE_Dependency_Map::load_from_cache,
+				'EE_Registry'                                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\Router'                   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Session'                                                                                                         => [
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\session\SessionStartHandler'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\encryption\Base64Encoder'     => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\session\SessionStartHandler'                                                            => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Cart'                                                                                                            => [
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Messenger_Collection_Loader'                                                                                     => [
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			],
+			'EE_Message_Type_Collection_Loader'                                                                                  => [
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			],
+			'EE_Message_Resource_Manager'                                                                                        => [
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Message_Factory'                                                                                                 => [
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_messages'                                                                                                        => [
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Messages_Generator'                                                                                              => [
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Messages_Processor'                                                                                              => [
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Messages_Queue'                                                                                                  => [
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			],
+			'EE_Messages_Template_Defaults'                                                                                      => [
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Message_To_Generate_From_Request'                                                                                => [
+				'EE_Message_Resource_Manager'                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\commands\CommandBus'                                                                    => [
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\services\commands\CommandHandler'                                                                     => [
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                         => [
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                       => [
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\commands\CommandFactory'                                                                => [
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                         => [
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                                => [
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                            => [
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\registration\CreateRegistrationCommandHandler'                          => [
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => [
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => [
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => [
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => [
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => [
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => [
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                          => [
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler'                                  => [
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\values\session\SessionLifespan'                                                           => [
+				'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\admin\extend\registration_form\forms\SessionLifespanForm'                                 => [
+				'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
+				'EE_Registration_Config'                                         => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\admin\extend\registration_form\forms\SessionLifespanFormHandler'                          => [
+				'EventEspresso\core\domain\values\session\SessionLifespanOption' => EE_Dependency_Map::load_from_cache,
+				'EE_Config'                                                      => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\database\TableManager'                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Data_Migration_Class_Base'                                                                                       => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_1_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_2_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_3_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_4_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_5_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_6_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_7_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_8_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_9_0'                                                                                                  => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_4_10_0'                                                                                                 => [
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+				'EE_DMS_Core_4_9_0'                                  => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_DMS_Core_5_0_0'                                                                                                  => [
+				'EE_DMS_Core_4_10_0'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\assets\I18nRegistry'                                                                    => [
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\assets\Registry'                                                                        => [
+				'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\AssetManifest'   => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                                    => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                                     => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                               => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                       => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                                     => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                               => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                                      => [
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\cache\BasicCacheManager'                                                                => [
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                                                          => [
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService'                                         => [
+				'EE_Registration_Config'                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\values\EmailAddress'                                                                      => [
+				null,
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\orm\ModelFieldFactory'                                                                  => [
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'LEGACY_MODELS'                                                                                                      => [
+				null,
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Module_Request_Router'                                                                                           => [
+				'EventEspresso\core\services\request\Request'             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\modules\ModuleRoutesManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Registration_Processor'                                                                                          => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'                                             => [
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha'                                           => [
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Session'             => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\modules\ticket_selector\DisplayTicketSelector'                                                        => [
+				'EventEspresso\core\domain\entities\users\CurrentUser' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'          => EE_Dependency_Map::load_from_cache,
+				'EE_Ticket_Selector_Config'                            => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelector'                                                        => [
+				'EE_Core_Config'                                                          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                             => EE_Dependency_Map::load_from_cache,
+				'EE_Session'                                                              => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'                                                              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\modules\ticket_selector\ProcessTicketSelectorPostData'                                                => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker'                                            => [
+				'EEM_Datetime' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'                                     => [
+				'EE_Core_Config'                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'                                       => [
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'                                      => [
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_CPT_Strategy'                                                                                                    => [
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\loaders\ObjectIdentifier'                                                               => [
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\CPTs\CptQueryModifier'                                                                           => [
+				null,
+				null,
+				null,
+				'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'      => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\dependencies\DependencyResolver'                                                        => [
+				'EventEspresso\core\services\container\Mirror'            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+				'EE_Dependency_Map'                                       => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\routing\RouteMatchSpecificationDependencyResolver'                                      => [
+				'EventEspresso\core\services\container\Mirror'            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
+				'EE_Dependency_Map'                                       => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\routing\RouteMatchSpecificationFactory'                                                 => [
+				'EventEspresso\core\services\routing\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'                                    => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\routing\RouteMatchSpecificationManager'                                                 => [
+				'EventEspresso\core\services\routing\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\RouteMatchSpecificationFactory'    => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\request\files\FilesDataHandler'                                                         => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\libraries\batch\BatchRequestProcessor'                                                           => [
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\converters\RestApiSpoofer'                                                       => [
+				'WP_REST_Server'                                               => EE_Dependency_Map::load_from_cache,
+				'EED_Core_Rest_Api'                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\libraries\rest_api\controllers\model\Read' => EE_Dependency_Map::load_from_cache,
+				null,
+			],
+			'EventEspresso\core\services\routing\RouteHandler'                                                                   => [
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeHandler'                => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'                          => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\RouteCollection'                 => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\json\JsonDataNodeHandler'                                                               => [
+				'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\routing\Router'                                                                         => [
+				'EE_Dependency_Map'                                => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\RouteHandler' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\assets\AssetManifest'                                                                   => [
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\assets\AssetManifestFactory'                                                            => [
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\assets\BaristaFactory'                                                                  => [
+				'EventEspresso\core\services\assets\AssetManifestFactory' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\capabilities\FeatureFlagsConfig' => [
+				'EventEspresso\core\domain\Domain'                                    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataHandler'                    => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\capabilities\FeatureFlags'       => [
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\capabilities\FeatureFlagsConfig'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\addon\AddonManager'                                                                     => [
+				'EventEspresso\core\services\addon\AddonCollection'              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\Psr4Autoloader'                              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\v1\RegisterAddon'         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\IncompatibleAddonHandler' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\ThirdPartyPluginHandler'  => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\addon\api\ThirdPartyPluginHandler'                                                      => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\libraries\batch\JobHandlers\ExecuteBatchDeletion'                                                => [
+				'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\libraries\batch\JobHandlers\PreviewEventDeletion'                                                => [
+				'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\events\data\PreviewDeletion'                                               => [
+				'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'                                                   => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'                                                => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'                                            => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion'                                               => [
+				'EventEspresso\core\services\orm\tree_traversal\NodeGroupDao' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\request\CurrentPage'                                                                    => [
+				'EE_CPT_Strategy'                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\shortcodes\LegacyShortcodesManager'                                                     => [
+				'EE_Registry'                                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\shortcodes\ShortcodesManager'                                                           => [
+				'EventEspresso\core\services\shortcodes\LegacyShortcodesManager' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\CurrentPage'                => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\entities\users\CurrentUser'                                                               => [
+				'EventEspresso\core\domain\entities\users\EventManagers' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\form\meta\InputTypes'                                                                   => [
+				'EventEspresso\core\services\form\meta\inputs\Block'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Button'   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\DateTime' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Input'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Number'   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Phone'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Select'   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\form\meta\inputs\Text'     => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormDependencyHandler'                                   => [
+				'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\calculators\LineItemCalculator'                                                         => [
+				'EventEspresso\core\services\helpers\DecimalValues' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\helpers\DecimalValues'                                                                  => [
+				'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_Brewing_Regular'                                                                                                 => [
+				'EE_Dependency_Map'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\routing\RouteHandler'   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\messages\MessageTemplateRequestData'                                             => [
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\messages\MessageTemplateValidator'                                               => [
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\messages\MessageTemplateManager'                                                 => [
+				'EEM_Message_Template'                                                   => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template_Group'                                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\messages\MessageTemplateRequestData' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\messages\MessageTemplateValidator'   => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'                            => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\request\sanitizers\RequestSanitizer'                                                    => [
+				'EventEspresso\core\domain\services\validation\email\strategies\Basic' => EE_Dependency_Map::load_from_cache,
+			],
+			'EE_CPT_Event_Strategy'                                                    => [
+				null,
+				null,
+				'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\licensing\LicenseKeyFormInput'                                                    => [
+				'EventEspresso\core\services\licensing\PluginLicense'  => EE_Dependency_Map::not_registered,
+				'EventEspresso\core\services\licensing\LicenseManager' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\payments\IpnHandler' => [
+				'EEM_Payment_Method'                                    => EE_Dependency_Map::not_registered,
+				'EEM_Transaction'                                       => EE_Dependency_Map::load_from_cache,
+				'EE_Core_Config'                                        => EE_Dependency_Map::load_from_cache,
+				'EE_Organization_Config'                                => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\payments\PaymentProcessor' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\payments\PaymentProcessor' => [
+				'EEM_Payment_Method'                                           => EE_Dependency_Map::not_registered,
+				'EEM_Transaction'                                              => EE_Dependency_Map::load_from_cache,
+				'EE_Organization_Config'                                       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\payments\PaymentProcessorFees'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\payments\PostPaymentProcessor'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\payments\RegistrationPayments'    => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\payments\PostPaymentProcessor' => [
+				'EE_Transaction_Processor' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\services\payments\PaymentProcessorFees' => [
+				'EventEspresso\core\domain\values\gateways\GracePeriod'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\licensing\LicenseData' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\licensing\LicenseData'  => [
+				'EventEspresso\core\domain\Domain'                             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\licensing\LicenseDataEDD' => [
+				'EventEspresso\core\services\licensing\LicenseKeyData' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\licensing\LicenseDataPue' => [
+				'EE_Network_Core_Config' => EE_Dependency_Map::load_from_cache,
+			],
+		];
+	}
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 */
+	protected function _register_core_class_loaders()
+	{
+		$this->_class_loaders = [
+			// load_core
+			'EE_Dependency_Map'                            => function () {
+				return $this;
+			},
+			'EE_Capabilities'                              => 'load_core',
+			'EE_Encryption'                                => 'load_core',
+			'EE_Front_Controller'                          => 'load_core',
+			'EE_Module_Request_Router'                     => 'load_core',
+			'EE_Registry'                                  => 'load_core',
+			'EE_Request'                                   => function () {
+				return $this->legacy_request;
+			},
+			'EventEspresso\core\services\request\Request'  => function () {
+				return $this->request;
+			},
+			'EventEspresso\core\services\request\Response' => function () {
+				return $this->response;
+			},
+			'EE_Base'                                      => 'load_core',
+			'EE_Request_Handler'                           => 'load_core',
+			'EE_Session'                                   => 'load_core',
+			'EE_Cron_Tasks'                                => 'load_core',
+			'EE_System'                                    => 'load_core',
+			'EE_Maintenance_Mode'                          => 'load_core',
+			'EE_Register_CPTs'                             => 'load_core',
+			'EE_Admin'                                     => 'load_core',
+			'EE_CPT_Strategy'                              => 'load_core',
+			// load_class
+			'EE_Registration_Processor'                    => 'load_class',
+			'EE_Transaction_Payments'                      => 'load_class',
+			'EE_Transaction_Processor'                     => 'load_class',
+			// load_lib
+			'EE_Message_Resource_Manager'                  => 'load_lib',
+			'EE_Message_Type_Collection'                   => 'load_lib',
+			'EE_Message_Type_Collection_Loader'            => 'load_lib',
+			'EE_Messenger_Collection'                      => 'load_lib',
+			'EE_Messenger_Collection_Loader'               => 'load_lib',
+			'EE_Messages_Processor'                        => 'load_lib',
+			'EE_Message_Repository'                        => 'load_lib',
+			'EE_Messages_Queue'                            => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'          => 'load_lib',
+			'EE_Message_Template_Group_Collection'         => 'load_lib',
+			'EE_Payment_Method_Manager'                    => 'load_lib',
+			'EE_Payment_Processor'                         => 'load_core',
+			'EE_DMS_Core_4_1_0'                            => 'load_dms',
+			'EE_DMS_Core_4_2_0'                            => 'load_dms',
+			'EE_DMS_Core_4_3_0'                            => 'load_dms',
+			'EE_DMS_Core_4_5_0'                            => 'load_dms',
+			'EE_DMS_Core_4_6_0'                            => 'load_dms',
+			'EE_DMS_Core_4_7_0'                            => 'load_dms',
+			'EE_DMS_Core_4_8_0'                            => 'load_dms',
+			'EE_DMS_Core_4_9_0'                            => 'load_dms',
+			'EE_DMS_Core_4_10_0'                           => 'load_dms',
+			'EE_DMS_Core_5_0_0'                            => 'load_dms',
+			'EE_Messages_Generator'                        => static function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					[],
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'                => static function ($arguments = []) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			// load_helper
+			'EEH_Parse_Shortcodes'                         => static function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                           => static function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                           => static function () {
+				return EE_Currency_Config::getCurrencyConfig();
+			},
+			'EE_Registration_Config'                       => static function () {
+				return EE_Config::instance()->registration;
+			},
+			'EE_Core_Config'                               => static function () {
+				return EE_Config::instance()->core;
+			},
+			'EventEspresso\core\services\loaders\Loader'   => static function () {
+				return LoaderFactory::getLoader();
+			},
+			'EE_Network_Config'                            => static function () {
+				return EE_Network_Config::instance();
+			},
+			'EE_Config'                                    => static function () {
+				return EE_Config::instance();
+			},
+			'EventEspresso\core\domain\Domain'             => static function () {
+				return DomainFactory::getEventEspressoCoreDomain();
+			},
+			'EE_Admin_Config'                              => static function () {
+				return EE_Config::instance()->admin;
+			},
+			'EE_Organization_Config'                       => static function () {
+				return EE_Config::instance()->organization;
+			},
+			'EE_Network_Core_Config'                       => static function () {
+				return EE_Network_Config::instance()->core;
+			},
+			'EE_Environment_Config'                        => static function () {
+				return EE_Config::instance()->environment;
+			},
+			'EED_Core_Rest_Api'                            => static function () {
+				return EED_Core_Rest_Api::instance();
+			},
+			'WP_REST_Server'                               => static function () {
+				return rest_get_server();
+			},
+			'EventEspresso\core\Psr4Autoloader'            => static function () {
+				return EE_Psr4AutoloaderInit::psr4_loader();
+			},
+			'EE_Ticket_Selector_Config'                    => function () {
+				return EE_Config::instance()->template_settings->EED_Ticket_Selector;
+			},
+		];
+	}
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 *
+	 * @throws InvalidAliasException
+	 */
+	protected function _register_core_aliases()
+	{
+		$aliases = [
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\domain\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\domain\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\domain\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\domain\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\domain\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\domain\services\commands\ticket\CreateTicketLineItemCommand',
+			'CreateTransactionCommandHandler'                                              => 'EventEspresso\core\domain\services\commands\transaction\CreateTransactionCommandHandler',
+			'CreateAttendeeCommandHandler'                                                 => 'EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler',
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                                      => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                 => 'EventEspresso\core\services\commands\CommandFactory',
+			'EmailValidatorInterface'                                                      => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface'  => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
+			'NoticeConverterInterface'                                                     => 'EventEspresso\core\services\notices\NoticeConverterInterface',
+			'EventEspresso\core\services\notices\NoticeConverterInterface'                 => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
+			'NoticesContainerInterface'                                                    => 'EventEspresso\core\services\notices\NoticesContainerInterface',
+			'EventEspresso\core\services\notices\NoticesContainerInterface'                => 'EventEspresso\core\services\notices\NoticesContainer',
+			'EventEspresso\core\services\request\RequestInterface'                         => 'EventEspresso\core\services\request\Request',
+			'EventEspresso\core\services\request\ResponseInterface'                        => 'EventEspresso\core\services\request\Response',
+			'EventEspresso\core\domain\DomainInterface'                                    => 'EventEspresso\core\domain\Domain',
+			'Registration_Processor'                                                       => 'EE_Registration_Processor',
+			'EventEspresso\core\services\assets\AssetManifestInterface'                    => 'EventEspresso\core\services\assets\AssetManifest',
+		];
+		foreach ($aliases as $alias => $fqn) {
+			if (is_array($fqn)) {
+				foreach ($fqn as $class => $for_class) {
+					$this->class_cache->addAlias($class, $alias, $for_class);
+				}
+				continue;
+			}
+			$this->class_cache->addAlias($fqn, $alias);
+		}
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			$this->class_cache->addAlias(
+				'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
+				'EventEspresso\core\services\notices\NoticeConverterInterface'
+			);
+		}
+	}
+
+
+	public function debug($for_class = '')
+	{
+		if (method_exists($this->class_cache, 'debug')) {
+			$this->class_cache->debug($for_class);
+		}
+	}
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be is_alias()
+	 * because it returns TRUE if the provided fully qualified name IS an alias
+	 * WHY?
+	 * Because if a class is type hinting for a concretion,
+	 * then why would we need to find another class to supply it?
+	 * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`,
+	 * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`.
+	 * Don't go looking for some substitute.
+	 * Whereas if a class is type hinting for an interface...
+	 * then we need to find an actual class to use.
+	 * So the interface IS the alias for some other FQN,
+	 * and we need to find out if `Fully/Qualified/Namespace/SomeInterface`
+	 * represents some other class.
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 * @deprecated 4.9.62.p
+	 */
+	public function has_alias(string $fqn = '', string $for_class = ''): bool
+	{
+		return $this->isAlias($fqn, $for_class);
+	}
+
+
+	/**
+	 * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
+	 * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 * @deprecated 4.9.62.p
+	 */
+	public function get_alias(string $alias = '', string $for_class = ''): string
+	{
+		return $this->getFqnForAlias($alias, $for_class);
+	}
 }

core/EE_Registry.core.php

Indentation +1700 added lines, -1700 removed lines

@@ -22,1704 +22,1704 @@
  */
 class EE_Registry implements ResettableInterface
 {
-    private static ?EE_Registry $_instance = null;
-
-    protected EE_Dependency_Map $_dependency_map;
-
-    private Mirror $mirror;
-
-    private ClassInterfaceCache $class_cache;
-
-    private ObjectIdentifier $object_identifier;
-
-    protected array $_class_abbreviations = [];
-
-    public ?CommandBusInterface $BUS = null;
-
-    public ?EE_Cart $CART = null;
-
-    public ?EE_Config $CFG = null;
-
-    public ?EE_Network_Config $NET_CFG = null;
-
-    /**
-     * RegistryContainer for storing library classes in
-     *
-     * @var RegistryContainer|null $LIB
-     */
-    public ?RegistryContainer $LIB = null;
-
-    /**
-     * @var EE_Request_Handler|null $REQ
-     * @deprecated 4.10.14.p
-     */
-    public ?EE_Request_Handler $REQ = null;
-
-    public ?EE_Session $SSN = null;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities|null $CAP
-     */
-    public ?EE_Capabilities$CAP = null;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager|null $MRM
-     */
-    public ?EE_Message_Resource_Manager $MRM = null;
-
-    public ?Registry $AssetsRegistry = null;
-
-    /**
-     * RegistryContainer for holding addons which have registered themselves to work with EE core
-     *
-     * @var RegistryContainer|EE_Addon[] $addons
-     */
-    public $addons = [];
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public array $models = [];
-
-    /**
-     * @var RegistryContainer|EED_Module[] $modules
-     */
-    public $modules = [];
-
-    /**
-     * @var RegistryContainer|EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes = [];
-
-    /**
-     * @var RegistryContainer|WP_Widget[] $widgets
-     */
-    public $widgets = [];
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public array $non_abstract_db_models = [];
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static array $i18n_js_strings = [];
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var string $main_file
-     */
-    public string $main_file = '';
-
-    /**
-     * boolean flag to indicate whether to load/save dependencies from/to the cache
-     *
-     * @var bool $_cache_on
-     */
-    protected bool $_cache_on = true;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ): EE_Registry {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param EE_Dependency_Map   $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map   = $dependency_map;
-        $this->mirror            = $mirror;
-        $this->class_cache       = $class_cache;
-        $this->object_identifier = $object_identifier;
-
-        $this->LIB        = new RegistryContainer();
-        $this->addons     = new RegistryContainer();
-        $this->modules    = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets    = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', [$this, 'initialize']);
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            [
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            ]
-        );
-        $this->load_core('Base', [], true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'init']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = is_ssl() ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function sanitize_i18n_js_strings(): array
-    {
-        array_walk(EE_Registry::$i18n_js_strings, function (&$value) {
-            if (is_scalar($value)) {
-                $value = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-                // replace all escaped instances of \n with actual new lines
-                $value = str_replace("\\n", "\n", $value);
-            }
-        });
-        // sort the array by key in a case-insensitive manner
-        ksort(EE_Registry::$i18n_js_strings, SORT_NATURAL | SORT_FLAG_CASE);
-        return EE_Registry::$i18n_js_strings;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings(): string
-    {
-        $i18n_js_strings = wp_json_encode(EE_Registry::sanitize_i18n_js_strings());
-        return "/* <![CDATA[ */ var eei18n = $i18n_js_strings; /* ]]> */";
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->add($module_class, $module);
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module(string $module_name = '')
-    {
-        return $this->modules->get($module_name);
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $core_paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            [
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_service(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $service_paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            [
-                EE_CORE . 'services/',
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms(string $class_name, $arguments = [])
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class|object|bool|null
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class(
-        string $class_name,
-        $arguments = [],
-        bool $from_db = false,
-        bool $cache = true,
-        bool $load_only = false
-    ) {
-        $paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            [
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper(string $class_name, $arguments = [], bool $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = (array) apply_filters('FHEE__EE_Registry__load_helper__helper_paths', [EE_HELPERS]);
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib(string $class_name, $arguments = [], bool $load_only = false, bool $cache = true)
-    {
-        $paths = [
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
-        ];
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            [
-                EE_MODELS,
-                EE_CORE,
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
-    {
-        $paths = [
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
-        ];
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name(string $model_name): bool
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file(
-        string $path_to_file,
-        string $file_name,
-        string $type = '',
-        $arguments = [],
-        bool $load_only = true
-    ) {
-        // retrieve instantiated class
-        return $this->_load(
-            (array) $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_addon(
-        string $path_to_file,
-        string $class_name,
-        string $type = 'class',
-        $arguments = [],
-        bool $load_only = false
-    ) {
-        // retrieve instantiated class
-        return $this->_load(
-            (array) $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param string      $class_name Fully Qualified Class Name
-     * @param array       $arguments  an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache      whether to cache the instantiated object for reuse
-     * @param bool        $from_db    some classes are instantiated from the db
-     *                                and thus call a different method to instantiate
-     * @param bool        $load_only  if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon      if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed     null = failure to load or instantiate class object.
-     *                                object = class loaded and instantiated successfully.
-     *                                bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        string $class_name = '',
-        array $arguments = [],
-        bool $cache = false,
-        bool $from_db = false,
-        bool $load_only = false,
-        bool $addon = false
-    ) {
-        $class_name   = ltrim($class_name, '\\');
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }                                                           // obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|mixed $class_name
-     * @param array        $arguments
-     * @param int          $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, int $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array  $file_paths         an array of paths to folders to look in
-     * @param string $class_prefix       EE  or EEM or... ???
-     * @param string $class_name         $class name
-     * @param string $type               file type - core? class? helper? model?
-     * @param mixed  $arguments          an argument or array of arguments to pass to the class upon instantiation
-     * @param bool   $from_db            some classes are instantiated from the db
-     *                                   and thus call a different method to instantiate
-     * @param bool   $cache              whether to cache the instantiated object for reuse
-     * @param bool   $load_only          if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object          null   = failure to load or instantiate class object.
-     *                                   object = class loaded and instantiated successfully.
-     *                                   bool   = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        array $file_paths = [],
-        string $class_prefix = 'EE_',
-        string $class_name = '',
-        string $type = 'class',
-        array $arguments = [],
-        bool $from_db = false,
-        bool $cache = true,
-        bool $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : [$arguments];
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
-    {
-        return $this->_class_abbreviations[ $class_name ] ?? $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        string $class_name,
-        string $class_prefix = '',
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
-            return $this->addons->get($class_name);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($object_identifier)) {
-            return $this->LIB->get($object_identifier);
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (
-                // request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        string $class_name,
-        bool $addon = false,
-        array $arguments = []
-    ): bool {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && $this->addons->has($class_name)) {
-            $this->addons->remove($class_name);
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($class_name)) {
-            $this->LIB->remove($class_name);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        string $class_name,
-        string $class_prefix = '',
-        bool $from_db = false,
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->add($class_name, $class_obj);
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->add($class_name, $class_obj);
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : [$file_paths];
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(['/', '\\'], '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param string $path
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent(string $class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = [
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            ];
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object(
-        string $class_name,
-        array $arguments = [],
-        string $type = '',
-        bool $from_db = false
-    ) {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : [$arguments];
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : [$arguments];
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (
-            empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array([$class_name, 'new_instance'], $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array([$class_name, 'instance'], $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            $args_passed_count = count($arguments);
-            $args_required_count = count($this->mirror->getRequiredParameters($class_name));
-            if ($args_passed_count < $args_required_count) {
-                throw new RuntimeException(
-                    sprintf(
-                        __(
-                            'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
-                            'event_espresso'
-                        ),
-                        $class_name,
-                        $args_required_count,
-                        $args_passed_count
-                    )
-                );
-            }
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array): bool
-    {
-        return empty($array) || array_keys($array) === range(0, count($array) - 1);
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(
-        ReflectionClass $reflector,
-        string $class_name,
-        array $arguments = []
-    ): array {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all the constructors' expected parameters
-        foreach ($params as $index => $param) {
-            try {
-                // is this a dependency for a specific class ?
-                $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            } catch (ReflectionException $exception) {
-                // uh-oh... most likely a legacy class that has not been autoloaded
-                // let's try to derive the classname from what we have now
-                // and hope that the property var name is close to the class name
-                $param_class = $param->getName();
-                $param_class = str_replace('_', ' ', $param_class);
-                $param_class = ucwords($param_class);
-                $param_class = str_replace(' ', '_', $param_class);
-            }
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            if (
-                // param is not even a class
-                ($param_class === null || $this->parameterIsPrimitive($param_class))
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && isset($arguments[ $argument_keys[ $index ] ])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            // parameter is type hinted as a class
-            if ($param_class !== null) {
-                // parameter exists as an incoming argument, AND it's the correct class
-                if (
-                    array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-                ) {
-                    // skip this argument and move on to the next
-                    continue;
-                }
-                // parameter should be injected
-                if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
-                    $arguments = $this->_resolve_dependency(
-                        $class_name,
-                        $param_class,
-                        $arguments,
-                        $index
-                    );
-                }
-            }
-            if (empty($arguments[ $index ])) {
-                $default_value = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-                // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                       && isset($arguments[ $index ])
-                                       && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
-                    : $default_value;
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        [],
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory(string $classname, array $arguments = [])
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon(string $class_name): ?EE_Addon
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        return $this->addons->{$class_name} ?? null;
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon(string $class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        $this->addons->remove($class_name);
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name(string $name): ?EE_Addon
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name(): array
-    {
-        $addons = [];
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset_model(string $model_name): ?EEM_Base
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_$model_name"
-            : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
-            return null;
-        }
-        $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
-            $this->LIB->remove($model_class_name);
-            $this->LIB->add($model_class_name, $model->reset());
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $model;
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
-    {
-        $instance            = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (['LIB', 'modules'] as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _reset_and_unset_object($object, bool $reset_models): bool
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models(): array
-    {
-        $cpt_models = [];
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return EE_Config
-     */
-    public static function CFG(): EE_Config
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @deprecated 4.9.62.p
-     */
-    public function get_ReflectionClass(string $class_name): ReflectionClass
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
-
-    private function parameterIsPrimitive(?string $param_class): bool
-    {
-        return in_array(
-            $param_class,
-            [
-                'array',
-                'bool',
-                'float',
-                'int',
-                'string',
-            ]
-        );
-    }
+	private static ?EE_Registry $_instance = null;
+
+	protected EE_Dependency_Map $_dependency_map;
+
+	private Mirror $mirror;
+
+	private ClassInterfaceCache $class_cache;
+
+	private ObjectIdentifier $object_identifier;
+
+	protected array $_class_abbreviations = [];
+
+	public ?CommandBusInterface $BUS = null;
+
+	public ?EE_Cart $CART = null;
+
+	public ?EE_Config $CFG = null;
+
+	public ?EE_Network_Config $NET_CFG = null;
+
+	/**
+	 * RegistryContainer for storing library classes in
+	 *
+	 * @var RegistryContainer|null $LIB
+	 */
+	public ?RegistryContainer $LIB = null;
+
+	/**
+	 * @var EE_Request_Handler|null $REQ
+	 * @deprecated 4.10.14.p
+	 */
+	public ?EE_Request_Handler $REQ = null;
+
+	public ?EE_Session $SSN = null;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities|null $CAP
+	 */
+	public ?EE_Capabilities$CAP = null;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager|null $MRM
+	 */
+	public ?EE_Message_Resource_Manager $MRM = null;
+
+	public ?Registry $AssetsRegistry = null;
+
+	/**
+	 * RegistryContainer for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var RegistryContainer|EE_Addon[] $addons
+	 */
+	public $addons = [];
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public array $models = [];
+
+	/**
+	 * @var RegistryContainer|EED_Module[] $modules
+	 */
+	public $modules = [];
+
+	/**
+	 * @var RegistryContainer|EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes = [];
+
+	/**
+	 * @var RegistryContainer|WP_Widget[] $widgets
+	 */
+	public $widgets = [];
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public array $non_abstract_db_models = [];
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static array $i18n_js_strings = [];
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var string $main_file
+	 */
+	public string $main_file = '';
+
+	/**
+	 * boolean flag to indicate whether to load/save dependencies from/to the cache
+	 *
+	 * @var bool $_cache_on
+	 */
+	protected bool $_cache_on = true;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	): EE_Registry {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param EE_Dependency_Map   $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map   = $dependency_map;
+		$this->mirror            = $mirror;
+		$this->class_cache       = $class_cache;
+		$this->object_identifier = $object_identifier;
+
+		$this->LIB        = new RegistryContainer();
+		$this->addons     = new RegistryContainer();
+		$this->modules    = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets    = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', [$this, 'initialize']);
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			[
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			]
+		);
+		$this->load_core('Base', [], true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'init']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = is_ssl() ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function sanitize_i18n_js_strings(): array
+	{
+		array_walk(EE_Registry::$i18n_js_strings, function (&$value) {
+			if (is_scalar($value)) {
+				$value = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+				// replace all escaped instances of \n with actual new lines
+				$value = str_replace("\\n", "\n", $value);
+			}
+		});
+		// sort the array by key in a case-insensitive manner
+		ksort(EE_Registry::$i18n_js_strings, SORT_NATURAL | SORT_FLAG_CASE);
+		return EE_Registry::$i18n_js_strings;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings(): string
+	{
+		$i18n_js_strings = wp_json_encode(EE_Registry::sanitize_i18n_js_strings());
+		return "/* <![CDATA[ */ var eei18n = $i18n_js_strings; /* ]]> */";
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->add($module_class, $module);
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module(string $module_name = '')
+	{
+		return $this->modules->get($module_name);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$core_paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			[
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'CPTs/',
+				EE_CORE . 'data_migration_scripts/',
+				EE_CORE . 'request_stack/',
+				EE_CORE . 'middleware/',
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_service(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$service_paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			[
+				EE_CORE . 'services/',
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms(string $class_name, $arguments = [])
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class|object|bool|null
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class(
+		string $class_name,
+		$arguments = [],
+		bool $from_db = false,
+		bool $cache = true,
+		bool $load_only = false
+	) {
+		$paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			[
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper(string $class_name, $arguments = [], bool $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = (array) apply_filters('FHEE__EE_Registry__load_helper__helper_paths', [EE_HELPERS]);
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib(string $class_name, $arguments = [], bool $load_only = false, bool $cache = true)
+	{
+		$paths = [
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages/',
+			EE_LIBRARIES . 'shortcodes/',
+			EE_LIBRARIES . 'qtips/',
+			EE_LIBRARIES . 'payment_methods/',
+		];
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			[
+				EE_MODELS,
+				EE_CORE,
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
+	{
+		$paths = [
+			EE_MODELS . 'fields/',
+			EE_MODELS . 'helpers/',
+			EE_MODELS . 'relations/',
+			EE_MODELS . 'strategies/',
+		];
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name(string $model_name): bool
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file(
+		string $path_to_file,
+		string $file_name,
+		string $type = '',
+		$arguments = [],
+		bool $load_only = true
+	) {
+		// retrieve instantiated class
+		return $this->_load(
+			(array) $path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_addon(
+		string $path_to_file,
+		string $class_name,
+		string $type = 'class',
+		$arguments = [],
+		bool $load_only = false
+	) {
+		// retrieve instantiated class
+		return $this->_load(
+			(array) $path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param string      $class_name Fully Qualified Class Name
+	 * @param array       $arguments  an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache      whether to cache the instantiated object for reuse
+	 * @param bool        $from_db    some classes are instantiated from the db
+	 *                                and thus call a different method to instantiate
+	 * @param bool        $load_only  if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon      if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed     null = failure to load or instantiate class object.
+	 *                                object = class loaded and instantiated successfully.
+	 *                                bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		string $class_name = '',
+		array $arguments = [],
+		bool $cache = false,
+		bool $from_db = false,
+		bool $load_only = false,
+		bool $addon = false
+	) {
+		$class_name   = ltrim($class_name, '\\');
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}                                                           // obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|mixed $class_name
+	 * @param array        $arguments
+	 * @param int          $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, int $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array  $file_paths         an array of paths to folders to look in
+	 * @param string $class_prefix       EE  or EEM or... ???
+	 * @param string $class_name         $class name
+	 * @param string $type               file type - core? class? helper? model?
+	 * @param mixed  $arguments          an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool   $from_db            some classes are instantiated from the db
+	 *                                   and thus call a different method to instantiate
+	 * @param bool   $cache              whether to cache the instantiated object for reuse
+	 * @param bool   $load_only          if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object          null   = failure to load or instantiate class object.
+	 *                                   object = class loaded and instantiated successfully.
+	 *                                   bool   = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		array $file_paths = [],
+		string $class_prefix = 'EE_',
+		string $class_name = '',
+		string $type = 'class',
+		array $arguments = [],
+		bool $from_db = false,
+		bool $cache = true,
+		bool $load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : [$arguments];
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
+	{
+		return $this->_class_abbreviations[ $class_name ] ?? $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		string $class_name,
+		string $class_prefix = '',
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
+			return $this->addons->get($class_name);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($object_identifier)) {
+			return $this->LIB->get($object_identifier);
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (
+				// request does not contain new arguments and therefore no args identifier
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		string $class_name,
+		bool $addon = false,
+		array $arguments = []
+	): bool {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && $this->addons->has($class_name)) {
+			$this->addons->remove($class_name);
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($class_name)) {
+			$this->LIB->remove($class_name);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		string $class_name,
+		string $class_prefix = '',
+		bool $from_db = false,
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->add($class_name, $class_obj);
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->add($class_name, $class_obj);
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: [$file_paths];
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(['/', '\\'], '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param string $path
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent(string $class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = [
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			];
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object(
+		string $class_name,
+		array $arguments = [],
+		string $type = '',
+		bool $from_db = false
+	) {
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: [$arguments];
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: [$arguments];
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (
+			empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array([$class_name, 'new_instance'], $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array([$class_name, 'instance'], $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			$args_passed_count = count($arguments);
+			$args_required_count = count($this->mirror->getRequiredParameters($class_name));
+			if ($args_passed_count < $args_required_count) {
+				throw new RuntimeException(
+					sprintf(
+						__(
+							'Invalid arguments supplied for the %1$s class, %2$s were required but %3$s were passed.',
+							'event_espresso'
+						),
+						$class_name,
+						$args_required_count,
+						$args_passed_count
+					)
+				);
+			}
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array): bool
+	{
+		return empty($array) || array_keys($array) === range(0, count($array) - 1);
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(
+		ReflectionClass $reflector,
+		string $class_name,
+		array $arguments = []
+	): array {
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all the constructors' expected parameters
+		foreach ($params as $index => $param) {
+			try {
+				// is this a dependency for a specific class ?
+				$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			} catch (ReflectionException $exception) {
+				// uh-oh... most likely a legacy class that has not been autoloaded
+				// let's try to derive the classname from what we have now
+				// and hope that the property var name is close to the class name
+				$param_class = $param->getName();
+				$param_class = str_replace('_', ' ', $param_class);
+				$param_class = ucwords($param_class);
+				$param_class = str_replace(' ', '_', $param_class);
+			}
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			if (
+				// param is not even a class
+				($param_class === null || $this->parameterIsPrimitive($param_class))
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& isset($arguments[ $argument_keys[ $index ] ])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			// parameter is type hinted as a class
+			if ($param_class !== null) {
+				// parameter exists as an incoming argument, AND it's the correct class
+				if (
+					array_key_exists($index, $argument_keys)
+					&& isset($arguments[ $argument_keys[ $index ] ])
+					&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+				) {
+					// skip this argument and move on to the next
+					continue;
+				}
+				// parameter should be injected
+				if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
+					$arguments = $this->_resolve_dependency(
+						$class_name,
+						$param_class,
+						$arguments,
+						$index
+					);
+				}
+			}
+			if (empty($arguments[ $index ])) {
+				$default_value = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+				// if there's no default value, and the incoming argument is an array (albeit empty), then use that
+				$arguments[ $index ] = $default_value === null
+									   && isset($arguments[ $index ])
+									   && is_array($arguments[ $index ])
+					? $arguments[ $index ]
+					: $default_value;
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						[],
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory(string $classname, array $arguments = [])
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon(string $class_name): ?EE_Addon
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		return $this->addons->{$class_name} ?? null;
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon(string $class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		$this->addons->remove($class_name);
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name(string $name): ?EE_Addon
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name(): array
+	{
+		$addons = [];
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset_model(string $model_name): ?EEM_Base
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_$model_name"
+			: $model_name;
+		if (! $this->LIB->has($model_class_name)) {
+			return null;
+		}
+		$model = $this->LIB->get($model_class_name);
+		if (! $model instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
+			$this->LIB->remove($model_class_name);
+			$this->LIB->add($model_class_name, $model->reset());
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $model;
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
+	{
+		$instance            = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (['LIB', 'modules'] as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _reset_and_unset_object($object, bool $reset_models): bool
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models(): array
+	{
+		$cpt_models = [];
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return EE_Config
+	 */
+	public static function CFG(): EE_Config
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @deprecated 4.9.62.p
+	 */
+	public function get_ReflectionClass(string $class_name): ReflectionClass
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
+
+	private function parameterIsPrimitive(?string $param_class): bool
+	{
+		return in_array(
+			$param_class,
+			[
+				'array',
+				'bool',
+				'float',
+				'int',
+				'string',
+			]
+		);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -260,7 +260,7 @@ 
      */
     public static function sanitize_i18n_js_strings(): array
     {
-        array_walk(EE_Registry::$i18n_js_strings, function (&$value) {
+        array_walk(EE_Registry::$i18n_js_strings, function(&$value) {
             if (is_scalar($value)) {
                 $value = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
                 // replace all escaped instances of \n with actual new lines
@@ -300,7 +300,7 @@ 
             $module_class = get_class($module);
             $this->modules->add($module_class, $module);
         } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -339,10 +339,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
+                EE_CORE.'CPTs/',
+                EE_CORE.'data_migration_scripts/',
+                EE_CORE.'request_stack/',
+                EE_CORE.'middleware/',
             ]
         );
         // retrieve instantiated class
@@ -378,7 +378,7 @@ 
         $service_paths = (array) apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             [
-                EE_CORE . 'services/',
+                EE_CORE.'services/',
             ]
         );
         // retrieve instantiated class
@@ -518,10 +518,10 @@ 
     {
         $paths = [
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
+            EE_LIBRARIES.'messages/',
+            EE_LIBRARIES.'shortcodes/',
+            EE_LIBRARIES.'qtips/',
+            EE_LIBRARIES.'payment_methods/',
         ];
         // retrieve instantiated class
         return $this->_load(
@@ -590,10 +590,10 @@ 
     public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
     {
         $paths = [
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
+            EE_MODELS.'fields/',
+            EE_MODELS.'helpers/',
+            EE_MODELS.'relations/',
+            EE_MODELS.'strategies/',
         ];
         // retrieve instantiated class
         return $this->_load(
@@ -617,7 +617,7 @@ 
      */
     public function is_model_name(string $model_name): bool
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -749,7 +749,7 @@ 
                 return $cached_class;
             }
         }                                                           // obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
         if ($loader instanceof Closure) {
             $class_obj = $loader($arguments);
         } else {
@@ -791,7 +791,7 @@ 
             case 1:
                 // if it's a FQCN then maybe the class is registered with a preceding \
                 $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -845,11 +845,11 @@ 
         // strip php file extension
         $class_name = str_replace('.php', '', trim($class_name));
         // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name   = $this->class_cache->getFqnForAlias($class_name);
         $class_exists = class_exists($class_name, false);
@@ -869,7 +869,7 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        if ( ! $class_exists) {
             // get full path to file
             $path = $this->_resolve_path($class_name, $type, $file_paths);
             // load the file
@@ -880,7 +880,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -908,7 +908,7 @@ 
      */
     protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
     {
-        return $this->_class_abbreviations[ $class_name ] ?? $default;
+        return $this->_class_abbreviations[$class_name] ?? $default;
     }
 
 
@@ -1041,7 +1041,7 @@ 
             $this->addons->add($class_name, $class_obj);
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
             $this->LIB->add($class_name, $class_obj);
         }
@@ -1072,13 +1072,13 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, '/').'/'.$class_name.'.'.$type.'php';
             // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
+            if (is_readable($file_paths[$key])) {
+                return $file_paths[$key];
             }
         }
         return false;
@@ -1103,7 +1103,7 @@ 
         // don't give up! you gotta...
         try {
             // does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // just in case the file has already been autoloaded,
                 // but discrepancies in the naming schema are preventing it from
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1121,7 +1121,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1164,8 +1164,8 @@ 
             $legacy_parent_class_map = [
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
             ];
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+            if (isset($legacy_parent_class_map[$class_name])) {
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
             }
         } catch (Exception $exception) {
         }
@@ -1318,7 +1318,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1348,7 +1348,7 @@ 
                 ($param_class === null || $this->parameterIsPrimitive($param_class))
                 // and something already exists in the incoming arguments for this param
                 && array_key_exists($index, $argument_keys)
-                && isset($arguments[ $argument_keys[ $index ] ])
+                && isset($arguments[$argument_keys[$index]])
             ) {
                 // so let's skip this argument and move on to the next
                 continue;
@@ -1358,8 +1358,8 @@ 
                 // parameter exists as an incoming argument, AND it's the correct class
                 if (
                     array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                    && isset($arguments[$argument_keys[$index]])
+                    && $arguments[$argument_keys[$index]] instanceof $param_class
                 ) {
                     // skip this argument and move on to the next
                     continue;
@@ -1374,17 +1374,17 @@ 
                     );
                 }
             }
-            if (empty($arguments[ $index ])) {
+            if (empty($arguments[$index])) {
                 $default_value = $this->mirror->getParameterDefaultValue(
                     $param,
                     $class_name,
                     $index
                 );
                 // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                       && isset($arguments[ $index ])
-                                       && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
+                $arguments[$index] = $default_value === null
+                                       && isset($arguments[$index])
+                                       && is_array($arguments[$index])
+                    ? $arguments[$index]
                     : $default_value;
             }
         }
@@ -1443,7 +1443,7 @@ 
         // did we successfully find the correct dependency ?
         if ($dependency instanceof $param_class) {
             // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
+            $arguments[$index] = $dependency;
         }
         return $arguments;
     }
@@ -1534,7 +1534,7 @@ 
     {
         $addons = [];
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1554,11 +1554,11 @@ 
         $model_class_name = strpos($model_name, 'EEM_') !== 0
             ? "EEM_$model_name"
             : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
+        if ( ! $this->LIB->has($model_class_name)) {
             return null;
         }
         $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
+        if ( ! $model instanceof EEM_Base) {
             return null;
         }
         // get that model reset it and make sure we nuke the old reference to it
@@ -1644,7 +1644,7 @@ 
      */
     private static function _reset_and_unset_object($object, bool $reset_models): bool
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1664,7 +1664,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;
@@ -1681,7 +1681,7 @@ 
         $cpt_models = [];
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
+                $cpt_models[$short_name] = $classname;
             }
         }
         return $cpt_models;

core/helpers/EEH_Template.helper.php

Indentation +953 added lines, -953 removed lines

@@ -9,36 +9,36 @@ 
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     */
-    function espresso_get_template_part($slug = '', $name = '')
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 */
+	function espresso_get_template_part($slug = '', $name = '')
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if (! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -52,661 +52,661 @@ 
  */
 class EEH_Template
 {
-    private static array $_espresso_themes = [];
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') === 'event_espresso';
-    }
-
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load its functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes(): array
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return [];
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
-            }
-            EEH_Template::$_espresso_themes = [];
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = '',
-        $name = '',
-        $template_args = [],
-        $return_string = false
-    ) {
-        do_action("get_template_part_$slug-$name", $slug, $name);
-        $template = $slug;
-        $name      = (string) $name;
-        if ($name != '') {
-            $template .= "-$name";
-        }
-        $template .= ".php";
-        // allow template parts to be turned off via something like:
-        // add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_$name", true)) {
-            return EEH_Template::locate_template($template, $template_args, true, $return_string);
-        }
-        return '';
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param array        $template_args   an array of arguments to be extracted for use in the template
-     * @param boolean      $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return string|true
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function locate_template(
-        $templates = [],
-        array $template_args = [],
-        bool $load = true,
-        bool $return_string = true,
-        bool $check_if_custom = false
-    ) {
-        $cache_id      = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
-        $template_path = TemplateCache::get($cache_id);
-        $template_path = $template_path ?: self::resolveTemplatePath($cache_id, (array) $templates, $check_if_custom);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            }
-            EEH_Template::display_template($template_path, $template_args);
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * Resolves the path of a template by checking various possible locations.
-     *
-     * This method checks for the existence of a template in several locations,
-     * including the current theme folder, the uploads directory, and the plugin's own template directory.
-     * It uses the provided cache ID to store and retrieve the resolved path from a cache for performance.
-     * If the template is not found in any of the checked locations, an empty string is returned.
-     *
-     * @param string $cache_id        The ID used for caching the resolved path.
-     * @param array  $templates       An array of template file names to search for.
-     * @param bool $check_if_custom   If true, the method will only check if a custom template exists
-     *                                and won't include core plugin folders.
-     * @return string The resolved template path, or an empty string if the template was not found.
-     * @since 5.0.21.p
-     */
-    private static function resolveTemplatePath(string $cache_id, array $templates, bool $check_if_custom): string
-    {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = $templates ? locate_template($templates) : '';
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                $loader = LoaderFactory::getLoader();
-                /** @var RequestInterface $request */
-                $request = $loader->getShared(RequestInterface::class);
-                // get post_type
-                $post_type = $request->getRequestParam('post_type');
-                /** @var CustomPostTypeDefinitions $custom_post_types */
-                $custom_post_types = $loader->getShared(CustomPostTypeDefinitions::class);
-                // get array of EE Custom Post Types
-                $EE_CPTs = $custom_post_types->getDefinitions();
-                // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates[]       = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-            // array of paths to folders that may contain templates
-            $template_folder_paths = [];
-
-            // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                ];
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = (array) apply_filters(
-                'FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths
-            );
-
-            // array to hold all possible template paths
-            $full_template_paths = [];
-            $file_name           = '';
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        [$template_folder_path, $template_path_minus_file_name]
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths,
-                $file_name
-            );
-            // now loop through our final array of template location paths and check each location
-            foreach ((array) $full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
-                    TemplateCache::set($cache_id, $template_path);
-                    break;
-                }
-            }
-        }
-
-        // Display a deprecated notice if the template file is located in the WordPress uploads directory
-        if (strpos($template_path, 'wp-content/uploads/espresso') !== false) {
-            EE_Error::doing_it_wrong(
-                __CLASS__,
-                esc_html__(
-                    'The use of the WordPress uploads directory as a location to override template files has been deprecated.',
-                    'event_espresso'
-                ),
-                '5.0.0'
-            );
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        return $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset      = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
-     * @param array       $template_args    an array of arguments to be extracted for use in the template
-     * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return string
-     * @throws DomainException
-     */
-    public static function display_template(
-        $template_path = '',
-        $template_args = [],
-        $return_string = false,
-        $throw_exceptions = false
-    ) {
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
-            // ignore whether template is accessible ?
-            if ($throw_exceptions) {
-                throw new DomainException(
-                    esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
-                );
-            }
-            return '';
-        }
-
-        extract($template_args, EXTR_SKIP);
-        // because we might want to return a string, we are going to capture the output
-        ob_start();
-        include($template_path);
-        $template = ob_get_clean();
-
-        if ($return_string) {
-            return $template;
-        }
-        echo wp_kses($template, AllowedTags::getWithFullTags());
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            // no specifics just yet...
-            $class = strtolower(str_replace('_', '-', $obj_class));
-            $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param float   $amount       raw money value
-     * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string  $CNT_ISO      2-letter ISO code for a country
-     * @param string  $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        // ensure amount is float
-        $amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
-            return esc_html($amount_formatted);
-        }
-        try {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-        } catch (Exception $e) {
-            // eat exception
-            $mny = null;
-        }
-        // verify results
-        if (! $mny instanceof EE_Currency_Config) {
-            // set default config country currency settings
-            $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        // format float
-        $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-        // add formatting ?
-        if (! $return_raw) {
-            // add currency sign
-            if ($mny->sign_b4) {
-                if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
-                } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                }
-            } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
-            }
-
-            // filter to allow global setting of display_code
-            $display_code = (bool) apply_filters(
-                'FHEE__EEH_Template__format_currency__display_code',
-                $display_code
-            );
-
-            // add currency code ?
-            $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
-                : $amount_formatted;
-        }
-        // filter results
-        $amount_formatted = apply_filters(
-            'FHEE__EEH_Template__format_currency__amount_formatted',
-            $amount_formatted,
-            $mny,
-            $return_raw
-        );
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param boolean $plural     Whether to return plural or not
-     * @param string  $schema     'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     * @throws EE_Error
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$status_id => esc_html__('unknown', 'event_espresso')],
-            $plural,
-            $schema
-        );
-        return $status[ $status_id ];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param string $url   the url for the link, note that `esc_url` will be called on it
-     * @param string $label What is the label you want displayed for the button
-     * @param string $class what class is used for the button (defaults to 'button--primary')
-     * @param string $icon
-     * @param string $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if (! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        // sanitize & escape
-        $id    = sanitize_title_with_dashes($label);
-        $url   = esc_url_raw($url);
-        $class = esc_attr($class);
-        $title = esc_attr($title);
-        $class .= $title ? ' ee-aria-tooltip' : '';
-        $title = $title ? " aria-label='{$title}'" : '';
-        $label = esc_html($label);
-        return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param string      $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page    = $page ?: $request->getRequestParam('page', '', 'key');
-        $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '
+	private static array $_espresso_themes = [];
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') === 'event_espresso';
+	}
+
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load its functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes(): array
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return [];
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[ $key ]);
+			}
+			EEH_Template::$_espresso_themes = [];
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = '',
+		$name = '',
+		$template_args = [],
+		$return_string = false
+	) {
+		do_action("get_template_part_$slug-$name", $slug, $name);
+		$template = $slug;
+		$name      = (string) $name;
+		if ($name != '') {
+			$template .= "-$name";
+		}
+		$template .= ".php";
+		// allow template parts to be turned off via something like:
+		// add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_$name", true)) {
+			return EEH_Template::locate_template($template, $template_args, true, $return_string);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param array        $template_args   an array of arguments to be extracted for use in the template
+	 * @param boolean      $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return string|true
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function locate_template(
+		$templates = [],
+		array $template_args = [],
+		bool $load = true,
+		bool $return_string = true,
+		bool $check_if_custom = false
+	) {
+		$cache_id      = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
+		$template_path = TemplateCache::get($cache_id);
+		$template_path = $template_path ?: self::resolveTemplatePath($cache_id, (array) $templates, $check_if_custom);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			}
+			EEH_Template::display_template($template_path, $template_args);
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * Resolves the path of a template by checking various possible locations.
+	 *
+	 * This method checks for the existence of a template in several locations,
+	 * including the current theme folder, the uploads directory, and the plugin's own template directory.
+	 * It uses the provided cache ID to store and retrieve the resolved path from a cache for performance.
+	 * If the template is not found in any of the checked locations, an empty string is returned.
+	 *
+	 * @param string $cache_id        The ID used for caching the resolved path.
+	 * @param array  $templates       An array of template file names to search for.
+	 * @param bool $check_if_custom   If true, the method will only check if a custom template exists
+	 *                                and won't include core plugin folders.
+	 * @return string The resolved template path, or an empty string if the template was not found.
+	 * @since 5.0.21.p
+	 */
+	private static function resolveTemplatePath(string $cache_id, array $templates, bool $check_if_custom): string
+	{
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = $templates ? locate_template($templates) : '';
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				$loader = LoaderFactory::getLoader();
+				/** @var RequestInterface $request */
+				$request = $loader->getShared(RequestInterface::class);
+				// get post_type
+				$post_type = $request->getRequestParam('post_type');
+				/** @var CustomPostTypeDefinitions $custom_post_types */
+				$custom_post_types = $loader->getShared(CustomPostTypeDefinitions::class);
+				// get array of EE Custom Post Types
+				$EE_CPTs = $custom_post_types->getDefinitions();
+				// build template name based on request
+				if (isset($EE_CPTs[ $post_type ])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates[]       = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+			// array of paths to folders that may contain templates
+			$template_folder_paths = [];
+
+			// add core plugin folders for checking only if we're not $check_if_custom
+			if (! $check_if_custom) {
+				$core_paths            = [
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				];
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = (array) apply_filters(
+				'FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths
+			);
+
+			// array to hold all possible template paths
+			$full_template_paths = [];
+			$file_name           = '';
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						[$template_folder_path, $template_path_minus_file_name]
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths,
+				$file_name
+			);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
+					TemplateCache::set($cache_id, $template_path);
+					break;
+				}
+			}
+		}
+
+		// Display a deprecated notice if the template file is located in the WordPress uploads directory
+		if (strpos($template_path, 'wp-content/uploads/espresso') !== false) {
+			EE_Error::doing_it_wrong(
+				__CLASS__,
+				esc_html__(
+					'The use of the WordPress uploads directory as a location to override template files has been deprecated.',
+					'event_espresso'
+				),
+				'5.0.0'
+			);
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		return $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset      = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
+	 * @param array       $template_args    an array of arguments to be extracted for use in the template
+	 * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function display_template(
+		$template_path = '',
+		$template_args = [],
+		$return_string = false,
+		$throw_exceptions = false
+	) {
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if (! $template_path || ! is_readable($template_path)) {
+			// ignore whether template is accessible ?
+			if ($throw_exceptions) {
+				throw new DomainException(
+					esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
+				);
+			}
+			return '';
+		}
+
+		extract($template_args, EXTR_SKIP);
+		// because we might want to return a string, we are going to capture the output
+		ob_start();
+		include($template_path);
+		$template = ob_get_clean();
+
+		if ($return_string) {
+			return $template;
+		}
+		echo wp_kses($template, AllowedTags::getWithFullTags());
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			// no specifics just yet...
+			$class = strtolower(str_replace('_', '-', $obj_class));
+			$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param float   $amount       raw money value
+	 * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string  $CNT_ISO      2-letter ISO code for a country
+	 * @param string  $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		// ensure amount is float
+		$amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number, or was amount converted to a string like "free" ?
+		if (! is_float($amount_formatted)) {
+			return esc_html($amount_formatted);
+		}
+		try {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+		} catch (Exception $e) {
+			// eat exception
+			$mny = null;
+		}
+		// verify results
+		if (! $mny instanceof EE_Currency_Config) {
+			// set default config country currency settings
+			$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		// format float
+		$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+		// add formatting ?
+		if (! $return_raw) {
+			// add currency sign
+			if ($mny->sign_b4) {
+				if ($amount >= 0) {
+					$amount_formatted = $mny->sign . $amount_formatted;
+				} else {
+					$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+				}
+			} else {
+				$amount_formatted = $amount_formatted . $mny->sign;
+			}
+
+			// filter to allow global setting of display_code
+			$display_code = (bool) apply_filters(
+				'FHEE__EEH_Template__format_currency__display_code',
+				$display_code
+			);
+
+			// add currency code ?
+			$amount_formatted = $display_code
+				? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
+				: $amount_formatted;
+		}
+		// filter results
+		$amount_formatted = apply_filters(
+			'FHEE__EEH_Template__format_currency__amount_formatted',
+			$amount_formatted,
+			$mny,
+			$return_raw
+		);
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param boolean $plural     Whether to return plural or not
+	 * @param string  $schema     'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 * @throws EE_Error
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$status_id => esc_html__('unknown', 'event_espresso')],
+			$plural,
+			$schema
+		);
+		return $status[ $status_id ];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param string $label What is the label you want displayed for the button
+	 * @param string $class what class is used for the button (defaults to 'button--primary')
+	 * @param string $icon
+	 * @param string $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if (! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		// sanitize & escape
+		$id    = sanitize_title_with_dashes($label);
+		$url   = esc_url_raw($url);
+		$class = esc_attr($class);
+		$title = esc_attr($title);
+		$class .= $title ? ' ee-aria-tooltip' : '';
+		$title = $title ? " aria-label='{$title}'" : '';
+		$label = esc_html($label);
+		return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param string      $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page    = $page ?: $request->getRequestParam('page', '', 'key');
+		$action  = $action ?: $request->getRequestParam('action', 'default', 'key');
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '
             <a id="' . esc_attr($help_tab_lnk) . '"
                class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon) . '"
                aria-label="' . esc_attr__(
-                'Click to open the \'Help\' tab for more information about this feature.',
-                'event_espresso'
-            ) . '"
+				'Click to open the \'Help\' tab for more information about this feature.',
+				'event_espresso'
+			) . '"
             >
                 ' . wp_kses($help_text, AllowedTags::getAllowedTags()) . '
             </a>';
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param array  $status_array   array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @return string               html structure for status.
-     * @throws EE_Error
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if (! is_array($status_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                    'event_espresso'
-                )
-            );
-        }
-
-        $content = '
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param array  $status_array   array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @return string               html structure for status.
+	 * @throws EE_Error
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if (! is_array($status_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+					'event_espresso'
+				)
+			);
+		}
+
+		$content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
                     ' . esc_html__('Status Legend', 'event_espresso') . '
                 </h4>
                 <dl class="ee-list-table-legend">';
 
-        foreach ($status_array as $item => $status) {
-            $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
+		foreach ($status_array as $item => $status) {
+			$active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
+			$content      .= '
                     <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
                         <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
                         <span class="ee-legend-description">
                             ' . EEH_Template::pretty_status($status, false, 'sentence') . '
                         </span>
                     </dt>';
-        }
+		}
 
-        $content .= '
+		$content .= '
                 </dl>
             </div>
 ';
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array) $data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) { ?>
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array) $data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) { ?>
                 <table class="widefat">
                     <tbody>
                         <?php foreach ($data as $data_key => $data_values) { ?>
@@ -724,304 +724,304 @@ 
             <?php } else { ?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
             <?php }
-        } else {
-            // simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @see   self:get_paging_html() for argument docs.
-     * @since 4.4.0
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = []
-    ) {
-        echo self::get_paging_html(
-            $total_items,
-            $current,
-            $per_page,
-            $url,
-            $show_num_field,
-            $paged_arg_name,
-            $items_label
-        );
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @param int    $total_items       How many total items there are to page.
-     * @param int    $current           What the current page is.
-     * @param int    $per_page          How many items per page.
-     * @param string $url               What the base url for page links is.
-     * @param bool   $show_num_field    Whether to show the input for changing page number.
-     * @param string $paged_arg_name    The name of the key for the paged query argument.
-     * @param array  $items_label       An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     */
-    public static function get_paging_html(
-        int $total_items,
-        int $current,
-        int $per_page,
-        string $url,
-        bool $show_num_field = true,
-        string $paged_arg_name = 'paged',
-        array $items_label = [],
-        string $button_size = 'small'
-    ): string {
-        $page_links     = [];
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        // filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (
-            empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = [
-                'single' => esc_html__('1 item', 'event_espresso'),
-                'plural' => esc_html__('%s items', 'event_espresso'),
-            ];
-        } else {
-            $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            ];
-        }
-
-        $total_pages = (int) ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        $disable_first = $current === 1 ? 'disabled' : '';
-        $disable_last  = $current === $total_pages ? 'disabled' : '';
-
-        $button_size    = in_array($button_size, ['tiny', 'small', 'default', 'big']) ? $button_size : 'small';
-        $button_classes = "button button--secondary button--icon-only button--$button_size";
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("first-page $button_classes $disable_first"),
-            esc_attr__('Go to the first page', 'event_espresso'),
-            esc_url_raw(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("prev-page $button_classes $disable_first"),
-            esc_attr__('Go to the previous page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        $html_current_page = $show_num_field
-            ? sprintf(
-                "<input class='current-page ee-input-size--small' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page', 'event_espresso'),
-                esc_attr($current),
-                strlen($total_pages)
-            )
-            : $current;
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
-            "{$html_current_page}<span class='paging-input-of'>",
-            "</span>{$html_total_pages}",
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("next-page $button_classes $disable_last"),
-            esc_attr__('Go to the next page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
-            esc_attr("last-page $button_classes $disable_last"),
-            esc_attr__('Go to the last page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-
-        $page_class = ' no-pages';
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @param array  $query_args
-     * @return string
-     */
-    public static function powered_by_event_espresso(
-        string $wrap_class = '',
-        string $wrap_id = '',
-        array $query_args = []
-    ): string {
-        $request = LoaderFactory::getShared(RequestInterface::class);
-        if (
-            $request->isActivation()
-            || strpos($request->requestUri(true), 'wp-admin/update.php') !== false
-        ){
-            return '';
-        }
-        $cache_id = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
-        $cache    = TemplateCache::get($cache_id);
-        if ($cache) {
-            return $cache;
-        }
-
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (
-            ! $admin
-            && ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            [
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ],
-            $query_args
-        );
-        $powered_by = apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
-        );
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        $template   = (string) apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<$tag$attributes>",
-                "<a href=\"$url\" target=\"_blank\" rel=\"nofollow\">$powered_by</a></$tag>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-        TemplateCache::set($cache_id, $template);
-        return $template;
-    }
-
-
-    /**
-     * @param string $image_name
-     * @return string|null
-     * @since   4.10.14.p
-     */
-    public static function getScreenshotUrl($image_name)
-    {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
-    }
+		} else {
+			// simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @see   self:get_paging_html() for argument docs.
+	 * @since 4.4.0
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = []
+	) {
+		echo self::get_paging_html(
+			$total_items,
+			$current,
+			$per_page,
+			$url,
+			$show_num_field,
+			$paged_arg_name,
+			$items_label
+		);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @param int    $total_items       How many total items there are to page.
+	 * @param int    $current           What the current page is.
+	 * @param int    $per_page          How many items per page.
+	 * @param string $url               What the base url for page links is.
+	 * @param bool   $show_num_field    Whether to show the input for changing page number.
+	 * @param string $paged_arg_name    The name of the key for the paged query argument.
+	 * @param array  $items_label       An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 */
+	public static function get_paging_html(
+		int $total_items,
+		int $current,
+		int $per_page,
+		string $url,
+		bool $show_num_field = true,
+		string $paged_arg_name = 'paged',
+		array $items_label = [],
+		string $button_size = 'small'
+	): string {
+		$page_links     = [];
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		// filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (
+			empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = [
+				'single' => esc_html__('1 item', 'event_espresso'),
+				'plural' => esc_html__('%s items', 'event_espresso'),
+			];
+		} else {
+			$items_label = [
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			];
+		}
+
+		$total_pages = (int) ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		$disable_first = $current === 1 ? 'disabled' : '';
+		$disable_last  = $current === $total_pages ? 'disabled' : '';
+
+		$button_size    = in_array($button_size, ['tiny', 'small', 'default', 'big']) ? $button_size : 'small';
+		$button_classes = "button button--secondary button--icon-only button--$button_size";
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("first-page $button_classes $disable_first"),
+			esc_attr__('Go to the first page', 'event_espresso'),
+			esc_url_raw(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("prev-page $button_classes $disable_first"),
+			esc_attr__('Go to the previous page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		$html_current_page = $show_num_field
+			? sprintf(
+				"<input class='current-page ee-input-size--small' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page', 'event_espresso'),
+				esc_attr($current),
+				strlen($total_pages)
+			)
+			: $current;
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
+			"{$html_current_page}<span class='paging-input-of'>",
+			"</span>{$html_total_pages}",
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("next-page $button_classes $disable_last"),
+			esc_attr__('Go to the next page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" aria-label="%s" href="%s"><span class="ee-pagination-arrow">%s</span></a>',
+			esc_attr("last-page $button_classes $disable_last"),
+			esc_attr__('Go to the last page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+
+		$page_class = ' no-pages';
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @param array  $query_args
+	 * @return string
+	 */
+	public static function powered_by_event_espresso(
+		string $wrap_class = '',
+		string $wrap_id = '',
+		array $query_args = []
+	): string {
+		$request = LoaderFactory::getShared(RequestInterface::class);
+		if (
+			$request->isActivation()
+			|| strpos($request->requestUri(true), 'wp-admin/update.php') !== false
+		){
+			return '';
+		}
+		$cache_id = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
+		$cache    = TemplateCache::get($cache_id);
+		if ($cache) {
+			return $cache;
+		}
+
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (
+			! $admin
+			&& ! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			[
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			],
+			$query_args
+		);
+		$powered_by = apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+		);
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		$template   = (string) apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<$tag$attributes>",
+				"<a href=\"$url\" target=\"_blank\" rel=\"nofollow\">$powered_by</a></$tag>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+		TemplateCache::set($cache_id, $template);
+		return $template;
+	}
+
+
+	/**
+	 * @param string $image_name
+	 * @return string|null
+	 * @since   4.10.14.p
+	 */
+	public static function getScreenshotUrl($image_name)
+	{
+		return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+	}
 }
 
 
 if (! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            [
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            ]
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			[
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			]
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }

Spacing +57 added lines, -57 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if (! function_exists('espresso_get_template_part')) {
+if ( ! function_exists('espresso_get_template_part')) {
     /**
      * espresso_get_template_part
      * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -24,7 +24,7 @@ 
 }
 
 
-if (! function_exists('espresso_get_object_css_class')) {
+if ( ! function_exists('espresso_get_object_css_class')) {
     /**
      * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
      *
@@ -74,9 +74,9 @@ 
      */
     public static function load_espresso_theme_functions()
     {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php');
             }
         }
     }
@@ -90,16 +90,16 @@ 
     public static function get_espresso_themes(): array
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return [];
             }
             if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
+                unset($espresso_themes[$key]);
             }
             EEH_Template::$_espresso_themes = [];
             foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
             }
         }
         return EEH_Template::$_espresso_themes;
@@ -126,7 +126,7 @@ 
     ) {
         do_action("get_template_part_$slug-$name", $slug, $name);
         $template = $slug;
-        $name      = (string) $name;
+        $name = (string) $name;
         if ($name != '') {
             $template .= "-$name";
         }
@@ -245,10 +245,10 @@ 
                 // get array of EE Custom Post Types
                 $EE_CPTs = $custom_post_types->getDefinitions();
                 // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
+                if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates[]       = $archive_or_single . '-' . $post_type . '.php';
+                    $templates[]       = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -257,12 +257,12 @@ 
             $template_folder_paths = [];
 
             // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
+            if ( ! $check_if_custom) {
+                $core_paths = [
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 ];
@@ -295,10 +295,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -306,7 +306,7 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().'/'.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters(
@@ -363,7 +363,7 @@ 
                 }
             }
             $common_base_path .= $directory;
-            $last_offset      = $index + 1;
+            $last_offset = $index + 1;
         }
         return substr($common_base_path, 0, -1);
     }
@@ -400,7 +400,7 @@ 
         $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
 
         // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
+        if ( ! $template_path || ! is_readable($template_path)) {
             // ignore whether template is accessible ?
             if ($throw_exceptions) {
                 throw new DomainException(
@@ -437,11 +437,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -449,9 +449,9 @@ 
             // depending on the type of object...
             // no specifics just yet...
             $class = strtolower(str_replace('_', '-', $obj_class));
-            $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+            $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -486,7 +486,7 @@ 
         // filter raw amount (allows 0.00 to be changed to "free" for example)
         $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
         // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
+        if ( ! is_float($amount_formatted)) {
             return esc_html($amount_formatted);
         }
         try {
@@ -497,7 +497,7 @@ 
             $mny = null;
         }
         // verify results
-        if (! $mny instanceof EE_Currency_Config) {
+        if ( ! $mny instanceof EE_Currency_Config) {
             // set default config country currency settings
             $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                 ? EE_Registry::instance()->CFG->currency
@@ -506,16 +506,16 @@ 
         // format float
         $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
         // add formatting ?
-        if (! $return_raw) {
+        if ( ! $return_raw) {
             // add currency sign
             if ($mny->sign_b4) {
                 if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
+                    $amount_formatted = $mny->sign.$amount_formatted;
                 } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                    $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                 }
             } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
+                $amount_formatted = $amount_formatted.$mny->sign;
             }
 
             // filter to allow global setting of display_code
@@ -526,7 +526,7 @@ 
 
             // add currency code ?
             $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">' . $mny->code . '</span>'
+                ? $amount_formatted.' <span class="'.$cur_code_span_class.'">'.$mny->code.'</span>'
                 : $amount_formatted;
         }
         // filter results
@@ -562,7 +562,7 @@ 
             $plural,
             $schema
         );
-        return $status[ $status_id ];
+        return $status[$status_id];
     }
 
 
@@ -579,14 +579,14 @@ 
     public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
     {
         $icon_html = '';
-        if (! empty($icon)) {
+        if ( ! empty($icon)) {
             $dashicons = preg_split("(ee-icon |dashicons )", $icon);
             $dashicons = array_filter($dashicons);
             $count     = count($dashicons);
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
@@ -625,18 +625,18 @@ 
         $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? 'dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
         return '
-            <a id="' . esc_attr($help_tab_lnk) . '"
-               class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon) . '"
+            <a id="' . esc_attr($help_tab_lnk).'"
+               class="espresso-help-tab-lnk ee-help-btn ee-aria-tooltip dashicons ' . esc_attr($icon).'"
                aria-label="' . esc_attr__(
                 'Click to open the \'Help\' tab for more information about this feature.',
                 'event_espresso'
-            ) . '"
+            ).'"
             >
-                ' . wp_kses($help_text, AllowedTags::getAllowedTags()) . '
+                ' . wp_kses($help_text, AllowedTags::getAllowedTags()).'
             </a>';
     }
 
@@ -657,7 +657,7 @@ 
      */
     public static function status_legend($status_array, $active_status = '')
     {
-        if (! is_array($status_array)) {
+        if ( ! is_array($status_array)) {
             throw new EE_Error(
                 esc_html__(
                     'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
@@ -669,17 +669,17 @@ 
         $content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
-                    ' . esc_html__('Status Legend', 'event_espresso') . '
+                    ' . esc_html__('Status Legend', 'event_espresso').'
                 </h4>
                 <dl class="ee-list-table-legend">';
 
         foreach ($status_array as $item => $status) {
             $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
-                    <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
-                        <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
+            $content .= '
+                    <dt id="' . esc_attr('ee-legend-item-tooltip-'.$item).'" '.$active_class.'>
+                        <span class="' . esc_attr('ee-status-legend ee-status-bg--'.$status).'"></span>
                         <span class="ee-legend-description">
-                            ' . EEH_Template::pretty_status($status, false, 'sentence') . '
+                            ' . EEH_Template::pretty_status($status, false, 'sentence').'
                         </span>
                     </dt>';
         }
@@ -822,8 +822,8 @@ 
             ];
         } else {
             $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             ];
         }
 
@@ -835,7 +835,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         $disable_first = $current === 1 ? 'disabled' : '';
         $disable_last  = $current === $total_pages ? 'disabled' : '';
@@ -872,7 +872,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
             "{$html_current_page}<span class='paging-input-of'>",
             "</span>{$html_total_pages}",
@@ -896,14 +896,14 @@ 
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
 
         $page_class = ' no-pages';
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -922,7 +922,7 @@ 
         if (
             $request->isActivation()
             || strpos($request->requestUri(true), 'wp-admin/update.php') !== false
-        ){
+        ) {
             return '';
         }
         $cache_id = TemplateCache::generateCacheID(__FUNCTION__, func_get_args());
@@ -958,7 +958,7 @@ 
         );
         $powered_by = apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso'
         );
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
@@ -989,12 +989,12 @@ 
      */
     public static function getScreenshotUrl($image_name)
     {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+        return esc_url_raw(EE_GLOBAL_ASSETS_URL.'images/screenshots/'.$image_name.'.jpg');
     }
 }
 
 
-if (! function_exists('espresso_pagination')) {
+if ( ! function_exists('espresso_pagination')) {
     /**
      *    espresso_pagination
      *
@@ -1022,6 +1022,6 @@ 
                 'add_fragment' => '',
             ]
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }

core/libraries/form_sections/payment_methods/BillingInfoSanitizer.php

Indentation +31 added lines, -31 removed lines

@@ -21,35 +21,35 @@
  */
 class BillingInfoSanitizer
 {
-    /**
-     * @param EE_Form_Section_Proper $form_section
-     * @param bool                   $found_cc_data
-     * @return bool|mixed
-     * @throws EE_Error
-     */
-    public static function displaySanitizedBillingInfo(EE_Form_Section_Proper $form_section, bool $found_cc_data = false)
-    {
-        foreach ($form_section->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if (
-                    $subsection->get_sensitive_data_removal_strategy() instanceof EE_All_Sensitive_Data_Removal
-                    || $subsection->get_sensitive_data_removal_strategy() instanceof EE_CCV_Sensitive_Data_Removal
-                    || $subsection->get_display_strategy() instanceof EE_Hidden_Display_Strategy
-                ) {
-                    continue;
-                }
-                if ($subsection->get_sensitive_data_removal_strategy() instanceof EE_Credit_Card_Sensitive_Data_Removal) {
-                    $found_cc_data = true;
-                }
-                $subsection->add_html_label_class('admin-side-mbox-label-spn lt-grey-txt');
-                echo wp_kses($subsection->get_html_for_label(), AllowedTags::getWithFormTags());
-                echo "<span class='admin-side-mbox-value-spn'>";
-                echo wp_kses($subsection->pretty_value(), AllowedTags::getWithFormTags());
-                echo "</span>";
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $found_cc_data = BillingInfoSanitizer::displaySanitizedBillingInfo($subsection, $found_cc_data);
-            }
-        }
-        return $found_cc_data;
-    }
+	/**
+	 * @param EE_Form_Section_Proper $form_section
+	 * @param bool                   $found_cc_data
+	 * @return bool|mixed
+	 * @throws EE_Error
+	 */
+	public static function displaySanitizedBillingInfo(EE_Form_Section_Proper $form_section, bool $found_cc_data = false)
+	{
+		foreach ($form_section->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if (
+					$subsection->get_sensitive_data_removal_strategy() instanceof EE_All_Sensitive_Data_Removal
+					|| $subsection->get_sensitive_data_removal_strategy() instanceof EE_CCV_Sensitive_Data_Removal
+					|| $subsection->get_display_strategy() instanceof EE_Hidden_Display_Strategy
+				) {
+					continue;
+				}
+				if ($subsection->get_sensitive_data_removal_strategy() instanceof EE_Credit_Card_Sensitive_Data_Removal) {
+					$found_cc_data = true;
+				}
+				$subsection->add_html_label_class('admin-side-mbox-label-spn lt-grey-txt');
+				echo wp_kses($subsection->get_html_for_label(), AllowedTags::getWithFormTags());
+				echo "<span class='admin-side-mbox-value-spn'>";
+				echo wp_kses($subsection->pretty_value(), AllowedTags::getWithFormTags());
+				echo "</span>";
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$found_cc_data = BillingInfoSanitizer::displaySanitizedBillingInfo($subsection, $found_cc_data);
+			}
+		}
+		return $found_cc_data;
+	}
 }

core/libraries/form_sections/payment_methods/EE_Billing_Attendee_Info_Form.form.php

Indentation +212 added lines, -212 removed lines

@@ -13,227 +13,227 @@
  */
 class EE_Billing_Attendee_Info_Form extends EE_Billing_Info_Form
 {
-    /**
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param array             $options_array @see EE_Form_Section_Proper::__construct()
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Payment_Method $payment_method, $options_array = [])
-    {
-        $options_array['subsections'] = array_merge(
-            [
-                'first_name' => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-fname',
-                        'html_label_text' => esc_html__('First Name', 'event_espresso'),
-                    ]
-                ),
-                'last_name'  => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-lname',
-                        'html_label_text' => esc_html__('Last Name', 'event_espresso'),
-                    ]
-                ),
-                'email'      => new EE_Email_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-email',
-                        'html_label_text' => esc_html__('Email', 'event_espresso'),
-                    ]
-                ),
-                'address'    => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Address', 'event_espresso'),
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-address',
-                    ]
-                ),
-                'address2'   => new EE_Text_Input(
-                    [
-                        'html_label_text' => esc_html__('Address 2', 'event_espresso'),
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-address2',
-                    ]
-                ),
-                'city'       => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-city',
-                        'html_label_text' => esc_html__('City', 'event_espresso'),
-                    ]
-                ),
-                'state'      => apply_filters(
-                    'FHEE__EE_Billing_Attendee_Info_Form__state_field',
-                    new EE_State_Select_Input(
-                        null, [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-state',
-                        'html_label_text' => esc_html__('State', 'event_espresso'),
-                    ]
-                    )
-                ),
-                'country'    => apply_filters(
-                    'FHEE__EE_Billing_Attendee_Info_Form__country_field',
-                    new EE_Country_Select_Input(
-                        null, [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-country',
-                        'html_label_text' => esc_html__('Country', 'event_espresso'),
-                    ]
-                    )
-                ),
-                'zip'        => new EE_Text_Input(
-                    [
-                        'required'        => true,
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-zip',
-                        'html_label_text' => esc_html__('Zip', 'event_espresso'),
-                    ]
-                ),
-                'phone'      => new EE_Text_Input(
-                    [
-                        'html_class'      => 'ee-billing-qstn ee-billing-qstn-phone',
-                        'html_label_text' => esc_html__('Phone', 'event_espresso'),
-                    ]
-                ),
-            ],
-            $options_array['subsections'] ?? []
-        );
+	/**
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param array             $options_array @see EE_Form_Section_Proper::__construct()
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Payment_Method $payment_method, $options_array = [])
+	{
+		$options_array['subsections'] = array_merge(
+			[
+				'first_name' => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-fname',
+						'html_label_text' => esc_html__('First Name', 'event_espresso'),
+					]
+				),
+				'last_name'  => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-lname',
+						'html_label_text' => esc_html__('Last Name', 'event_espresso'),
+					]
+				),
+				'email'      => new EE_Email_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-email',
+						'html_label_text' => esc_html__('Email', 'event_espresso'),
+					]
+				),
+				'address'    => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Address', 'event_espresso'),
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-address',
+					]
+				),
+				'address2'   => new EE_Text_Input(
+					[
+						'html_label_text' => esc_html__('Address 2', 'event_espresso'),
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-address2',
+					]
+				),
+				'city'       => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-city',
+						'html_label_text' => esc_html__('City', 'event_espresso'),
+					]
+				),
+				'state'      => apply_filters(
+					'FHEE__EE_Billing_Attendee_Info_Form__state_field',
+					new EE_State_Select_Input(
+						null, [
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-state',
+						'html_label_text' => esc_html__('State', 'event_espresso'),
+					]
+					)
+				),
+				'country'    => apply_filters(
+					'FHEE__EE_Billing_Attendee_Info_Form__country_field',
+					new EE_Country_Select_Input(
+						null, [
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-country',
+						'html_label_text' => esc_html__('Country', 'event_espresso'),
+					]
+					)
+				),
+				'zip'        => new EE_Text_Input(
+					[
+						'required'        => true,
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-zip',
+						'html_label_text' => esc_html__('Zip', 'event_espresso'),
+					]
+				),
+				'phone'      => new EE_Text_Input(
+					[
+						'html_class'      => 'ee-billing-qstn ee-billing-qstn-phone',
+						'html_label_text' => esc_html__('Phone', 'event_espresso'),
+					]
+				),
+			],
+			$options_array['subsections'] ?? []
+		);
 
-        parent::__construct($payment_method, $options_array);
-    }
+		parent::__construct($payment_method, $options_array);
+	}
 
 
-    /**
-     * Sets the defaults for the billing form according to the attendee's details
-     *
-     * @param EE_Attendee $attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function populate_from_attendee(EE_Attendee $attendee)
-    {
-        /** @var $attendee EE_Attendee */
-        $attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
-        $this->populate_defaults(
-            apply_filters(
-                'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
-                [
-                    'first_name' => $attendee->fname(),
-                    'last_name'  => $attendee->lname(),
-                    'email'      => $attendee->email(),
-                    'address'    => $attendee->address(),
-                    'address2'   => $attendee->address2(),
-                    'city'       => $attendee->city(),
-                    'state'      => $this->getAttendeeStateValueForForm($attendee),
-                    'country'    => $attendee->country_ID(),
-                    'zip'        => $attendee->zip(),
-                    'phone'      => $attendee->phone(),
-                ],
-                $attendee,
-                $this
-            )
-        );
-    }
+	/**
+	 * Sets the defaults for the billing form according to the attendee's details
+	 *
+	 * @param EE_Attendee $attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function populate_from_attendee(EE_Attendee $attendee)
+	{
+		/** @var $attendee EE_Attendee */
+		$attendee = EEM_Attendee::instance()->ensure_is_obj($attendee);
+		$this->populate_defaults(
+			apply_filters(
+				'FHEE__EE_Billing_Attendee_Info_Form__populate_from_attendee',
+				[
+					'first_name' => $attendee->fname(),
+					'last_name'  => $attendee->lname(),
+					'email'      => $attendee->email(),
+					'address'    => $attendee->address(),
+					'address2'   => $attendee->address2(),
+					'city'       => $attendee->city(),
+					'state'      => $this->getAttendeeStateValueForForm($attendee),
+					'country'    => $attendee->country_ID(),
+					'zip'        => $attendee->zip(),
+					'phone'      => $attendee->phone(),
+				],
+				$attendee,
+				$this
+			)
+		);
+	}
 
 
-    /**
-     * Gets the default value to use for the billing form's state value.
-     *
-     * @param EE_Attendee $attendee
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.10.0.p
-     */
-    protected function getAttendeeStateValueForForm(EE_Attendee $attendee): string
-    {
-        // If the state input was removed, just return a blank string.
-        if (! $this->has_subsection('state')) {
-            return '';
-        }
-        $state_input = $this->get_input('state', false);
-        if ($state_input instanceof EE_State_Select_Input) {
-            $state_field_to_use = $state_input->valueFieldName();
-        } else {
-            $state_field_to_use = 'STA_ID';
-        }
-        switch ($state_field_to_use) {
-            case 'STA_abbrev':
-                $state_value = $attendee->state_abbrev();
-                break;
-            case 'STA_name':
-                $state_value = $attendee->state_name();
-                break;
-            default:
-                $state_value = $attendee->state_ID();
-        }
-        return $state_value;
-    }
+	/**
+	 * Gets the default value to use for the billing form's state value.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.10.0.p
+	 */
+	protected function getAttendeeStateValueForForm(EE_Attendee $attendee): string
+	{
+		// If the state input was removed, just return a blank string.
+		if (! $this->has_subsection('state')) {
+			return '';
+		}
+		$state_input = $this->get_input('state', false);
+		if ($state_input instanceof EE_State_Select_Input) {
+			$state_field_to_use = $state_input->valueFieldName();
+		} else {
+			$state_field_to_use = 'STA_ID';
+		}
+		switch ($state_field_to_use) {
+			case 'STA_abbrev':
+				$state_value = $attendee->state_abbrev();
+				break;
+			case 'STA_name':
+				$state_value = $attendee->state_name();
+				break;
+			default:
+				$state_value = $attendee->state_ID();
+		}
+		return $state_value;
+	}
 
 
-    /**
-     * copy_billing_form_data_to_attendee
-     * copies info from the billing form to the attendee's details
-     *
-     * @param EE_Attendee $attendee the attendee object to copy details to
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public function copy_billing_form_data_to_attendee(EE_Attendee $attendee): EE_Attendee
-    {
-        // grab billing form data
-        $data = $this->valid_data();
+	/**
+	 * copy_billing_form_data_to_attendee
+	 * copies info from the billing form to the attendee's details
+	 *
+	 * @param EE_Attendee $attendee the attendee object to copy details to
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public function copy_billing_form_data_to_attendee(EE_Attendee $attendee): EE_Attendee
+	{
+		// grab billing form data
+		$data = $this->valid_data();
 
-        $fields_and_setters = [
-            'first_name' => 'set_fname',
-            'last_name'  => 'set_lname',
-            'email'      => 'set_email',
-            'address'    => 'set_address',
-            'address2'   => 'set_address2',
-            'city'       => 'set_city',
-            'state'      => 'set_state',
-            'country'    => 'set_country',
-            'zip'        => 'set_zip',
-            'phone'      => 'set_phone',
-        ];
-        foreach ($fields_and_setters as $field => $setter) {
-            if (! empty($data[ $field ]) && method_exists($attendee, $setter)) {
-                $attendee->{$setter}($data[ $field ]);
-            }
-        }
-        return $attendee;
-    }
+		$fields_and_setters = [
+			'first_name' => 'set_fname',
+			'last_name'  => 'set_lname',
+			'email'      => 'set_email',
+			'address'    => 'set_address',
+			'address2'   => 'set_address2',
+			'city'       => 'set_city',
+			'state'      => 'set_state',
+			'country'    => 'set_country',
+			'zip'        => 'set_zip',
+			'phone'      => 'set_phone',
+		];
+		foreach ($fields_and_setters as $field => $setter) {
+			if (! empty($data[ $field ]) && method_exists($attendee, $setter)) {
+				$attendee->{$setter}($data[ $field ]);
+			}
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * create_attendee_from_billing_form_data
-     * uses info from the billing form to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_attendee_from_billing_form_data()
-    {
-        // grab billing form data
-        $data = $this->valid_data();
-        return EE_Attendee::new_instance(
-            [
-                'ATT_fname'    => ! empty($data['first_name']) ? $data['first_name'] : '',
-                'ATT_lname'    => ! empty($data['last_name']) ? $data['last_name'] : '',
-                'ATT_email'    => ! empty($data['email']) ? $data['email'] : '',
-                'ATT_address'  => ! empty($data['address']) ? $data['address'] : '',
-                'ATT_address2' => ! empty($data['address2']) ? $data['address2'] : '',
-                'ATT_city'     => ! empty($data['city']) ? $data['city'] : '',
-                'STA_ID'       => ! empty($data['state']) ? $data['state'] : '',
-                'CNT_ISO'      => ! empty($data['country']) ? $data['country'] : '',
-                'ATT_zip'      => ! empty($data['zip']) ? $data['zip'] : '',
-                'ATT_phone'    => ! empty($data['phone']) ? $data['phone'] : '',
-            ]
-        );
-    }
+	/**
+	 * create_attendee_from_billing_form_data
+	 * uses info from the billing form to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_attendee_from_billing_form_data()
+	{
+		// grab billing form data
+		$data = $this->valid_data();
+		return EE_Attendee::new_instance(
+			[
+				'ATT_fname'    => ! empty($data['first_name']) ? $data['first_name'] : '',
+				'ATT_lname'    => ! empty($data['last_name']) ? $data['last_name'] : '',
+				'ATT_email'    => ! empty($data['email']) ? $data['email'] : '',
+				'ATT_address'  => ! empty($data['address']) ? $data['address'] : '',
+				'ATT_address2' => ! empty($data['address2']) ? $data['address2'] : '',
+				'ATT_city'     => ! empty($data['city']) ? $data['city'] : '',
+				'STA_ID'       => ! empty($data['state']) ? $data['state'] : '',
+				'CNT_ISO'      => ! empty($data['country']) ? $data['country'] : '',
+				'ATT_zip'      => ! empty($data['zip']) ? $data['zip'] : '',
+				'ATT_phone'    => ! empty($data['phone']) ? $data['phone'] : '',
+			]
+		);
+	}
 }
 // End of file EE_Billing_Attendee_Info_Form.form.php

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Indentation +68 added lines, -68 removed lines

@@ -9,79 +9,79 @@
  */
 class EE_Datepicker_Input extends EE_Form_Input_Base
 {
-    private bool $use_jquery_ui;
+	private bool $use_jquery_ui;
 
 
-    /**
-     * @param array $input_settings
-     */
-    public function __construct($input_settings = [], $use_jquery_ui = false)
-    {
-        $this->use_jquery_ui = (bool) apply_filters('FHEE__EE_Datepicker_Input__use_jquery_ui', $use_jquery_ui);
-        $type                = $this->use_jquery_ui ? 'datepicker' : 'date';
-        $this->_set_display_strategy(new EE_Text_Input_Display_Strategy($type));
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        // we could do better for validation, but at least verify its plaintext
-        $this->_add_validation_strategy(
-            new EE_Plaintext_Validation_Strategy($input_settings['validation_error_message'] ?? null)
-        );
-        parent::__construct($input_settings);
-        $this->set_html_class($this->html_class() . " $type");
+	/**
+	 * @param array $input_settings
+	 */
+	public function __construct($input_settings = [], $use_jquery_ui = false)
+	{
+		$this->use_jquery_ui = (bool) apply_filters('FHEE__EE_Datepicker_Input__use_jquery_ui', $use_jquery_ui);
+		$type                = $this->use_jquery_ui ? 'datepicker' : 'date';
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy($type));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		// we could do better for validation, but at least verify its plaintext
+		$this->_add_validation_strategy(
+			new EE_Plaintext_Validation_Strategy($input_settings['validation_error_message'] ?? null)
+		);
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class() . " $type");
 
-        if ($this->use_jquery_ui) {
-            // add some style and make it dance
-            add_action('wp_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
-            add_action('admin_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
-        }
-    }
+		if ($this->use_jquery_ui) {
+			// add some style and make it dance
+			add_action('wp_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
+			add_action('admin_enqueue_scripts', ['EE_Datepicker_Input', 'enqueue_styles_and_scripts']);
+		}
+	}
 
 
-    /**
-     *    enqueue_styles_and_scripts
-     *
-     * @access        public
-     * @return        void
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-    }
+	/**
+	 *    enqueue_styles_and_scripts
+	 *
+	 * @access        public
+	 * @return        void
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+	}
 
 
-    /**
-     * converts the raw value into a date strimg in the format Y-m-d
-     * unless we're using jquery ui, in which case we just return the raw value
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function raw_value_in_form(): string
-    {
-        $raw_value = $this->raw_value();
-        if ($this->use_jquery_ui || ! $raw_value) {
-            return parent::raw_value_in_form();
-        }
-        // load the CURRENT WordPress date format and try that
-        $date = DateTime::createFromFormat(get_option('date_format', 'Y-m-d'), $raw_value);
-        if ($date instanceof DateTime) {
-            return $date->format('Y-m-d');
-        }
-        // nope? ok check if date format can just be parsed as is
-        $timestamp = strtotime($raw_value);
-        if ($timestamp) {
-            $date = date('Y-m-d', $timestamp);
-            if ($date) {
-                return $date;
-            }
-        }
-        // ... errr... ok... just return the raw value
-        return $raw_value;
-    }
+	/**
+	 * converts the raw value into a date strimg in the format Y-m-d
+	 * unless we're using jquery ui, in which case we just return the raw value
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function raw_value_in_form(): string
+	{
+		$raw_value = $this->raw_value();
+		if ($this->use_jquery_ui || ! $raw_value) {
+			return parent::raw_value_in_form();
+		}
+		// load the CURRENT WordPress date format and try that
+		$date = DateTime::createFromFormat(get_option('date_format', 'Y-m-d'), $raw_value);
+		if ($date instanceof DateTime) {
+			return $date->format('Y-m-d');
+		}
+		// nope? ok check if date format can just be parsed as is
+		$timestamp = strtotime($raw_value);
+		if ($timestamp) {
+			$date = date('Y-m-d', $timestamp);
+			if ($date) {
+				return $date;
+			}
+		}
+		// ... errr... ok... just return the raw value
+		return $raw_value;
+	}
 }